Resource Management

hdxcli v1.0.83

Project

Provides commands to create, list, show, delete, and migrate projects. It also includes tools for managing project settings and viewing activity logs.

Usage

hdxcli project [OPTIONS] COMMAND [ARGS]...

Options

Activity

Shows the log of recent activities for the provided project.

Usage

hdxcli project activity [OPTIONS] PROJECT_NAME

Options

Examples

# Show activity for the project 'my_project'
hdxcli project activity my_project

Create

Creates a new, empty project in your Hydrolix cluster.

Usage

hdxcli project create [OPTIONS] PROJECT_NAME

Examples

# Create a new project named 'my_project'
hdxcli project create my_project

Delete

Delete a specific project.

This is a permanent action and cannot be undone. You will be prompted for confirmation unless --disable-confirmation-prompt is used.

Usage

hdxcli project delete [OPTIONS] PROJECT_NAME

Options

Examples

# Delete the project named 'my_project'
hdxcli project delete my_project

List

List all available projects.

Retrieves a list of all projects you have access to. Pagination options (--page, --page-size) are available if supported by the API.

Usage

hdxcli project list [OPTIONS]

Options

Examples

# List the first page of projects
hdxcli project list

Migrate

Migrate a project and its associated resources.

This command migrates a project from the source profile to a specified target profile or cluster. By default, all associated resources are also migrated (e.g., tables and their transforms). Authentication for the target cluster can be provided via a separate profile using --target-profile or by specifying credentials directly.

Options allow for customizing the migration:

• --dictionaries: Include associated dictionaries.
• --functions: Include associated functions.
• --only: Migrate only the project, skipping all dependencies.

By default, any failure during the process will trigger a rollback of the changes made. Use the --no-rollback flag to disable this behavior.

Usage

hdxcli project migrate [OPTIONS] NEW_PROJECT_NAME

Options

Examples

# Migrate 'my_project' to 'new_proj' on a target profile
hdxcli project --project my_project migrate new_proj --target-profile prod_cluster

# Migrate only the project 'my_project' and its dictionaries, on a target profile
hdxcli project --project my_project migrate new_proj --only --dictionaries --target-profile prod_cluster

Settings

List, get, or set key-value settings for a specific project.

This command operates in three modes:

• LIST: Invoked with no arguments, it lists all settings.
• GET: Invoked with only a KEY, it retrieves the value of that setting.
• SET: Invoked with a KEY and a VALUE, it sets the value for that setting.

The VALUE can be a string, a number, or a JSON-formatted string for lists/objects. When setting a value, the --force-operation option may be required for certain resource.

Usage

hdxcli project settings [OPTIONS] [KEY] [VALUE]

Options

Examples

# List all settings for the project 'my_project'
hdxcli project --project my_project settings

# Get the 'name' setting for the project 'my_project'
hdxcli project --project my_project settings name

# Set a new 'name' setting for the project 'my_project'
hdxcli project --project my_project settings name new_name

Show

Show details for a specific project.

Retrieves and displays the settings of a single project. If no name is provided, the default project will be used if exists.

Usage

hdxcli project show [OPTIONS] PROJECT_NAME

Options

Examples

# Show details for the project named 'my_project'
hdxcli project show my_project

Stats

Shows usage and other statistics for the provided project.

Usage

hdxcli project stats [OPTIONS] PROJECT_NAME

Options

Examples

# Show stats for the default project
hdxcli project stats

Table

This group of commands allows to create, list, show, delete, truncate, and migrate tables. A project context is required for all operations.

Usage

hdxcli table [OPTIONS] COMMAND [ARGS]...

Options

Activity

Shows the log of recent activities for the provided table.

Usage

hdxcli table activity [OPTIONS] TABLE_NAME

Options

Examples

# Show activity for the table 'my_table'
hdxcli table --project my_project activity my_table

Create

Create a new table.

