Versions Compared

Version Old Version 42 New Version Current
Changes made by

Amber Williams

Amy Smith

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

We strongly recommend to use runtime credentials because it is more secure than stored credentials (due to the possibility of the stored password being decoded).

See Database Credential Management. 

...

  • ddlExcludeList– comma-separated list of object types to exclude from the snapshot. Can be all, none, or a list containing any combination of procedure, function, package, packagebody, trigger, non_stored_logic, or table  view.

    Info

    non_stored_logic is available in 8.3 and later.
    When non_stored_logic is provided for the ddlExcludeList property this will exclude non stored logic database objects (such as tables, constants, etc) from Snapshot, Diff, and DiffChangelog.


  • referenceDB - database that represents the desired state
  • targetDB - database that is out of synchronization and needs to be caught up to the state of referenceDB.
  • output - If present, specifies a file for the report. If not specified, the report is sent to STDOUT

...

  • referenceDB - database that represents the desired state, either a dbdef in the project or a snapshot file. 
  • targetDB - database that is out of synchronization and needs to be caught up to the state of referenceDB, either a dbdef in the project or a snapshot file
  • output - if present, specifies the file for the generated changelog. Use file extension .xml. If not specified, output is written to  the Reports/DiffChangeLogs subdirectory under the project directory. If the file exists, the results of the command (changesets) are appended to the existing file. 

  • ddlExcludeList – comma-separated list of object types to exclude from the snapshot. Can be all, none, or a list containing any combination of procedure, function, package, packagebody, trigger, non_stored_logic, or table  view.

    Info
    non_stored_logic is available in 8.3 and later.
    When non_stored_logic is provided for the ddlExcludeList property this will exclude non stored logic database objects (such as tables, constants, etc) from Snapshot, Diff, and DiffChangelog.


  • assignLabels - apply this set of labels applied to all changesets created. Accepts a comma separated list of labels.
  • assignContexts - apply this set of contexts to to all changesets created. Accepts a complex context expression.
  • scriptChecksum - SQL script checksum value

...

newDbDef

Creates a new dbDef based on the key/value pairs specified as arguments.

  • Oracle
    • Inline Credentials:  OracleDbDef
    • Run-Time Supplied Credentials:  DelayedCredentialOracleDbDef
  • SQL Server
    • Inline Credentials:  SqlServerDbDef
    • Run-Time Supplied Credentials:  DelayedCredentialSqlServerDbDef
  • Postgres Enterprise DB
    • Inline Credentials:  PostgresqlDbDef
    • Run-Time Supplied Credentials:  DelayedCredentialPostgresDbDef
  • DB2
    • Inline Credentials:  Db2DbDef
    • Run-Time Supplied Credentials:  DelayedCredentialDb2DbDef
  • (deprecated) MySQL Inline Credentials:  MysqlDbDef


USAGE

newDbDef DbDefClass <value> name <value> hostname <value> port <value> username <value> password <value> database <value> ... <key> <value>

