Rivet

0.23.1

en-US/Rivet.dll-Help.xml

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

<helpItems schema="maml">

<command:command 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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Add-Index</command:name>

<command:verb>Add</command:verb>

<command:noun>Index</command:noun>

<maml:description><maml:para>Creates a relational index on a specified table.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Creates a relational index on a specified table.  An index can be created before there is data on the table.  Relational indexes can be created on tables or views in another database by specifying a qualified database name.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Add-Index</maml:name>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>TableName</maml:name>

<maml:Description><maml:para>The name of the target table.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Clustered</maml:name>

<maml:Description><maml:para>Creates a clustered index, otherwise non-clustered

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ColumnName</maml:name>

<maml:Description><maml:para>The column(s) on which the index is based.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

<dev:type><maml:name>String[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Descending</maml:name>

<maml:Description><maml:para>Optional array of booleans to specify descending switch per column.  Length must match `ColumnName`.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Boolean[]</command:parameterValue>

<dev:type><maml:name>Boolean[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>FileStreamOn</maml:name>

<maml:Description><maml:para>The value of the `FILESTREAM_ON` clause, which controls the placement of filestream data.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Include</maml:name>

<maml:Description><maml:para>Column names to include in the index.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

<dev:type><maml:name>String[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>The name for the &lt;object type&gt;. If not given, a sensible name will be created.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>On</maml:name>

<maml:Description><maml:para>The value of the `ON` clause, which controls the filegroup/partition to use for the index.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Option</maml:name>

<maml:Description><maml:para>An array of index options.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

<dev:type><maml:name>String[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SchemaName</maml:name>

<maml:Description><maml:para>The schema name of the target table.  Defaults to `dbo`.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Timeout</maml:name>

<maml:Description><maml:para>The number of seconds to wait for the add operation to complete. Default is 30 seconds.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Unique</maml:name>

<maml:Description><maml:para>Create a unique index on a table or view.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Where</maml:name>

<maml:Description><maml:para>The filter to use when creating a filtered index.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Clustered</maml:name>

<maml:Description><maml:para>Creates a clustered index, otherwise non-clustered

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ColumnName</maml:name>

<maml:Description><maml:para>The column(s) on which the index is based.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

<dev:type><maml:name>String[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Descending</maml:name>

<maml:Description><maml:para>Optional array of booleans to specify descending switch per column.  Length must match `ColumnName`.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Boolean[]</command:parameterValue>

<dev:type><maml:name>Boolean[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>FileStreamOn</maml:name>

<maml:Description><maml:para>The value of the `FILESTREAM_ON` clause, which controls the placement of filestream data.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Include</maml:name>

<maml:Description><maml:para>Column names to include in the index.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

<dev:type><maml:name>String[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>The name for the &lt;object type&gt;. If not given, a sensible name will be created.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>On</maml:name>

<maml:Description><maml:para>The value of the `ON` clause, which controls the filegroup/partition to use for the index.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Option</maml:name>

<maml:Description><maml:para>An array of index options.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

<dev:type><maml:name>String[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SchemaName</maml:name>

<maml:Description><maml:para>The schema name of the target table.  Defaults to `dbo`.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>TableName</maml:name>

<maml:Description><maml:para>The name of the target table.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Timeout</maml:name>

<maml:Description><maml:para>The number of seconds to wait for the add operation to complete. Default is 30 seconds.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Unique</maml:name>

<maml:Description><maml:para>Create a unique index on a table or view.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Where</maml:name>

<maml:Description><maml:para>The filter to use when creating a filtered index.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue></dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>Rivet.Operations.AddIndexOperation</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:returnValue>

</command:returnValues>

<maml:alertSet><maml:alert><maml:para>

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>Example 1</maml:title>

<dev:code>Add-Index -TableName Cars -Column Year</dev:code>

<dev:remarks><maml:para>Adds a relational index in 'Year' on the table 'Cars'

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2</maml:title>

<dev:code>Add-Index -TableName 'Cars' -Column 'Year' -Unique -Option @('IGNORE_DUP_KEY = ON','ALLOW_ROW_LOCKS = OFF')</dev:code>

<dev:remarks><maml:para>Adds an unique relational index in 'Year' on the table 'Cars' with options to ignore duplicate keys and disallow row locks.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 3</maml:title>

<dev:code>Add-Index -TableName 'Cars' -Column 'Year' -Include 'Model'</dev:code>

<dev:remarks><maml:para>Adds a relational index in 'Year' on the table 'Cars' and includes the column 'Model'

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

</helpItems>