PSSqlRepository

0.7.0

en-US/PSSqlRepository-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh">

  <command:command>

    <command:details>

      <command:name>Update-PSSqlRepositoryEntity</command:name>

      <maml:description>

        <maml:para>Updates existing entities: a discoverable proxy for Save-PSSqlRepositoryEntity -Mode Update.</maml:para>

      </maml:description>

      <command:verb>Update</command:verb>

      <command:noun>PSSqlRepositoryEntity</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Forwards every parameter to Save-PSSqlRepositoryEntity with -Mode Update, so an entity whose key does not exist yet fails instead of being inserted. Pipeline input, batching (-BatchSize), -IncludeNavigations, -OrphanBehavior and -PassThru behave exactly as on Save-PSSqlRepositoryEntity; see its help for details.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Update-PSSqlRepositoryEntity</maml:name>

        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

          <maml:name>InputObject</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">psobject</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.PSObject</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">

          <maml:name>EntityType</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">type</command:parameterValue>

          <dev:type>

            <maml:name>System.Type</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>IncludeNavigations</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>OrphanBehavior</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">OrphanBehavior</command:parameterValue>

          <dev:type>

            <maml:name>PSSqlRepository.Core.OrphanBehavior</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>PassThru</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>SkipEnumeration</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>CommandTimeout</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">int</command:parameterValue>

          <dev:type>

            <maml:name>System.Int32</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>WhatIf</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>Confirm</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">

        <maml:name>CommandTimeout</maml:name>

        <maml:description>

          <maml:para>Per-invocation override (in seconds) of the command timeout used for the update; restored when the command ends.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.Int32</command:parameterValue>

        <dev:type>

          <maml:name>System.Int32</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="cf">

        <maml:name>Confirm</maml:name>

        <maml:description>

          <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">

        <maml:name>EntityType</maml:name>

        <maml:description>

          <maml:para>Entity type to update when it cannot be inferred from the input object (a hashtable or PSCustomObject).</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.Type</command:parameterValue>

        <dev:type>

          <maml:name>System.Type</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">

        <maml:name>IncludeNavigations</maml:name>

        <maml:description>

          <maml:para>Also merge navigation properties (child collections and references) instead of updating scalar columns only.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="none">

        <maml:name>InputObject</maml:name>

        <maml:description>

          <maml:para>The entity (or hashtable / PSCustomObject carrying its key) to update; accepts pipeline input.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.Management.Automation.PSObject</command:parameterValue>

        <dev:type>

          <maml:name>System.Management.Automation.PSObject</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">

        <maml:name>OrphanBehavior</maml:name>

        <maml:description>

          <maml:para>What happens to child rows a merged collection no longer contains: Detach, Delete or Fail (see Save-PSSqlRepositoryEntity).</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">PSSqlRepository.Core.OrphanBehavior</command:parameterValue>

        <dev:type>

          <maml:name>PSSqlRepository.Core.OrphanBehavior</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">

        <maml:name>PassThru</maml:name>

        <maml:description>

          <maml:para>Returns the updated entity to the pipeline.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">

        <maml:name>SkipEnumeration</maml:name>

        <maml:description>

          <maml:para>Treat an input object that implements IEnumerable as one entity instead of unrolling it.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="wi">

        <maml:name>WhatIf</maml:name>

        <maml:description>

          <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.Management.Automation.PSObject</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Forwards every parameter to Save-PSSqlRepositoryEntity with -Mode Update, so an entity whose key does not exist yet fails instead of being inserted. Pipeline input, batching (-BatchSize), -IncludeNavigations, -OrphanBehavior and -PassThru behave exactly as on Save-PSSqlRepositoryEntity; see its help for details.</maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Forwards every parameter to Save-PSSqlRepositoryEntity with -Mode Update, so an entity whose key does not exist yet fails instead of being inserted. Pipeline input, batching (-BatchSize), -IncludeNavigations, -OrphanBehavior and -PassThru behave exactly as on Save-PSSqlRepositoryEntity; see its help for details.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>Proxy function defined in PSSqlRepository.psm1; the implementation is Save-PSSqlRepositoryEntity.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>Loads an entity, changes a property and writes it back; an id that does not exist fails instead of inserting.</maml:para>

        </maml:introduction>

        <dev:code>$customer = Get-PSSqlRepositoryEntity -EntityType ([Customer]) -Id 5

$customer.Name = 'Renamed'

$customer | Update-PSSqlRepositoryEntity -PassThru</dev:code>

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri />

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>