AVAILABLE KEYS

  • DbDefClass - Database Type. (OracleDbDef|Db2DbDef|MysqlDbDef|SqlServerDbDef|PostgresqlDbDef|DelayedCredentialOracleDbDef|DelayedCredentialSqlServerDbDef|DelayedCredentialPostgresDbDef|DelayedCredentialDb2DbDef)

  • name - The name for the dbDef. Used in the repl and UI as an alias for this connection.

  • hostname - The hostname/ip of the target database server.

  • port - The port number for JDBC connections to the target database server.

  • username - The database user name to use for the connection.

  • password - The password for the database user specified.

  • database - (only applies to MySQL|DB2|Postgres) The name of the database you wish to manage.

  • databaseName - (only applies to SQLServer) The name of the database you wish to manage.

  • instanceName - (only applies to SQLServer) The name of the instance you wish to manage.

  • dbType - (only applies to SQLServer) The type of SQLServer.

    • Available values: mssql (default), az_sqlmi, az_sqldb.

  • authentication - (only applies to SQLServer) The type of authentication for Azure Databases.

    • Available values: none (default), activeDirectoryIntegrated, activeDirectoryPassword, activeDirectoryMSI.

  • msiClientId - (only applies to SQLServer) Managed identity for Azure resources.

  • multiSubnetFailover - (only applies to SQLServer) allows you to connect to the availability group listener of a SQL Server availability group or a SQL Server Failover Cluster Instance.

  • applicationName - (only applies to SQLServer) The name of the database application you wish to manage.

  • azureClientId - (Azure SQL MI RefDB Only) Application (client) id of service principles.

  • azureTenantId - (Azure SQL MI RefDB Only) Id of tenant on Azure.

  • azureClientSecret - (Azure SQL MI RefDB Only) Secret key of service principles on Azure.

  • azureResourceGroup - (Azure SQL MI RefDB Only) Name of resource group on Azure

  • azureSubscriptionId - (Azure SQL MI RefDB Only) Id of subscription on Azure.

  • azureRestAuthenticationOption - (Azure SQL MI RefDB Only) Azure REST API authentication type. Available Values: certificate, clientSecret (default)

  • sid - (only applies to Oracle) The name of the Oracle SID to which you wish to connect.

  • serviceName - (only applies to Oracle) The name of the Oracle Service to which you wish to connect.

  • defaultSchemaName - The name of the schema you wish to manage.

  • defaultCatalogName - The name of the catalog you wish to manage.

  • contexts - A comma separated list of contexts to associate with the new dbDef.

  • labels - A comma separated list of labels to associate with the new dbDef.

  • dbDefType - One of either 'standard' or 'dmcdb' to specify whether this is a standard dbDef or the dbdef for the DMC Web Application. Defaults to 'standard'.

  • storageOptionCollectedAtSnapshot - whether the system will pay attention to storage options on table, indexes, etc.

  • tnsName - (only applies to Oracle) The TNS name for the Oracle host and service you wish to manage. Requires tnsnames.ora to be appropriately configured on the client.

  • kerberos - (only applies to Oracle) true or false. Set to true if using Kerberos authentication to connect. If true, tnsName must also be specified. Requires additional client configuration.


...

rollback <dbdef> lastlabel
rollback <dbdef> changeid:<changesetId>
rollback <dbdef> count:<num>
rollback <dbdef> date:<date>
rollback <dbdef> tag:<tag_name>
rollback <dbdef> lastDeploy
rollback [--report=<path/file>]


Info
titleNote

If you are using a current packaging methodology (Deployment Packager with SCM), use only the lastDeploy option. Other options support older methodologies. 

...

USAGE: set enableSqlParser true | false

  • true -  use SQL Parser to parse DIRECT, DDL_DIRECT, and SQLFILE scripts into Datical's object model for subsequent validation with rules and forecast.
  • false - disable SQL Parser.  
  • externalStoredLogic - Set whether stored logic definitions (stored procedures, etc.) are stored in external files or within the project changelog.

...

  • runtimeCredentials - controls whether database credentials are stored or prompted at run time. Default: false. If set to true, all stored credentials are removed and you are prompted for database credentials during forecasting and deployment. If set to false, database credentials are encoded and stored in the project.   We strongly recommend to use runtime credentials because it is more secure than stored credentials (due to the possibility of the stored password being decoded).

USAGE set runtimeCredentials true|false 

...

  • requireoptions - true or false, whether contexts and labels are required for Forecast and Deploy
  • runtimeCredentials - true or false, whether user is prompted at run time for database user credentials. Otherwise stored encoded credentials are used.  We strongly recommend to use runtime credentials because it is more secure than stored credentials (due to the possibility of a stored password being decoded).
  • scriptExecutionTimeout - number of seconds, 0 if unlimited.

...

  • format - Specifies the format of the output, dbobject (default) or changelog.  
    • dbobject - object list that can be used by the diff and diffChangelog commands
    • changelog - XML file suitable for an initial project changelog
  • output=<path> - When present, the changelog generated is written to the directory specified by <path>. By default file is written to the Snapshots directory of the project.

  • ddlExcludeList – comma-separated list of object types to exclude from the snapshot. Can be all, none, or a list containing any combination of procedure, function, package, packagebody, trigger, non_stored_logic, or table  view.

    Info
    non_stored_logic is available in 8.3 and later.
    When non_stored_logic is provided for the ddlExcludeList property this will exclude non stored logic database objects (such as tables, constants, etc) from Snapshot, Diff, and DiffChangelog.


  • snapshotSchemaList - comma-separated list of schemas to include in the snapshot

...