Creates a standard (turbine) or a summary table. For summary tables, an SQL query must be provided via --sql-query or --sql-query-file.

Usage

hdxcli table create [OPTIONS] TABLE_NAME

Options

Examples

# Create a standard table using a settings file
hdxcli table --project my_project create my_table --settings-file path/to/settings.json

# Create a summary table using an SQL query from a file
hdxcli table --project my_project create summary_table --type summary --sql-query-file path/to/query.sql

Delete

Delete a specific table.

This is a permanent action and cannot be undone. You will be prompted for confirmation unless --disable-confirmation-prompt is used.

Usage

hdxcli table delete [OPTIONS] TABLE_NAME

Options

Examples

# Delete the table named 'my_table'
hdxcli table --project my_project delete my_table

List

List all available tables.

Retrieves a list of all tables you have access to. Pagination options (--page, --page-size) are available if supported by the API.

Usage

hdxcli table list [OPTIONS]

Options

Examples

# List the first page of tables
hdxcli table --project my_project list

Migrate

Migrate a table and its transforms to a different project.

Migrates a table from a source context (current profile) to a target project, which can be in the same or a different cluster. All associated transforms are also migrated or use the --only flag to migrate only the table and skip its transforms. Authentication for the target cluster can be provided via a separate profile using --target-profile or by specifying credentials directly.

By default, any failure during the process will trigger a rollback of the changes made. Use the --no-rollback flag to disable this behavior.

Usage

hdxcli table migrate [OPTIONS] TARGET_PROJECT_NAME NEW_TABLE_NAME

Options

Examples

# Migrate 'my_table' and its transforms to a new 'my_target_project' project
hdxcli table --project my_project --table my_table migrate my_target_project my_new_table

# Migrate only the table 'my_table' to a new 'my_target_project' project, without its transforms
hdxcli table --project my_project --table my_table migrate my_target_project my_new_table --only

Settings

List, get, or set key-value settings for a specific table.

This command operates in three modes:

• LIST: Invoked with no arguments, it lists all settings.
• GET: Invoked with only a KEY, it retrieves the value of that setting.
• SET: Invoked with a KEY and a VALUE, it sets the value for that setting.

The VALUE can be a string, a number, or a JSON-formatted string for lists/objects. When setting a value, the --force-operation option may be required for certain resource.

Usage

hdxcli table settings [OPTIONS] [KEY] [VALUE]

Options

Examples

# List all settings for the table 'my_table'
hdxcli table --project my_project --table my_table settings

# Get the 'name' setting for the table 'my_table'
hdxcli table --project my_project --table my_table settings name

# Set a new 'name' setting for the table 'my_table'
hdxcli table --project my_project --table my_table settings name new_name

Show

Show details for a specific table.

Retrieves and displays the settings of a single table. If no name is provided, the default table will be used if exists.

Usage

hdxcli table show [OPTIONS] TABLE_NAME

Options

Examples

# Show details for the table named 'my_table'
hdxcli table --project my_project show my_table

Stats

Shows usage and other statistics for the provided table.

Usage

hdxcli table stats [OPTIONS] TABLE_NAME

Options

Examples

# Show stats for the default table
hdxcli table --project my_project stats

Truncate

Remove all data from a table.

This action permanently deletes all rows from the table but preserves the resource and its settings. This operation cannot be undone.

Usage

hdxcli table truncate [OPTIONS] TABLE_NAME

Options

Examples

# Truncate the table named 'my_table'
hdxcli table --project my_project truncate my_table

Dictionary

This group of commands allows creating, listing, showing, deleting, and migrating dictionaries. A project context is required for all operations.

Usage

hdxcli dictionary [OPTIONS] COMMAND [ARGS]...

Options

Create

Create a new dictionary definition.

This command creates a dictionary by combining a settings file with the name of a data file that has been previously uploaded.

Arguments:

• SETTINGS_FILE_PATH: Path to a JSON file with dictionary settings.
• DICT_FILE_NAME: The name of the data file already uploaded via files upload.
• DICTIONARY_NAME: The name for the new dictionary.

Usage

hdxcli dictionary create [OPTIONS] DICT_SETTINGS_FILE_PATH DICT_FILE_NAME DICTIONARY_NAME

Examples

# Create a dictionary named 'country_codes' using 'countries' and a settings file
hdxcli dictionary --project my_project create ./settings.json countries country_codes

Delete

Delete a specific dictionary.

This is a permanent action and cannot be undone. You will be prompted for confirmation unless --disable-confirmation-prompt is used.

Usage

hdxcli dictionary delete [OPTIONS] DICTIONARY_NAME

Options

Examples

# Delete the dictionary named 'my_dictionary'
hdxcli dictionary --project my_project delete my_dictionary

List

List all available dictionaries.

Retrieves a list of all dictionaries you have access to. Pagination options (--page, --page-size) are available if supported by the API.

Usage

hdxcli dictionary list [OPTIONS]

Options

Examples

# List the first page of dictionaries
hdxcli dictionary --project my_project list

Migrate

Migrate a dictionary to a different project.

Migrates a dictionary from a source context (in the current profile) to a target project, which can be in the same or a different cluster. Authentication for the target cluster can be provided via a separate profile using --target-profile or by specifying credentials directly.

By default, any failure during the process will trigger a rollback of the changes made. Use the --no-rollback flag to disable this behavior.

Usage

hdxcli dictionary migrate [OPTIONS] TARGET_PROJECT_NAME NEW_DICTIONARY_NAME

Options

Examples

# Migrate 'my_dictionary' to a new project 'my_target_project'
hdxcli dictionary --project my_project --dictionary my_dictionary migrate my_target_project my_new_dictionary

Settings

List, get, or set key-value settings for a specific dictionary.

This command operates in three modes:

• LIST: Invoked with no arguments, it lists all settings.
• GET: Invoked with only a KEY, it retrieves the value of that setting.
• SET: Invoked with a KEY and a VALUE, it sets the value for that setting.

The VALUE can be a string, a number, or a JSON-formatted string for lists/objects. When setting a value, the --force-operation option may be required for certain resource.

Usage

hdxcli dictionary settings [OPTIONS] [KEY] [VALUE]

Options

Examples

# List all settings for the dictionary 'my_dictionary'
hdxcli dictionary --project my_project --dictionary my_dictionary settings

# Get the 'name' setting for the dictionary 'my_dictionary'
hdxcli dictionary --project my_project --dictionary my_dictionary settings name

# Set a new 'name' setting for the dictionary 'my_dictionary'
hdxcli dictionary --project my_project --dictionary my_dictionary settings name new_name

Show

Show details for a specific dictionary.

Retrieves and displays the settings of a single dictionary. If no name is provided, the default dictionary will be used if exists.

Usage

hdxcli dictionary show [OPTIONS] DICTIONARY_NAME

Options

Examples

# Show details for the dictionary named 'my_dictionary'
hdxcli dictionary --project my_project show my_dictionary

Files

Manage dictionary data files.

Usage

hdxcli dictionary files [OPTIONS] COMMAND [ARGS]...

Files Delete

Delete a dictionary data file.

Usage

hdxcli dictionary files delete [OPTIONS] FILE_NAME

Examples

# Delete the file named 'my_dictionary_file'
hdxcli dictionary --project my_project files delete my_dictionary_file

Download

Download a dictionary data file to your local machine. This command retrieves a dictionary file and saves it to a specified path, or the current directory by default.

Usage

hdxcli dictionary files download [OPTIONS] DICTIONARY_FILENAME

Options

Examples

# Download 'countries' to the current directory
hdxcli dictionary --project my_proj files download countries

# Download 'countries' but save it as 'country_list.csv' in the current dir
hdxcli dictionary --project my_proj files download countries.csv -o country_list.csv

# Download 'countries' to a specific 'data' folder with 'countries.csv' as the new filename
hdxcli dictionary --project my_proj files download countries.csv -o ./data/countries.csv

List

List all available files.

Retrieves a list of all files you have access to. Pagination options (--page, --page-size) are available if supported by the API.

Usage

hdxcli dictionary files list [OPTIONS]

Options

Examples

# List the first page of files
hdxcli dictionary files list

Files Upload

Upload a dictionary data file.

Usage

hdxcli dictionary files upload [OPTIONS] FILE_PATH_TO_UPLOAD DICT_FILE_NAME

Options

Examples

# Upload a local CSV file to be used as a data source for a dictionary
hdxcli dictionary --project my_project files upload ./local_countries.csv countries -t verbatim

Function

This group of commands allows creating, listing, showing, deleting, and migrating functions. A project context is required for all operations.

Usage

hdxcli function [OPTIONS] COMMAND [ARGS]...

Options

Create

A function can be created either from an inline SQL string or from a JSON file containing the function definition.

Usage

hdxcli function create [OPTIONS] FUNCTION_NAME

Options

Examples

# Create a function from an inline SQL string
hdxcli function --project my_project create my_function --inline-sql "(url) -> domain(url)"

# Create a function from a JSON file
hdxcli function --project my_project create my_function --sql-from-file path/to/func.json

Delete

Delete a specific function.

This is a permanent action and cannot be undone. You will be prompted for confirmation unless --disable-confirmation-prompt is used.

Usage

hdxcli function delete [OPTIONS] FUNCTION_NAME

Options

Examples

# Delete the function named 'my_function'
hdxcli function --project my_project delete my_function

List

List all available functions.

Retrieves a list of all functions you have access to. Pagination options (--page, --page-size) are available if supported by the API.

Usage

hdxcli function list [OPTIONS]

Options

Examples

# List the first page of functions
hdxcli function --project my_project list

Migrate

Migrate a function to a different project.

Migrates a function from a source context (in the current profile) to a target project, which can be in the same or a different cluster. Authentication for the target cluster can be provided via a separate profile using --target-profile or by specifying credentials directly.

By default, any failure during the process will trigger a rollback of the changes made. Use the --no-rollback flag to disable this behavior.

Usage

hdxcli function migrate [OPTIONS] TARGET_PROJECT_NAME NEW_FUNCTION_NAME

Options

Examples

# Migrate 'my_function' to a new project 'my_target_project'
hdxcli function --project my_project --function my_function migrate my_target_project my_new_function

Settings

List, get, or set key-value settings for a specific function.

This command operates in three modes:

• LIST: Invoked with no arguments, it lists all settings.
• GET: Invoked with only a KEY, it retrieves the value of that setting.
• SET: Invoked with a KEY and a VALUE, it sets the value for that setting.

The VALUE can be a string, a number, or a JSON-formatted string for lists/objects. When setting a value, the --force-operation option may be required for certain resource.

Usage

hdxcli function settings [OPTIONS] [KEY] [VALUE]

Options

Examples

# List all settings for the function 'my_function'
hdxcli function --project my_project --function my_function settings

# Get the 'name' setting for the function 'my_function'
hdxcli function --project my_project --function my_function settings name

# Set a new 'name' setting for the function 'my_function'
hdxcli function --project my_project --function my_function settings name new_name

Show

Show details for a specific function.

Retrieves and displays the settings of a single function. If no name is provided, the default function will be used if exists.

Usage

hdxcli function show [OPTIONS] FUNCTION_NAME

Options

Examples

# Show details for the function named 'my_function'
hdxcli function --project my_project show my_function

Transform

This group of commands allows to create, list, show, delete, and migrate transforms. A project and table context is required for all operations.

Usage

hdxcli transform [OPTIONS] COMMAND [ARGS]...

Options

Compare

Compares two transforms, showing differences in their settings.

Transforms can be specified as a local JSON file path or as a reference to a transform on a cluster in the format: project_name.table_name.transform_name.

When comparing a transform on a different cluster, use --profile-b to specify the profile details for TRANSFORM_B.

Usage

hdxcli transform compare [OPTIONS] TRANSFORM_A TRANSFORM_B

Options

Examples

# Compare two local JSON files
hdxcli transform compare path/to/transform_A.json path/to/transform_B.json

# Compare a local file to a transform on the default profile
hdxcli transform compare path/to/transform_A.json my_project.my_table.my_transform

# Compare two transforms on the same 'default' profile
hdxcli transform compare proj_A.tbl_A.tf_A proj_B.tbl_B.tf_B

# Compare a transform on the 'dev' profile to one on another (profile 'prod')
hdxcli --profile dev transform compare p1.t1.tf1 p2.t2.tf2 --profile-b prod

Create

Creates a new transform from a JSON configuration file in the specified project and table.

Usage

hdxcli transform create [OPTIONS] TRANSFORM_NAME

Options

Examples

# Create a new transform from a JSON configuration file
hdxcli transform --project my_project --table my_table create my_transform --body-from-file path/to/your-transform.json

Delete

Delete a specific transform.

This is a permanent action and cannot be undone. You will be prompted for confirmation unless --disable-confirmation-prompt is used.

Usage

hdxcli transform delete [OPTIONS] TRANSFORM_NAME

Options

Examples

# Delete the transform named 'my_transform'
hdxcli transform --project my_project --table my_table delete my_transform

List

List all available transforms.

Retrieves a list of all transforms you have access to. Pagination options (--page, --page-size) are available if supported by the API.

Usage

hdxcli transform list [OPTIONS]

Options

Examples

# List the first page of transforms
hdxcli transform --project my_project --table my_table list

Migrate

Migrate a transform to a different project and table.

Migrates a transform from a source context (in the current profile) to a target table, which can be in the same or a different cluster. Authentication for the target cluster can be provided via a separate profile using --target-profile or by specifying credentials directly.

By default, any failure during the process will trigger a rollback of the changes made. Use the --no-rollback flag to disable this behavior.

Usage

hdxcli transform migrate [OPTIONS] TARGET_PROJECT_NAME TARGET_TABLE_NAME NEW_TRANSFORM_NAME

Options

Examples

# Migrate the transform 'my_transform' to a new project and table in a different cluster
hdxcli transform --project my_project --table my_table --transform my_transform migrate my_target_project my_target_table my_new_transform --target-profile prod-us-west

Settings

List, get, or set key-value settings for a specific transform.

This command operates in three modes:

• LIST: Invoked with no arguments, it lists all settings.
• GET: Invoked with only a KEY, it retrieves the value of that setting.
• SET: Invoked with a KEY and a VALUE, it sets the value for that setting.

The VALUE can be a string, a number, or a JSON-formatted string for lists/objects. When setting a value, the --force-operation option may be required for certain resource.

Usage

hdxcli transform settings [OPTIONS] [KEY] [VALUE]

Options

Examples

# List all settings for the transform 'my_transform'
hdxcli transform --project my_project --table my_table --transform my_transform settings

# Get the 'name' setting for the transform 'my_transform'
hdxcli transform --project my_project --table my_table --transform my_transform settings name

# Set a new 'name' setting for the transform 'my_transform'
hdxcli transform --project my_project --table my_table --transform my_transform settings name new_name

Show

Show details for a specific transform.

Retrieves and displays the settings of a single transform. If no name is provided, the default transform will be used if exists.

Usage

hdxcli transform show [OPTIONS] TRANSFORM_NAME

Options

Examples

# Show details for the transform named 'my_transform'
hdxcli transform --project my_project --table my_table show my_transform

View

This group of commands allows to create, list, show, delete, and manage settings for views. A project and table context is required for all operations.

Usage

hdxcli view [OPTIONS] COMMAND [ARGS]...

Options

