List commands

The following list commands are available:

Note: These commands are available with DBB 2.0.2 and later. If you have DBB 2.0.0 or 2.0.1, see Legacy commands.

List groups

This command lists the names of all the build groups on the metadata store.

Usage

dbb list groups [options]

Positional arguments

  • None

Command Options

  • --json to format CLI output and errors in a JSON structure for the purposes of easier ingestion by APIs. The reference for output from this command can be found in the List groups schema.

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.

List results

This command lists the names of all the build results in a build group on the metadata store.

Usage

dbb list results <groupName> [options]

Positional arguments

  • groupName for the name of the build group with build results

Command Options

  • --json to format CLI output and errors in a JSON structure for the purposes of easier ingestion by APIs. The reference for output from this command can be found in the List results schema.

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.

List maps

This command lists the names of all the build maps in a build group on the metadata store.

Usage

dbb list maps <groupName> [options]

Positional arguments

  • groupName for the name of the build group with build maps

Command Options

  • --json to format CLI output and errors in a JSON structure for the purposes of easier ingestion by APIs. The reference for output from this command can be found in the List maps schema.

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.

List collections

This command lists the names of all the collections in a build group on the metadata store.

Usage

dbb list collections <groupName> [options]

Positional arguments

  • groupName for the name of the build group with collections

Command Options

  • --json to format CLI output and errors in a JSON structure for the purposes of easier ingestion by APIs. The reference for output from this command can be found in the List collections schema.

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.

List files

This command lists the names of all the logical files in a collection on the metadata store.

Usage

dbb list files <groupName> <collectionName> [options]

Positional arguments

  • groupName for the name of the build group with the specified collection
  • collectionName for the name of the collection with logical files

Command Options

  • --json to format CLI output and errors in a JSON structure for the purposes of easier ingestion by APIs. The reference for output from this command can be found in the List files schema.

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.