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:

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

adb ingest​

Ingest data into ApertureDB.

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

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

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 <int>: Number of samples to ingest (-1 for all) [default: -1]
  • --debug / --no-debug: Debug mode [default: no-debug]
  • --stats / --no-stats: Show realtime statistics with summary [default: stats]
  • --batchsize <int>: Size of the batch [default: 1]
  • --num-workers <int>: 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 <str>: Apply user transformer to the pipeline as path to file [Can be specified multiple times]
  • --help: Show this message and exit.

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 <int>: Size of the batch [default: 1]
  • --num-workers <int>: 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: 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 <str>: Apply user transformer to the pipeline as path to file [Can be specified multiple times.]
  • --sample-count <int>: 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-croissant​

Ingest data from MLCroissant dataset.

Usage:

$ adb ingest from-croissant [OPTIONS] {url}

Arguments:

  • url: URL to the MLCroissant dataset [required]

Options:

  • --flatten-json / --no-flatten-json: Flatten JSON data [default: no-flatten-json]
  • --sample-count <int>: Number of samples to ingest (-1 for all) [default: -1]
  • --debug / --no-debug: Debug mode [default: no-debug]
  • --stats / --no-stats: Show realtime statistics with summary [default: stats]
  • --batchsize <int>: Size of the batch [default: 1]
  • --num-workers <int>: Number of workers for ingestion [default: 1]
  • --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 <str>: Apply user transformer to the pipeline as path to file [Can be specified multiple times.]
  • --sample-count <int>: Number of samples to ingest (-1 for all) [default: -1]
  • --help: Show this message and exit.

adb config​

Configure ApertureDB client.

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List the configurations with their details.
  • create: Create a new configuration for the client.
  • activate: Set the default configuration.
  • remove: Remove a configuration from a...
  • get-key: Makes a token from the configuration
  • get: Retrieve detail of a config.

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 config create​

Create a new configuration for the client.

If --from-json or --from-key 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 <str>: Host name [default: localhost]
  • --port <int>: Port number [default: 55555]
  • --username <str>: Username [default: admin]
  • --password <str>: Password [default: admin]
  • --use-rest / --no-use-rest: Use REST [default: no-use-rest]
  • --use-ssl / --no-use-ssl: Use SSL [default: use-ssl]
  • --ca-cert <str>: CA certificate
  • --verify-hostname / --no-verify-hostname: Verify hostname [default: verify-hostname]
  • --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]
  • --from-key / --no-from-key: create config from an encoded string [default: no-from-key]
  • --help: Show this message and exit.

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 remove​

Remove a configuration from a Configuriation file

Usage:

$ adb config remove [OPTIONS] {name}

Arguments:

  • name: Name of this configuration to remove [required]

Options:

  • --remove-if-active / --no-remove-if-active: If true; if active, remove and assign other configuration to be active; If false refuse to delete if active [default: no-remove-if-active]
  • --new-active <str>: If deleting active, use name as new active
  • --as-global / --no-as-global: Project level vs global level [default: as-global]
  • --help: Show this message and exit.

adb config get-key​

Makes a token from the configuration

Usage:

$ adb config get-key [OPTIONS] [name]

Arguments:

  • name: Name of the configuration to get a key for

Options:

  • --user <str>: User to get a key for (default is config user)
  • --as-global / --no-as-global: Project level vs global level [default: as-global]
  • --help: Show this message and exit.

adb config get​

Retrieve detail of a config.

Usage:

$ adb config get [OPTIONS] {tag}

Arguments:

  • tag: Tag of information to get [required]

Options:

  • --ignore-unset / --no-ignore-unset: ignore unsetl [default: no-ignore-unset]
  • --help: Show this message and exit.

adb utils​

Utilities

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • execute: Execute a command on the database
  • log: Log a message to the user log.
  • visualize-schema: Visualize the schema of the database.
  • generate-images: Generate placeholder images
  • keys: Manage Aperturedb keys
  • tokens: Manage database authentication tokens

adb utils execute​

Execute a command on the database

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: 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 <str>: [default: schema]
  • --format <str>: [default: png]
  • --help: Show this message and exit.

adb utils generate-images​

Generate placeholder images

Usage:

$ adb utils generate-images [OPTIONS]

Options:

  • -c, --count <int>: Number of images to generate [default: 1]
  • -s, --size <str>: Size of images (widthxheight) [default: 256x256]
  • -o, --output <str>: Output file path pattern [default: /tmp/generated_image%%]
  • -z, --zerofill <int>: Number of zeros to pad the index with [default: 0]
  • -t, --imagetype <png|jpg>: Type of image to generate (png, jpg) [default: png]
  • -m, --manifest <str>: Manifest file to write generated image paths to
  • -a, --append-text <str>: Text to append to the image
  • --help: Show this message and exit.

adb utils keys​

Manage Aperturedb keys

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • generate: Create Key for a user

adb utils keys generate​

Create Key for a user

Usage:

$ adb utils keys generate [OPTIONS] {user}

Arguments:

  • user: The user to generate a key for [required]

Options:

  • --help: Show this message and exit.

adb utils tokens​

Manage database authentication tokens

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • list: List User Authentication Tokens
  • generate: Generate an Authentication token for a user
  • assign: Assign an Authentication token to a user
  • remove: Remove an Authentication token from a user

adb utils tokens list​

List User Authentication Tokens

Usage:

$ adb utils tokens list [OPTIONS] {user}

Arguments:

  • user: The user the display tokens for [required]

Options:

  • --help: Show this message and exit.

adb utils tokens generate​

Generate an Authentication token for a user

Usage:

$ adb utils tokens generate [OPTIONS]

Options:

  • --help: Show this message and exit.

adb utils tokens assign​

Assign an Authentication token to a user

Usage:

$ adb utils tokens assign [OPTIONS] {user} {token}

Arguments:

  • user: user to assign the token to [required]
  • token: Token to be assigned [required]

Options:

  • --help: Show this message and exit.

adb utils tokens remove​

Remove an Authentication token from a user

Usage:

$ adb utils tokens remove [OPTIONS] {user} {token}

Arguments:

  • user: User to remove a token from [required]
  • token: Token to be removed [required]

Options:

  • --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|raw_json>: Type of output [default: stdout]
  • --output-path <str>: Path to output (only for mount as output)
  • --help: Show this message and exit.