Command Reference

--artifact

string

Yes

--category

string

No

<none>

--version

integer

No

1

--new-id

string

Yes

--artifact

string

Yes

--category

string

No

<none>

--version

integer

No

1

--expression

string

Yes

Literal text by default, an XPath expression with --xpath, or a Java regular expression with --regex

--xpath

flag

No

false

Interpret --expression as an XPath 1.0 expression selecting nodes

--regex

flag

No

false

Interpret --expression as a Java regular expression; mutually exclusive with --xpath

--ignore-case

flag

No

false

Case-insensitive literal/regex matching; invalid with --xpath

--artifact-id, --id

string

No

<none>

Exact, case-sensitive artifact ID

--category, --artifact-category

string

No

<none>

Exact category

--version

integer

No

<none>

Exact version; without it every version is eligible unless --latest-only is set

--latest-only

flag

No

false

Select the maximum version per category/ID

--include-system

flag

No

false

Include system/special artifacts

--all-artifacts

flag

No

false

Required when artifact ID, category, and version are all omitted

--expect-artifact-count

integer

No

<none>

Fail unless exactly this many eligible artifacts exist

--expect-match-count

integer

No

<none>

Fail unless the expression produces exactly this many matches/nodes

--output

OutputFormat

No

TABLE

Output format: TABLE or JSON

--artifact

string

Yes

--category

string

No

<none>

--version

integer

No

1

--output-file

file

No

<none>

Path to write the exported artifact to

--update

flag

No

false

--category

string

No

<none>

--id

string

No

<none>

--latest-only

flag

No

false

--include-system

flag

No

false

Include system/special artifacts

--add-columns

string

No

<none>

--output

OutputFormat

No

TABLE

Output format: TABLE or JSON

--artifact

string

Yes

--category

string

No

<none>

--version

integer

No

1

--bytes

flag

No

false

--output-file

string

No

<none>

--recovery-app-id

string

No

RECOVERY

The artifact ID for the recovery application

--expression

string

Yes

Literal text by default, an XPath expression with --xpath, or a Java regular expression with --regex

--new-value

string

Yes

Literal replacement text, XPath node value, or Java regex replacement string

--old-value

string

No

<none>

XPath only: exact, case/whitespace-sensitive compare-and-set guard for selected nodes

--xpath

flag

No

false

Interpret --expression as an XPath 1.0 expression selecting nodes

--regex

flag

No

false

Interpret --expression as a Java regular expression; mutually exclusive with --xpath

--ignore-case

flag

No

false

Case-insensitive literal/regex matching; invalid with --xpath

--artifact-id, --id

string

No

<none>

Exact, case-sensitive artifact ID

--category, --artifact-category

string

No

<none>

Exact category

--version

integer

No

<none>

Exact version; without it every version is eligible unless --latest-only is set

--latest-only

flag

No

false

Select the maximum version per category/ID

--include-system

flag

No

false

Include system/special artifacts

--all-artifacts

flag

No

false

Required when artifact ID, category, and version are all omitted

--expect-artifact-count

integer

No

<none>

Fail unless exactly this many eligible artifacts exist

--expect-match-count

integer

No

<none>

Fail unless the expression produces exactly this many matches/nodes

--apply

flag

No

false

Persist the fully validated proposed changes; without this the command is preview-only

--ignore-locks

flag

No

false

Allow updates to locked artifacts

--output

OutputFormat

No

TABLE

Output format: TABLE or JSON

--artifact

string

Yes

--category

string

No

<none>

--version

integer

No

1

--artifact

string

Yes

--category

string

No

<none>

--version

integer

No

1

--scanner-config

file

No

<none>

--artifact

string

Yes

--category

string

No

<none>

--version

integer

No

1

--user

string

No

<none>

--artifact

string

Yes

--category

string

No

<none>

--version

integer

No

1

--all

flag

No

false

Delete all data audit log records

--days

integer

No

<none>

Delete all data audit log records older than the given number of days

--members

string

No

<none>

Delete only data audit log entries whose data points include all of the given members, such as a Scenario, Version, or Year member; may be combined with --days

--all

flag

No

false

Delete all metadata audit log records

--days

integer

No

<none>

Delete all metadata audit log records older than the given number of days

--attachment-id

string

Yes

--file

file

Yes

--intersection

string

Yes

--description

string

No

<none>

--author

string

No

<none>

--include-key-spec

string

No

<none>

--exclude-key-spec

string

No

<none>

--remove-key-spec

string

No

<none>

--add-key-spec

string

No

<none>

--new-author

string

No

<none>

Update the created by property

--tenant

string

No

<none>

Set different tenant for the comments

--include-key-spec

string

No

<none>

Key spec of comments, such as Period=Jan,Scenario=Actual

--partial-address

flag

No

false

Set if key spec address only needs to be partial match

--after

string

No

<none>

--before

string

No

<none>

--comment-id

string

No

<none>

ID of a comment to delete

--confirm

flag

No

false

--include-key-spec

string

No

<none>

Key spec of comments, such as Period=Jan,Scenario=Actual

--partial-address

flag

No

false

Set if key spec address only needs to be partial match

