Daterpillar.Powershell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Show-DaterpillarMigrationHistory --> <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"> <command:details> <command:name>Show-DaterpillarMigrationHistory</command:name> <command:verb>Show</command:verb> <command:noun>DaterpillarMigrationHistory</command:noun> <maml:description> <maml:para>Prints the details and status information about all the migrations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet prints the details and status information about all the migrations.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Show-DaterpillarMigrationHistory</maml:name> <!-- Parameter: ConnectionType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Host --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>Host</maml:name> <maml:description> <maml:para>The server address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>User</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>The database password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MigrationsDirectory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>MigrationsDirectory</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FlywayFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>FlywayFilePath</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InpuObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InpuObject</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectionType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>lang</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>type</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>connection-type</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MigrationsDirectory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>MigrationsDirectory</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>path</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>fullname</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>sql</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FlywayFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>FlywayFilePath</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>flyway</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> <maml:para>This is an alias of the FlywayFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: InpuObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InpuObject</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Host --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>Host</maml:name> <maml:description> <maml:para>The server address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>h</maml:name> <maml:description> <maml:para>The server address.</maml:para> <maml:para>This is an alias of the Host parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>User</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>u</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>The database password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>p</maml:name> <maml:description> <maml:para>The database password.</maml:para> <maml:para>This is an alias of the Password parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>d</maml:name> <maml:description> <maml:para>The database name.</maml:para> <maml:para>This is an alias of the Database parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>c</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> <maml:para>This is an alias of the ConnectionString parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>connstr</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> <maml:para>This is an alias of the ConnectionString parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The SQL language of the script.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The server address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database password.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Ackara/Daterpillar</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://flywaydb.org/documentation/commandline/info</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-DaterpillarMigrationScript --> <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"> <command:details> <command:name>New-DaterpillarMigrationScript</command:name> <command:verb>New</command:verb> <command:noun>DaterpillarMigrationScript</command:noun> <maml:description> <maml:para>Generates a new migration script from the two specified '.schema.xml' files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new migration script from two '.schema.xml' files.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: default --> <command:syntaxItem> <maml:name>New-DaterpillarMigrationScript</maml:name> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="l,lang"> <maml:name>Language</maml:name> <maml:description> <maml:para>The dialect of the sql script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="d,dest"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The absolute-path of the new migration script.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldSchemaFilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3" aliases="o,old,snapshot"> <maml:name>OldSchemaFilePath</maml:name> <maml:description> <maml:para>The absolute-path of old/production '.schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewSchemaFilePath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="n,new,path,fullname"> <maml:name>NewSchemaFilePath</maml:name> <maml:description> <maml:para>The absolute-path of new/current '.schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Descripiton --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="desc"> <maml:name>Descripiton</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OmitDropStatements --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="no-drop"> <maml:name>OmitDropStatements</maml:name> <maml:description> <maml:para>Exclude all drop statements, when present.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: pipeline --> <command:syntaxItem> <maml:name>New-DaterpillarMigrationScript</maml:name> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="l,lang"> <maml:name>Language</maml:name> <maml:description> <maml:para>The dialect of the sql script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="d,dest"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The absolute-path of the new migration script.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldSchemaFilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3" aliases="o,old,snapshot"> <maml:name>OldSchemaFilePath</maml:name> <maml:description> <maml:para>The absolute-path of old/production '.schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewSchemaFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="n,new,path,fullname"> <maml:name>NewSchemaFilePath</maml:name> <maml:description> <maml:para>The absolute-path of new/current '.schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Descripiton --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="desc"> <maml:name>Descripiton</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OmitDropStatements --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="no-drop"> <maml:name>OmitDropStatements</maml:name> <maml:description> <maml:para>Exclude all drop statements, when present.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: OldSchemaFilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3" aliases="o,old,snapshot"> <maml:name>OldSchemaFilePath</maml:name> <maml:description> <maml:para>The absolute-path of old/production '.schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="3" aliases="o,old,snapshot"> <maml:name>o</maml:name> <maml:description> <maml:para>The absolute-path of old/production '.schema.xml' file.</maml:para> <maml:para>This is an alias of the OldSchemaFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="3" aliases="o,old,snapshot"> <maml:name>old</maml:name> <maml:description> <maml:para>The absolute-path of old/production '.schema.xml' file.</maml:para> <maml:para>This is an alias of the OldSchemaFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="3" aliases="o,old,snapshot"> <maml:name>snapshot</maml:name> <maml:description> <maml:para>The absolute-path of old/production '.schema.xml' file.</maml:para> <maml:para>This is an alias of the OldSchemaFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewSchemaFilePath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="n,new,path,fullname"> <maml:name>NewSchemaFilePath</maml:name> <maml:description> <maml:para>The absolute-path of new/current '.schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="n,new,path,fullname"> <maml:name>n</maml:name> <maml:description> <maml:para>The absolute-path of new/current '.schema.xml' file.</maml:para> <maml:para>This is an alias of the NewSchemaFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="n,new,path,fullname"> <maml:name>new</maml:name> <maml:description> <maml:para>The absolute-path of new/current '.schema.xml' file.</maml:para> <maml:para>This is an alias of the NewSchemaFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="n,new,path,fullname"> <maml:name>path</maml:name> <maml:description> <maml:para>The absolute-path of new/current '.schema.xml' file.</maml:para> <maml:para>This is an alias of the NewSchemaFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="n,new,path,fullname"> <maml:name>fullname</maml:name> <maml:description> <maml:para>The absolute-path of new/current '.schema.xml' file.</maml:para> <maml:para>This is an alias of the NewSchemaFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="d,dest"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The absolute-path of the new migration script.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="d,dest"> <maml:name>d</maml:name> <maml:description> <maml:para>The absolute-path of the new migration script.</maml:para> <maml:para>This is an alias of the Destination parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="d,dest"> <maml:name>dest</maml:name> <maml:description> <maml:para>The absolute-path of the new migration script.</maml:para> <maml:para>This is an alias of the Destination parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="l,lang"> <maml:name>Language</maml:name> <maml:description> <maml:para>The dialect of the sql script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="l,lang"> <maml:name>l</maml:name> <maml:description> <maml:para>The dialect of the sql script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the Language parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="l,lang"> <maml:name>lang</maml:name> <maml:description> <maml:para>The dialect of the sql script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the Language parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: OmitDropStatements --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="no-drop"> <maml:name>OmitDropStatements</maml:name> <maml:description> <maml:para>Exclude all drop statements, when present.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="no-drop"> <maml:name>no-drop</maml:name> <maml:description> <maml:para>Exclude all drop statements, when present.</maml:para> <maml:para>This is an alias of the OmitDropStatements parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Descripiton --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="desc"> <maml:name>Descripiton</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="desc"> <maml:name>desc</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This is an alias of the Descripiton parameter.</maml:para> </maml:description> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of new/current '.schema.xml' file.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Ackara/Daterpillar</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Clear-DaterpillarSchema --> <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"> <command:details> <command:name>Clear-DaterpillarSchema</command:name> <command:verb>Clear</command:verb> <command:noun>DaterpillarSchema</command:noun> <maml:description> <maml:para>Drops all objects (tables, views, procedures, triggers, etc.).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet drops all objects (tables, views, procedures, triggers, etc.).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Clear-DaterpillarSchema</maml:name> <!-- Parameter: ConnectionType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Host --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>Host</maml:name> <maml:description> <maml:para>The server address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>User</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>The database password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MigrationsDirectory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>MigrationsDirectory</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FlywayFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>FlywayFilePath</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InpuObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InpuObject</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConnectionType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>lang</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>type</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>connection-type</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MigrationsDirectory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>MigrationsDirectory</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>path</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>fullname</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>sql</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FlywayFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>FlywayFilePath</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>flyway</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> <maml:para>This is an alias of the FlywayFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: InpuObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InpuObject</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Host --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>Host</maml:name> <maml:description> <maml:para>The server address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>h</maml:name> <maml:description> <maml:para>The server address.</maml:para> <maml:para>This is an alias of the Host parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>User</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>u</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>The database password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>p</maml:name> <maml:description> <maml:para>The database password.</maml:para> <maml:para>This is an alias of the Password parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>d</maml:name> <maml:description> <maml:para>The database name.</maml:para> <maml:para>This is an alias of the Database parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>c</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> <maml:para>This is an alias of the ConnectionString parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>connstr</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> <maml:para>This is an alias of the ConnectionString parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The SQL language of the script.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The server address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database password.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Clear-DaterpillarSchema SQLite 'C:/app/db.sqlite'</dev:code> <dev:remarks> <maml:para>This will remove all table from the schema.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Ackara/Daterpillar</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://flywaydb.org/documentation/commandline/clean</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Export-DaterpillarSchema --> <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"> <command:details> <command:name>Export-DaterpillarSchema</command:name> <command:verb>Export</command:verb> <command:noun>DaterpillarSchema</command:noun> <maml:description> <maml:para>Generates a '.schema.xml' file from a '.dll' file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet create a '.schema.xml' file from a '.dll' file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: default --> <command:syntaxItem> <maml:name>Export-DaterpillarSchema</maml:name> <!-- Parameter: AssemblyFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="a,path,fullName"> <maml:name>AssemblyFile</maml:name> <maml:description> <maml:para>The absolute-path of the target assembly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: piped --> <command:syntaxItem> <maml:name>Export-DaterpillarSchema</maml:name> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AssemblyFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="a,path,fullName"> <maml:name>AssemblyFile</maml:name> <maml:description> <maml:para>The absolute-path of the target assembly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="a,path,fullName"> <maml:name>a</maml:name> <maml:description> <maml:para>The absolute-path of the target assembly.</maml:para> <maml:para>This is an alias of the AssemblyFile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="a,path,fullName"> <maml:name>path</maml:name> <maml:description> <maml:para>The absolute-path of the target assembly.</maml:para> <maml:para>This is an alias of the AssemblyFile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="a,path,fullName"> <maml:name>fullName</maml:name> <maml:description> <maml:para>The absolute-path of the target assembly.</maml:para> <maml:para>This is an alias of the AssemblyFile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the target assembly.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: FileInfo --> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>ProjectDirectory</maml:title> <maml:alert> <maml:para>The project directory is solely used to locate any scripts specified in the '.shema.xml' import tag.</maml:para> </maml:alert> </maml:alertSet> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Ackara/Daterpillar</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Update-DaterpillarSchema --> <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"> <command:details> <command:name>Update-DaterpillarSchema</command:name> <command:verb>Update</command:verb> <command:noun>DaterpillarSchema</command:noun> <maml:description> <maml:para>Migrates a schema to the latest version.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will execute all pending migration scripts in the specified directory.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-DaterpillarSchema</maml:name> <!-- Parameter: ConnectionType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Host --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>Host</maml:name> <maml:description> <maml:para>The server address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>User</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>The database password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MigrationsDirectory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>MigrationsDirectory</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FlywayFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>FlywayFilePath</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InpuObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InpuObject</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewSchema --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewSchema</maml:name> <maml:description> <maml:para>The new '.schema.xml' file. Typically the '[assembly].schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldSchema --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OldSchema</maml:name> <maml:description> <maml:para>The current/production '.schema.xml' file. Typically the 'snapshot.schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: OldSchema --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OldSchema</maml:name> <maml:description> <maml:para>The current/production '.schema.xml' file. Typically the 'snapshot.schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewSchema --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewSchema</maml:name> <maml:description> <maml:para>The new '.schema.xml' file. Typically the '[assembly].schema.xml' file.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>lang</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>type</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="lang,type,connection-type"> <maml:name>connection-type</maml:name> <maml:description> <maml:para>The SQL language of the script.</maml:para> <maml:para>Possible values: SQL, TSQL, MySQL, SQLite</maml:para> <maml:para>This is an alias of the ConnectionType parameter.</maml:para> </maml:description> <command:parameterValue required="true">Language</command:parameterValue> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">MySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQLite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MigrationsDirectory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>MigrationsDirectory</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>path</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>fullname</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases="path,fullname,sql"> <maml:name>sql</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> <maml:para>This is an alias of the MigrationsDirectory parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FlywayFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>FlywayFilePath</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="flyway"> <maml:name>flyway</maml:name> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> <maml:para>This is an alias of the FlywayFilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: InpuObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InpuObject</maml:name> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Host --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>Host</maml:name> <maml:description> <maml:para>The server address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="h"> <maml:name>h</maml:name> <maml:description> <maml:para>The server address.</maml:para> <maml:para>This is an alias of the Host parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>User</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="u"> <maml:name>u</maml:name> <maml:description> <maml:para>The authorized user.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>The database password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases="p"> <maml:name>p</maml:name> <maml:description> <maml:para>The database password.</maml:para> <maml:para>This is an alias of the Password parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases="d"> <maml:name>d</maml:name> <maml:description> <maml:para>The database name.</maml:para> <maml:para>This is an alias of the Database parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>c</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> <maml:para>This is an alias of the ConnectionString parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="c,connstr"> <maml:name>connstr</maml:name> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> <maml:para>This is an alias of the ConnectionString parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The current/production '.schema.xml' file. Typically the 'snapshot.schema.xml' file.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The new '.schema.xml' file. Typically the '[assembly].schema.xml' file.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Acklann.Daterpillar.Language</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The SQL language of the script.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the flyway executable file.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The operation timeout interval in seconds. Defaults to 5 minutes.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The absolute-path of the directory that host the migration scripts.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The server address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The authorized user.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database password.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The database connection-string. Must be formatted as <key>=<value></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Ackara/Daterpillar</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://flywaydb.org/documentation/commandline/migrate</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |