Command Line Tools

datacube

$ datacube --help
Usage:  [OPTIONS] COMMAND [ARGS]...

  Data Cube command-line interface

Options:
  --version
  -v, --verbose           Use multiple times for more verbosity
  --log-file TEXT         Specify log file
  -C, --config_file TEXT
  --log-queries           Print database queries.
  --help                  Show this message and exit.

Commands:
  dataset        Dataset management commands
  ingest         Ingest datasets
  metadata_type  Metadata type commands
  product        Product commands
  system         System commands
  user           User management commands

datacube dataset

$ datacube dataset --help
Usage:  [OPTIONS] COMMAND [ARGS]...

  Dataset management commands

Options:
  --help  Show this message and exit.

Commands:
  add      Add datasets to the Data Cube
  archive  Archive datasets
  info     Display dataset information
  restore  Restore datasets
  search   Search available Datasets  Search...
  update   Update datasets in the Data Cube

datacube dataset add

$ datacube dataset add --help
Usage:  [OPTIONS] [DATASET_PATHS]...

  Add datasets to the Data Cube

Options:
  -r, --match-rules PATH          Rules to be used to associate datasets with
                                  products
  -t, --dtype TEXT                Product to be associated with the datasets
  -a, --auto-match                Automatically associate datasets with
                                  products by matching metadata
  --sources-policy [verify|ensure|skip]
                                  'verify' - verify source datasets' metadata
                                  (default)
                                  'ensure' - add source dataset if
                                  it doesn't exist
                                  'skip' - dont add the
                                  derived dataset if source dataset doesn't
                                  exist
  --dry-run                       Check if everything is ok
  --help                          Show this message and exit.

datacube dataset archive

$ datacube dataset archive --help
Usage:  [OPTIONS] [IDS]...

  Archive datasets

Options:
  -d, --archive-derived  Also recursively archive derived datasets
  --dry-run              Don't archive. Display datasets that would get
                         archived
  --help                 Show this message and exit.

datacube dataset info

$ datacube dataset info --help
Usage:  [OPTIONS] [IDS]...

  Display dataset information

Options:
  --show-sources       Also show source datasets
  --show-derived       Also show derived datasets
  -f [csv|yaml]        Output format  [default: yaml]
  --max-depth INTEGER  Maximum sources/derived depth to travel
  --help               Show this message and exit.

datacube dataset restore

$ datacube dataset restore --help
Usage:  [OPTIONS] [IDS]...

  Restore datasets

Options:
  -d, --restore-derived           Also recursively restore derived datasets
  --dry-run                       Don't restore. Display datasets that would
                                  get restored
  --derived-tolerance-seconds INTEGER
                                  Only restore derived datasets that were
                                  archived this recently to the original
                                  dataset
  --help                          Show this message and exit.

datacube dataset update

$ datacube dataset update --help
Usage:  [OPTIONS] [DATASETS]...

  Update datasets in the Data Cube

Options:
  --allow-any TEXT        Allow any changes to the specified key (a.b.c)
  -r, --match-rules PATH  Rules to be used to associate datasets with products
  -t, --dtype TEXT        Product to be associated with the datasets
  -a, --auto-match        Automatically associate datasets with products by
                          matching metadata
  --dry-run               Check if everything is ok
  --help                  Show this message and exit.

datacube ingest

$ datacube ingest --help
Usage:  [OPTIONS]

  Ingest datasets

Options:
  -c, --config-file PATH       Ingest configuration file
  --year TEXT                  Limit the process to a particular year
  --queue-size INTEGER RANGE   Task queue size
  --save-tasks PATH            Save tasks to the specified file
  --load-tasks PATH            Load tasks from the specified file
  -d, --dry-run                Check if everything is ok
  --executor <CHOICE TEXT>...  Run parallelized, either locally or
                               distributed. eg:
                               --executor multiproc 4 (OR)
                               --executor distributed 10.0.0.8:8888
  --help                       Show this message and exit.

datacube metadata_type

$ datacube metadata_type --help
Usage:  [OPTIONS] COMMAND [ARGS]...

  Metadata type commands

Options:
  --help  Show this message and exit.

Commands:
  add     Add or update metadata types in the index
  list    List metadata types that are defined in the...
  show    Show information about a metadata type.
  update  Update existing metadata types.

datacube metadata_type add

$ datacube metadata_type add --help
Usage:  [OPTIONS] [FILES]...

  Add or update metadata types in the index