--after

string

No

<none>

--before

string

No

<none>

--include-key-spec

string

No

<none>

Key spec of comments to update, such as Period=Jan,Scenario=Actual

--update-key-spec

string

No

<none>

Key spec to update/add, such as Year=FY20

--partial-address

flag

No

false

Set if key spec address only needs to be partial match

--remove-key-spec

string

No

<none>

Comma separated list of keys to remove from address

--dry-run

flag

No

false

--fetch-size

integer

No

1000

--connection-file

file

No

<none>

--prompt-for-password

flag

No

false

Prompt for the connection password

--password-secret-source

string

No

<none>

Password source: env:NAME, file:PATH, or literal:VALUE

--text

string

Yes

--tenant

string

No

<none>

Export the given tenant in the currently connected repository and import it to the new H2 repository

--server

flag

No

false

Run H2 as a TCP server and connect to jdbc:h2:tcp://localhost:9092/mem:dodeca

--file

file

No

<none>

Use properties from file

--no-masked-inputs

flag

No

false

Force terminal to not mask any inputs

--id

string

Yes

--name

string

No

<none>

Display name for the credential source artifact

--type

ExternalCredentialProviderType

Yes

--properties

string

No

<none>

Non-sensitive provider properties in name=value,name=value format

--secret-properties

string

No

<none>

Sensitive provider properties using env:NAME, file:PATH, literal:VALUE, or prompt:

--type

ExternalCredentialProviderType

Yes

--id

string

Yes

--secret-path

string

Yes

--id

string

Yes

--force

flag

No

false

Delete even when stored SQL connections refer to this bundle

--id

string

Yes

--output-file

file

No

<none>

--id

string

Yes

--jar

string

Yes

--driver-class

string

No

<none>

Driver class to use when the JAR has no JDBC service declaration

--id

string

Yes

--output

OutputFormat

No

TABLE

Output format: TABLE or JSON

--connection-id

string

Yes

--file

file

Yes

--validate-only

flag

No

false

--days

integer

No

30

--dai

flag

No

false

Considers Excel add-in users instead of Dodeca

--print

flag

No

false

Print out the list of users

--filename

string

No

<none>

File to print to (CSV)

--encode

flag

No

false

Encode license for startup parameter

--connection-file

file

No

<none>

Connection file to use (default is current connection)

--all-tenants

flag

No

false

--version

string

No

<none>

The repository version, if none the default will be used, list versions with available-versions

--tenant

string

No

<none>

The tenant to export, if none, the current one will be used

--options

string

No

<none>

--output-directory

file

No

<none>

--export-file

string

No

<none>

Export filename, if not specified, the current tenant will be used

--fetch-size

integer

No

<none>

Set a JDBC fetch size

--append-date

flag

No

false

Append a datestamp to the file

--file

file

Yes

--version

string

No

<none>

--skip-checksum-recompute

flag

No

false

--checksum-function

string

No

SHA-256

Checksum function for this import; use SHA-1 only for a pre-Dodeca-8 target

--file

file

Yes

The file to import that was previously created with export-tenant or from Dodeca

--version

string

No

<none>

Force use of an explicit repository version, leave unspecified to automatically determine

--skip-on-existing-checksum

flag

No

false

Skip update if the object already exists

--imported-by

string

No

system

Set METADATA_AUDIT_LOG.USER_ID when updating the metadata audit log

--skip-checksum-recompute

flag

No

false

Skip explicit checksum recompute after import job runs

--continue-on-error

flag

No

false

Continue processing even if error is detected

--batch-size

integer

No

<none>

Set the JDBC batch size to use

--threads

integer

No

<none>

Enable multi-threading for the import job

--import-user

string

No

<none>

Set BINARY_ARTIFACTS.IMPORTED_BY for imported artifacts

--fast

flag

No

false