Create

Creates a new view from a JSON configuration file in the specified project and table.

Usage

hdxcli view create [OPTIONS] VIEW_NAME

Options

Examples

# Create a new view from a JSON configuration file
hdxcli view --project my_project --table my_table create my_view --body-from-file path/to/your-view.json

Delete

Delete a specific view.

This is a permanent action and cannot be undone. You will be prompted for confirmation unless --disable-confirmation-prompt is used.

Usage

hdxcli view delete [OPTIONS] VIEW_NAME

Options

Examples

# Delete the view named 'my_view'
hdxcli view --project my_project --table my_table delete my_view

List

List all available views.

Retrieves a list of all views you have access to. Pagination options (--page, --page-size) are available if supported by the API.

Usage

hdxcli view list [OPTIONS]

Options

Examples

# List the first page of views
hdxcli view --project my_project --table my_table list

Settings

List, get, or set key-value settings for a specific view.

This command operates in three modes:

• LIST: Invoked with no arguments, it lists all settings.
• GET: Invoked with only a KEY, it retrieves the value of that setting.
• SET: Invoked with a KEY and a VALUE, it sets the value for that setting.

The VALUE can be a string, a number, or a JSON-formatted string for lists/objects. When setting a value, the --force-operation option may be required for certain resource.

Usage

hdxcli view settings [OPTIONS] [KEY] [VALUE]

Options

Examples

# List all settings for the view 'my_view'
hdxcli view --project my_project --table my_table --view my_view settings

# Get the 'name' setting for the view 'my_view'
hdxcli view --project my_project --table my_table --view my_view settings name

# Set a new 'name' setting for the view 'my_view'
hdxcli view --project my_project --table my_table --view my_view settings name new_name

Show

Show details for a specific view.

Retrieves and displays the settings of a single view. If no name is provided, the default view will be used if exists.

Usage

hdxcli view show [OPTIONS] VIEW_NAME

Options

Examples

# Show details for the view named 'my_view'
hdxcli view --project my_project --table my_table show my_view

Column

Commands to manage table columns.

Provides commands to list all columns, show details for a specific one, or delete any existing alias column. It also includes specialized commands to create new alias columns from an expression (add-alias) and to add alternative names to existing columns (add-name).

A project and table context is required for all operations.

Usage

hdxcli column [OPTIONS] COMMAND [ARGS]...

Options

Add Alias

Creates a new column defined by an expression. Requires --project and --table options to be set.

Usage

hdxcli column add-alias [OPTIONS] ALIAS_NAME EXPRESSION

Examples

# Add an alias column 'full_name' by concatenating 'first_name' and 'last_name'
hdxcli column --project my_project --table my_table add-alias full_name "concat(first_name, ' ', last_name)"

Add Name

Assigns an additional name to an existing column. Requires --project, --table, and --column options to be set.

Usage

hdxcli column add-name [OPTIONS] NEW_NAME

Examples

# Add 'user_id' as an alternative name for the 'user' column
hdxcli column --project my_project --table my_table --column user add-name user_id

Delete

Delete a specific column.

This is a permanent action and cannot be undone. You will be prompted for confirmation unless --disable-confirmation-prompt is used.

Usage

hdxcli column delete [OPTIONS] COLUMN_NAME

Options

Examples

# Delete the column named 'my_column'
hdxcli column --project my_project --table my_table delete my_column

List

List all available columns.

Retrieves a list of all columns you have access to. Pagination options (--page, --page-size) are available if supported by the API.

Usage

hdxcli column list [OPTIONS]

Options

Examples

# List the first page of columns
hdxcli column --project my_project --table my_table list

Show

Show details for a specific column.

Retrieves and displays the settings of a single column. If no name is provided, the default column will be used if exists.

Usage

hdxcli column show [OPTIONS] COLUMN_NAME

Options

Examples

# Show details for the column named 'my_column'
hdxcli column --project my_project --table my_table show my_column