Skip to main content

adb

Usage:

$ adb [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • config: Configure ApertureDB client.
  • ingest: Ingest data into ApertureDB.
  • transact: Run a transaction against ApertureDB.
  • utils: Utilities

adb config​

Configure ApertureDB client.

Usage:

$ adb config [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • activate: Set the default configuration.
  • create: Create a new configuration for the client.
  • ls: List the configurations with their details.

adb config activate​

Set the default configuration.

Usage:

$ adb config activate [OPTIONS] NAME

Arguments:

  • NAME: Name of this configuration for easy reference [required]

Options:

  • --as-global / --no-as-global: Project level vs global level [default: as-global]
  • --help: Show this message and exit.

adb config create​

Create a new configuration for the client.

If --from-json is used, then the options --host, --port, --username, --password, --use-rest, and --use-ssl will be ignored. The user will be prompted to enter the JSON string. This will be treated as a password entry.

See https://docs.aperturedata.dev/Setup/client/configuration for more information on JSON configurations.

Usage:

$ adb config create [OPTIONS] [NAME]

Arguments:

  • [NAME]: Name of this configuration for easy reference

Options:

  • --active / --no-active: Set as active [default: no-active]
  • --as-global / --no-as-global: Project level vs global level [default: as-global]
  • --host TEXT: Host name [default: localhost]
  • --port INTEGER: Port number [default: 55555]
  • --username TEXT: Username [default: admin]
  • --password TEXT: Password [default: admin]
  • --use-rest / --no-use-rest: Use REST [default: no-use-rest]
  • --use-ssl / --no-use-ssl: Use SSL [default: use-ssl]
  • --interactive / --no-interactive: Interactive mode [default: interactive]
  • --overwrite / --no-overwrite: overwrite existing configuration [default: no-overwrite]
  • --from-json / --no-from-json: create config from a JSON string [default: no-from-json]
  • --help: Show this message and exit.

adb config ls​

List the configurations with their details.

Usage:

$ adb config ls [OPTIONS]

Options:

  • --log-to-console / --no-log-to-console: [default: log-to-console]
  • --help: Show this message and exit.

adb ingest​

Ingest data into ApertureDB.

Usage:

$ adb ingest [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • from-csv: Ingest data from a pre generated CSV file.
  • from-generator: Ingest data from a Data generator [BETA].
  • generate-embedding-csv-from-image-csv: Create a DescriptorDataCSV from an...

adb ingest from-csv​

Ingest data from a pre generated CSV file.

Usage:

$ adb ingest from-csv [OPTIONS] FILEPATH

Arguments:

  • FILEPATH: Path to csv for ingestion [required]

Options:

  • --batchsize INTEGER: Size of the batch [default: 1]
  • --num-workers INTEGER: Number of workers for ingestion [default: 1]
  • --stats / --no-stats: Show realtime statistics with summary [default: stats]
  • --use-dask / --no-use-dask: Use dask based parallelization [default: no-use-dask]
  • --ingest-type [BLOB|BOUNDING_BOX|CONNECTION|CLIP|DESCRIPTOR|DESCRIPTORSET|ENTITY|FRAME|IMAGE|POLYGON|VIDEO]: Parser for CSV file to be used [default: IngestType.IMAGE]
  • --blobs-relative-to-csv / --no-blobs-relative-to-csv: If true, the blob path is relative to the CSV file [default: blobs-relative-to-csv]
  • --transformer [common_properties|image_properties|clip_pytorch_embeddings|facenet_pytorch_embeddings]: Apply transformer to the pipeline [Can be specified multiple times]
  • --user-transformer TEXT: Apply user transformer to the pipeline as path to file [Can be specified multiple times.]
  • --sample-count INTEGER: Number of samples to ingest (-1 for all) [default: -1]
  • --debug / --no-debug: Debug mode [default: no-debug]
  • --help: Show this message and exit.

adb ingest from-generator​

Ingest data from a Data generator [BETA].

Usage:

$ adb ingest from-generator [OPTIONS] FILEPATH

Arguments:

  • FILEPATH: Path to python module for ingestion [BETA][required]

Options:

  • --sample-count INTEGER: Number of samples to ingest (-1 for all) [default: -1]
  • --debug / --no-debug: Debug mode [default: no-debug]
  • --batchsize INTEGER: Size of the batch [default: 1]
  • --num-workers INTEGER: Number of workers for ingestion [default: 1]
  • --transformer [common_properties|image_properties|clip_pytorch_embeddings|facenet_pytorch_embeddings]: Apply transformer to the pipeline [Can be specified multiple times]
  • --user-transformer TEXT: Apply user transformer to the pipeline as path to file [Can be specified multiple times]
  • --help: Show this message and exit.

adb ingest generate-embedding-csv-from-image-csv​

Create a DescriptorDataCSV from an ImageDataCSV, using the specified transformer. Also save embeddings in a separate file, and generate the ConnectionDataCSV for linking the images to the descriptors. The ingestion of the embeddings and the connection data is not done here. image_properties transformer must be used at actual ingestion. It is also applied by default for CSV generation.

Usage:

$ adb ingest generate-embedding-csv-from-image-csv [OPTIONS] INPUT_FILE SET_NAME

Arguments:

  • INPUT_FILE: Path to csv for ingestion [required]
  • SET_NAME: Descriptor set name to be associated with the embeddings [required]

Options:

  • --transformer [common_properties|image_properties|clip_pytorch_embeddings|facenet_pytorch_embeddings]: Apply transformer to the pipeline [Can be specified multiple times]
  • --user-transformer TEXT: Apply user transformer to the pipeline as path to file [Can be specified multiple times.]
  • --sample-count INTEGER: Number of samples to ingest (-1 for all) [default: -1]
  • --help: Show this message and exit.

adb transact​

Run a transaction against ApertureDB.

Usage:

$ adb transact [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • from-json-file

adb transact from-json-file​

Usage:

$ adb transact from-json-file [OPTIONS] FILEPATH

Arguments:

  • FILEPATH: Path to query in json format [required]

Options:

  • --output-type [stdout|mount_coco]: Type of output [default: stdout]
  • --output-path TEXT: Path to output (only for mount as output)
  • --help: Show this message and exit.

adb utils​

Utilities

Usage:

$ adb utils [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • execute
  • log: Log a message to the user log.
  • visualize-schema: Visualize the schema of the database.

adb utils execute​

Usage:

$ adb utils execute [OPTIONS] COMMAND:{status|summary|remove_all|remove_indexes}

Arguments:

  • COMMAND:{status|summary|remove_all|remove_indexes}: [required]

Options:

  • --force / --no-force: Do not confirm [default: no-force]
  • --help: Show this message and exit.

adb utils log​

Log a message to the user log.

This is useful because it can later be seen in Grafana, not only as log entries in the ApertureDB Logging dashboard, but also as event markers in the ApertureDB Status dashboard.

Usage:

$ adb utils log [OPTIONS] MESSAGE

Arguments:

  • MESSAGE: The message to log [required]

Options:

  • --level [INFO|WARNING|ERROR]: [default: LogLevel.INFO]
  • --help: Show this message and exit.

adb utils visualize-schema​

Visualize the schema of the database.

This will create a file with the schema of the database in the specified format.

Relies on graphviz to be installed.

Usage:

$ adb utils visualize-schema [OPTIONS]

Options:

  • --filename TEXT: [default: schema]
  • --format TEXT: [default: png]
  • --help: Show this message and exit.