Options:
  --allow-exclusive-lock / --forbid-exclusive-lock
                                  Allow index to be locked from other users
                                  while updating (default: false)
  --help                          Show this message and exit.

datacube metadata_type list

$ datacube metadata_type list --help
Usage:  [OPTIONS]

  List metadata types that are defined in the index

Options:
  --help  Show this message and exit.

datacube metadata_type show

$ datacube metadata_type show --help
Usage:  [OPTIONS] METADATA_TYPE_NAME

  Show information about a metadata type.

Options:
  -v, --verbose
  --help         Show this message and exit.

datacube metadata_type update

$ datacube metadata_type update --help
Usage:  [OPTIONS] [FILES]...

  Update existing metadata types.

  An error will be thrown if a change is potentially unsafe.

  (An unsafe change is anything that may potentially make the metadata type
  incompatible with existing ones of the same name)

Options:
  --allow-unsafe / --forbid-unsafe
                                  Allow unsafe updates (default: false)
  --allow-exclusive-lock / --forbid-exclusive-lock
                                  Allow index to be locked from other users
                                  while updating (default: false)
  -d, --dry-run                   Check if everything is ok
  --help                          Show this message and exit.

datacube product

$ datacube product --help
Usage:  [OPTIONS] COMMAND [ARGS]...

  Product commands

Options:
  --help  Show this message and exit.

Commands:
  add     Add or update products in the index
  list    List products that are defined in the index
  show    Show details about a product in the index
  update  Update existing products.

datacube product add

$ datacube product add --help
Usage:  [OPTIONS] [FILES]...

  Add or update products in the index

Options:
  --allow-exclusive-lock / --forbid-exclusive-lock
                                  Allow index to be locked from other users
                                  while updating (default: false)
  --help                          Show this message and exit.

datacube product list

$ datacube product list --help
Usage:  [OPTIONS]

  List products that are defined in the index

Options:
  --help  Show this message and exit.

datacube product show

$ datacube product show --help
Usage:  [OPTIONS] PRODUCT_NAME

  Show details about a product in the index

Options:
  --help  Show this message and exit.

datacube product update

$ datacube product update --help
Usage:  [OPTIONS] [FILES]...

  Update existing products.

  An error will be thrown if a change is potentially unsafe.

  (An unsafe change is anything that may potentially make the product
  incompatible with existing datasets of that type)

Options:
  --allow-unsafe / --forbid-unsafe
                                  Allow unsafe updates (default: false)
  --allow-exclusive-lock / --forbid-exclusive-lock
                                  Allow index to be locked from other users
                                  while updating (default: false)
  -d, --dry-run                   Check if everything is ok
  --help                          Show this message and exit.

datacube system

$ datacube system --help
Usage:  [OPTIONS] COMMAND [ARGS]...

  System commands

Options:
  --help  Show this message and exit.

Commands:
  check  Check and display current configuration
  init   Initialise the database

datacube system check

$ datacube system check --help
Usage:  [OPTIONS]

  Check and display current configuration

Options:
  --help  Show this message and exit.

datacube system init

$ datacube system init --help
Usage:  [OPTIONS]

  Initialise the database

Options:
  --default-types / --no-default-types
                                  Add default types? (default: true)
  --init-users / --no-init-users  Include user roles and grants. (default:
                                  true)
  --recreate-views / --no-recreate-views
                                  Recreate dynamic views
  --rebuild / --no-rebuild        Rebuild all dynamic fields (caution: slow)
  --lock-table / --no-lock-table  Allow table to be locked (eg. while creating
                                  missing indexes)
  --help                          Show this message and exit.

datacube user

$ datacube user --help
Usage:  [OPTIONS] COMMAND [ARGS]...

  User management commands

Options:
  --help  Show this message and exit.

Commands:
  create  Create a User
  delete  Delete a User
  grant   Grant a role to users
  list    List users

datacube user create

$ datacube user create --help
Usage:  [OPTIONS] ROLE USER

  Create a User

Options:
  --description TEXT
  --help              Show this message and exit.

datacube user delete

$ datacube user delete --help
Usage:  [OPTIONS] [USERS]...

  Delete a User

Options:
  --help  Show this message and exit.

datacube user grant

$ datacube user grant --help
Usage:  [OPTIONS] ROLE [USERS]...

  Grant a role to users

Options:
  --help  Show this message and exit.

datacube user list

$ datacube user list --help
Usage:  [OPTIONS]

  List users

Options:
  --help  Show this message and exit.