CLI Deprecation Notice

With the introduction of the new CLI commands, the following commands have been deprecated and will be removed in a later release. You can still use these commands to interact with legacy metadata collections. View the new commands at Metadata store command-line interface.

Collection commands

The following collection commands are available:

Collection list

This command lists the names of all the collections in the metadata store.

Usage

dbb collection list [options]

Positional arguments

  • None

Command Options

  • None

Configuration options

Note that you can omit the configuration options if the CLI session is started and active.

You can specify the following options:

  • --type for the metadata store implementation type. The possible values are file (default) and db2.

  • --location for the location of the file system implementation. The default value is $HOME.

  • --user for the Db2® connection user ID.

  • --password for the Db2 connection password.
    IMPORTANT: The password must be encrypted with the DBB password utility. See Encrypting metadata store passwords.

  • --password-file for the location of Db2 connection password that is stored in a password file.
    IMPORTANT: The password file contains an encrypted password and must be generated with the DBB password utility. See Encrypting metadata store passwords.

  • --url for the Db2 server location. It can be local or a remote URL. It is optional if the URL is provided in the --db2_config file.

  • --db2-config for the location of the Db2 connection configuration file.

Collection view

This command displays a collection.

Usage

dbb collection view <collectionName> [options]

Positional arguments

  • collectionName for the name of the collection to view

Command Options

  • None

Configuration options

Note that you can omit the configuration options if the CLI session is started and active.

You can specify the following options:

  • --type for the metadata store implementation type. The possible values are file (default) and db2.

  • --location for the location of the file system implementation. The default value is $HOME.

  • --user for the Db2® connection user ID.

  • --password for the Db2 connection password.
    IMPORTANT: The password must be encrypted with the DBB password utility. See Encrypting metadata store passwords.

  • --password-file for the location of Db2 connection password that is stored in a password file.
    IMPORTANT: The password file contains an encrypted password and must be generated with the DBB password utility. See Encrypting metadata store passwords.

  • --url for the Db2 server location. It can be local or a remote URL. It is optional if the URL is provided in the --db2_config file.

  • --db2-config for the location of the Db2 connection configuration file.

Collection delete

This command deletes a collection from the metadata store.

Usage

dbb collection delete <collectionName> [options]

Positional arguments

  • collectionName for the name of the collection to delete

Command Options

  • None

Configuration options

Note that you can omit the configuration options if the CLI session is started and active.

You can specify the following options:

  • --type for the metadata store implementation type. The possible values are file (default) and db2.

  • --location for the location of the file system implementation. The default value is $HOME.

  • --user for the Db2® connection user ID.

  • --password for the Db2 connection password.
    IMPORTANT: The password must be encrypted with the DBB password utility. See Encrypting metadata store passwords.

  • --password-file for the location of Db2 connection password that is stored in a password file.
    IMPORTANT: The password file contains an encrypted password and must be generated with the DBB password utility. See Encrypting metadata store passwords.

  • --url for the Db2 server location. It can be local or a remote URL. It is optional if the URL is provided in the --db2_config file.

  • --db2-config for the location of the Db2 connection configuration file.

Collection export

This command exports a collection and all the logical files to a subdirectory in the export directory.

Usage

dbb collection export <collectionName> --directory <exportDirectory> [options]

Positional arguments

  • collectionName for the name of the collection to export

Command Options

  • --directory (required) for the directory to export the collection subfolder.
  • --encoding <codePage> for the optional encoding of the text artifacts. It defaults to the default code page of the z/OS® UNIX system.

Configuration options

Note that you can omit the configuration options if the CLI session is started and active.

You can specify the following options:

  • --type for the metadata store implementation type. The possible values are file (default) and db2.

  • --location for the location of the file system implementation. The default value is $HOME.

  • --user for the Db2® connection user ID.

  • --password for the Db2 connection password.
    IMPORTANT: The password must be encrypted with the DBB password utility. See Encrypting metadata store passwords.

  • --password-file for the location of Db2 connection password that is stored in a password file.
    IMPORTANT: The password file contains an encrypted password and must be generated with the DBB password utility. See Encrypting metadata store passwords.

  • --url for the Db2 server location. It can be local or a remote URL. It is optional if the URL is provided in the --db2_config file.

  • --db2-config for the location of the Db2 connection configuration file.