Find command

The following find 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.

Find result

This command finds a build result from a build group that matches a state and status on the metadata store.

Usage

dbb find result <groupName> <state> <status> [options]

Positional arguments

  • groupName for the name of the build group to search
  • state for the numeric value that describes the state of the building result. DBB default states: 0 - NEW, 1 - PROCESSING, 2 - COMPLETE, 3 - ABANDONED.
  • status for the numeric value that describes the status of the building result. DBB default statuses: 0 - CLEAN, 1 - ERROR, 2 - WARNING.

Command Options

  • --order <order> to sort the list of returned build results by ascending or descending order. Valid values: ASC, DESC.
  • --order-by <orderBy> to sort the list of returned build results by a field. Default field is 'lastUpdated'. Valid values: group, state, status, created, createdBy, lastUpdated, lastUpdatedBy. Currently, the file system metadata store only supports ordering by lastUpdated.
  • --last to return the last created build result that matches.
  • --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 Find result 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.

Find map

This command finds a build map with an Output that matches a specified member, dataset, path, and/or deployType on the metadata store.

Usage

dbb find map <groupName> [options]

Positional arguments

  • groupName for the name of the build group to search

Command Options

  • --member <member> for the member name to search for
  • --dataset <dataset> for the dataset name to search for
  • --path <path> for the path to search for
  • --deploy-type <deployType> for the deploy type name to search for
  • --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 Find map 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.

Find file lname

This command finds a logical file from a collection that matches a logical name on the metadata store.

Usage

dbb find file <groupName> <collectionName> lname <lname> [options]

Positional arguments

  • groupName for the name of the build group with the specified collection
  • collectionName for the name of the collection to search
  • lname for the logical name to match

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 Find file 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.

Find file dependency

This command finds a logical file that matches a dependency filter from a collection on the metadata store.

Usage

dbb find file <groupName> <collectionName> dependency <library>:<category>:<lname> [options]

Positional arguments

  • groupName for the name of the build group with the specified collection
  • collectionName for the name of the collection to search
  • library:category:lname for the filter string separated by colons. Any fields in the filter can be omitted. Ex. SYSLIB, MYLIB:COPY:EPSMORT, ::SQLCA

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 Find file 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.