Shortcut flag that turns on existing checksum skipping, batching (500), and multi-threading (# of CPUs)

--all

flag

No

false

Import all object types

--update-metadata-audit-log

flag

No

false

Update METADATA_AUDIT_LOG when existing binary artifacts are updated

--honor-locks

flag

No

false

Use to honor locks and skip updates to locked artifact

--checksum-function

string

No

SHA-256

Checksum function for this import; use SHA-1 only for a pre-Dodeca-8 target

--encoded-contents

string

Yes

--file, -f

file

Yes

Artifact XML file to decode.

--output, -o

file

No

<none>

File to write the decoded contents to. Writes to the console when omitted.

--wait

integer

No

30

--print

flag

No

false

--text

string

Yes

Use quotes to surround text

--level

string

Yes

--root

flag

No

false

Set to update the root logger, leave off for just the shell logger

--suppress

flag

No

false

Suppress logging in this command

--output

file

No

<none>

Write documentation to a file instead of printing to the console

--format

string

No

markdown

Output format: markdown or asciidoc

--env

flag

No

false

Set variable from environment. Pass with no parameters to pull in all environment variables

--name

string

No

<none>

The name of a variable to set, or the name of an environment variable if using the --env option

--value

string

No

<none>

Value to set for a variable, or a default value to use if an environment variable doesn’t exist

--enablement

string

No

<none>

--host

string

Yes

--port

integer

Yes

--id

string

Yes

--authority

string

Yes

--id

string

Yes

--id

string

Yes

--authority

string

Yes

--name

string

Yes

--type

Type

No

PERSON

--status

Status

No

ACTIVE

--id

string

Yes

--provider

string

Yes

--subject

string

Yes

--id

string

Yes

--id

string

Yes

--provider

string

Yes

--subject

string

Yes

--username

string

Yes

--name

string

No

<none>

--secret-source

string

No

<none>

Password source: env:NAME, file:PATH, or literal:VALUE; omit for a masked prompt

--id

string

Yes

--username

string

Yes

--secret-source

string

No

<none>

Password source: env:NAME, file:PATH, or literal:VALUE; omit for a masked prompt

--id

string

Yes

--id

string

Yes

--username

string

Yes

--id

string

Yes

--username

string

Yes

--id

string

Yes

--username

string

Yes

--id

string

Yes

--username

string

Yes

--secret-source

string

No

<none>

Password source: env:NAME, file:PATH, or literal:VALUE; omit for a masked prompt

--id

string

Yes

--username

string

Yes

--id

string

Yes

--namespace

string

Yes

--name

string

Yes

--id

string

Yes

--namespace

string

No

<none>

--id

string

Yes

--namespace

string

Yes

--name

string

Yes

--id

string

Yes

--namespace

string

Yes

--name

string

Yes

--value

string

Yes

--id

string

Yes

--name

string

Yes

--id

string

Yes

--status

Status

Yes

--id

string

Yes

--type

Type

Yes

--id

string

Yes

--deep

flag

No

false

Check for tenant presence based on all tables, not just binary artifacts

--include-reserved

flag

No

false

Include reserved/system tenants

--artifacts-only

flag

No

false

--checksum-function

string

No

SHA-256

Checksum function to write; use SHA-1 only for a pre-Dodeca-8 target

--migration-bundle

file

No

<none>

Use a custom schema migration bundle

--dry-run

flag

No

false

Output SQL that would be executed to files instead of executing it

--tenant

string

Yes

--force

flag

No

false

Force use of the tenant, even if it doesn’t exist

--skip-tenant-check

flag

No

false

Skip tenant check, has no effect if force is used

--id

string

Yes

The ID of a SQLPTDS object

--params

string

No

<none>

Tokens for the SQLPTDS in var1=val1 var2=val2 format

--repeat

integer

No

1

The number of times to repeat dataset execution

--print

flag

No

false

Whether to print the results of the dataset execution

--concurrent

flag

No

false

Whether to execute the dataset in concurrent mode

--query

string

Yes

-c

integer

No

24

--connection-id

string

Yes

--id

string

Yes

--force

flag

No

false

--user

string

No

<none>

--user

string

No

<none>

--shared-by

flag

No

false

--shared-with

flag

No

false

--view-id

string

No

<none>

--user-or-role

string

Yes

--username

string

Yes

--password

string

Yes

--id

string

Yes

--file

file

Yes

The file or folder to import

--version

string

Yes

--version

string

Yes

Installed client version to export

--output-file

file

No

<none>

ZIP file to write; defaults to a versioned client filename

--client-zip

file

Yes

-u

flag

No

false

Upgrade current client after import

--product

Product

No

DSMS

--version

string

No

<none>

Version of client to activate, leave blank to use latest

--force

flag

No

false

Use this option to force a client upgrade without validating

--file

file

Yes

The starter kit file to import

--name

string

Yes

--tenant

string

Yes

The new tenant name

--standard-starter-kit, --import-starter-kit

flag

No

false

Initialize from the standard packaged starter kit

--server-starter-kit

string

No

<none>

Initialize from a starter kit stored in the Dodeca repository

--file

file

No

<none>

Initialize from a Dodeca export or migrator-compatible file

--delete-existing

flag

No

false

Delete all existing tenant data before creation

--confirm

flag

No

false

This flag must be set in order to confirm deletion

--filename

string

Yes

File to export certificate to

--days

integer

Yes

Number of days that the exported certificate is valid for

--regenerate

flag

No

false

Specify to regenerate the public/private keys if they already exist

--logical-id

string

No

<none>

The logical ID of the Dodeca server (typically the Dodeca server name, or load balancer)

--token-duration-seconds

integer

No

86400

Token duration seconds

--certificate-duration-days

integer

No

3650

Number of days crypto certificate will be valid for

--option-name

string

Yes

--option-value

string

Yes

--id

string

Yes

--value-source

string

No

<none>

Secret source: env:NAME, file:PATH, literal:VALUE, or prompt:

--credential-source

string

No

<none>

--secret-path

string

No

<none>

--property-name

string

No

<none>

--id

string

Yes

--force

flag

No

false

--id

string

Yes

--id

string

Yes

--value-source

string

No

<none>

Secret source: env:NAME, file:PATH, literal:VALUE, or prompt:

--credential-source

string

No

<none>

--secret-path

string

No

<none>

--property-name

string

No

<none>

--view

string

No

<none>

--user

string

No

<none>

--days

integer

Yes