Command Options

--action

Action to take, one of:

• ADD

• REMOVE

• ADDALL

• REMOVEALL

Specifies the action to take in the modifyChangeSet command.

-ac
--assignContexts <arg>

Complex context expression. 

Assign the given contexts to changesets generated by diffChangelog command. Accepts a complex context expression.
default: null

-al
--assignLabels <arg>

Comma-separated list of labels

Assign the given labels to changesets generated by diffChangelog command. Accepts a comma separated list of labels.
default: null

-amf
--metadataFile

File name

Assign metadata file name.

-aml
--label

Label name

Label name for assign metadata.

-c
--context

Context name

Context to use for operation
default: <all contexts>

-D <property=value>

Java property assignment

Set a Java system property

-d
--deployThreshold

One of:

• stopOnError

• stopOnWarn

• alwaysDeploy

Deployment threshold setting

<arg> is one of stopOnError, stopOnWarn, alwaysDeploy

default: stopOnError

-dm
--deployMode

One of:

• full

• quick

Overrides the deployMode project setting. 

• full - performs rules validation and runs a forecast before deploying the changes, subject to limitForecast.

• quick - deploys the changes (no rules valildation or forecast)

-e
--externalStoredLogic

true | false

Use external stored logic
default: true

-el

--ddlExcludeList

List of stored logic objects

List of stored logic objects to exclude from a snapshot.
Values can be none (the default), all, or a comma-separated list of these values: procedure, package, packagebody, function, trigger, view.

-f
--force

none

When used with deploy, forces deploy even if not all operations can be rolled back. When used with versionChangeLog, forces XML
header validation
default: <off>

-fo
--format <arg>

One of:

• dbobject

• changelog

Format of the database snapshot. 
default: dbobject

-g
--genSQL

none

Generate SQL for changes
default: <off>

-gr
--genRollbackSQL

none

Generate rollback SQL for changes
default: <off>

-i
--includeStorageOptions <arg>

true | false

Include storage options
default: false

-iv
--invalidsCheck <arg>

One of:

• disabled

• local

• global

Validate stored logic
default: disabled

-j
--drivers <arg>

List of jar files or directory containing jar files

Driver jars or directory containing jars.

-l
--log <arg>

Directory

Absolute or relative path to directory location for logs & reports for the operation
default: <project directory>/Reports

DEPRECATED: Please use the -r --report option instead

-lb
--labels <arg>

Comma-separated list of labels

Label to use for operation
default: <all labels>

-lc
--lookupChangesets <arg>

Expression 

Label expression to use for change set lookup

Note that label expressions must be enclosed in quotes when used as CLI parameter options.  For example,

--lookupChangesets="(cliLabel1 AND cliLabel2) AND (dbdefLabel1 OR dbdefLabel2 OR dbdefLabel3)"

-lcs
--limit <arg>

Number

Controls the number of changesets listed in each section of the statusDetails output.

-lf
--limitForecast

true | false

Overrides the limitForecast project setting. 

• true - limit object profiling to those directly affected by the forecast 

• false - profile all objects in the target database

-ma
--matchAll <arg>

none

All script chucksums must match for change set lookup.

-ml
--mergeLabels <arg>

One of: 

• override

• merge

• append

Specifies how to combine the labels that are specified in the Step with the labels that are specified on the command line.

• override: labels specified on the command line replace the labels specified in the step.

• merge: labels specified on the command line are combined with the labels in the step with an AND clause: (commandLineLabelExpression) AND (StepLabelExpression)

• append: labels specified on the command line are combined with the labels in the Step with an OR clause: (commandLineLabelExpression) OR (StepLabelExpression)

--modifyContexts

One or a comma-separated list of context names

Specifies values to add or remove in the context changeset attribute, according to the --action parameter in the modifyChangeSet command.

--modifyIgnore

N/A

Specifies the change to the ignore changeset attribute to make in the modifyChangeSet command.

• If --action is ADD or ADDALL, then ignore is set to true. 

• If --action is REMOVE or REMOVEALL, then ignore is set to false. 

--modifyLabels

One or a comma-separated list of labels.

Specifies values to add or remove in the labels changeset attribute, according to the --action parameter in the modifyChangeSet command. 

-np
--noPrompt

none

Do not prompt for input.
default: prompt for input

-o
--output <arg>

File or directory

Specifies the location of the output file. The semantics differ per command (diff, diffChangelog, snapshot)

-p
--project <arg>

Directory

Project directory
default: current working directory

-pl
--pipeline <arg>

Pipeline name

Pipeline name to use for deploy, changelogSync, and rollback commands

-ps
--persistSnapshots <arg>

none

Persist (save) snapshots of live databases during diff.

-pw <databaseName:::password>

Password

Password for the database username (-un). 

-q
--quiet

none

Send output to debug log only

-r
--report <arg>

Directory

Absolute or relative path to directory location for reports & log for the operation.
Default: <project>/Reports

-rpw <password>
--targetPassword <password>

Password 

Password for the reference database user name

Required when the runtimeCredentials option is set.

-ru <username>
-referenceUsername <username>

User name

Reference database user name. Used only in two-credential commands (diff, diffChangeLog).

Required when the runtimeCredentials option is set.

-sc
--scriptChecksum <arg>

Checksum (number)

Script checksum to use for addLabels and removeLabels commands.

--searchContexts

One or a comma-separated list of context names

Search the contexts changeset attribute for the specified values in the modifyChangeSet command.

--searchIds

One or a comma-separated list of changeset IDs

Search the id changeset attribute for the specified values. Use the GUI or hammer statusDetails to see a list of changeset IDs for a project. 

--searchIgnore

true | false

Search the ignore changeset attribute in the modifyChangeSet command.

Note: Searches for a false value also return changesets where the ignore= changeset attribute is not set. 

--searchLabels

One or a comma-separated list of labels or a label expression

Search the labels changeset attribute for the specified values in the modifyChangeSet command.

Note that label expressions must be enclosed in quotes when used as CLI parameter options.  For example,

--searchLabels="(cliLabel1 AND cliLabel2) AND (dbdefLabel1 OR dbdefLabel2 OR dbdefLabel3)"

--searchOrigFileNames

One or a comma-separated list of filenames

Search the origFileName changeset attribute for the specified values in the modifyChangeSet command.

--searchOrigFilePaths

One or a comma-separated list of file paths

Search the origFilePath changeset attribute for the specified values in the modifyChangeSet command.

--searchVersion

One or a comma-separated list of versions

Search the version changeset attribute for the specified values in the modifyChangeSet command.

-ssl
--snapshotSchemaList <arg>

Comma-separated list of schema names

List of schemas to snapshot

--storageOptionsScope <arg>

One of:

• all

• lob

• tablespace

• tablespaceAndLob

Specifies the scope of storage information used for all steps/dbdefs in the project. 

You must also specify that storage information be used for the step/dbdef using the following command:

set dbprop <dbdef> enableStorageOptions true

-tpw <password>
--targetPassword <password>

Password

Password for the target database user name. 

-tu <username>
--targetUsername <username>

User name

Target database user name.

Required when the runtimeCredentials option is set.

-un

User name

Database user name. Required when the runtimeCredentials option is set.

Use -pw to specify the password for the database user. 

-v
--version

none

Print version info.