au3 warehouse & au3 warehouse-query — Command Reference

CLI command groups: au3 warehouse, au3 warehouse-query

Commands for managing warehouses (local, remote, accelerated), running and profiling queries against them, migrations, transfers, entities/fields, and reports — plus the separate warehouse-query group for saved/reusable queries.

---

Sections

Section	Commands
Entity (sub-group)	7
Report (sub-group)	2
warehouse-query (separate group)	7
All other top-level warehouse commands	20

---

au3 warehouse

au3 warehouse list

List warehouses

Option	Type	Required	Default	Notes
--fields	string			Comma-separate list of fields to display
--filter	string			Filter in JSON/YAML format or path to file containing filter
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search	string			Search in JSON/YAML format or path to file containing search
--limit			100	Number of results to fetch
--skip				Number of results to skip
--all	boolean		false	Whether to fetch results from all pages
--stream	boolean		false	Whether to print results as they are received without buffering (as JSON)
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse view

View warehouse

Option	Type	Required	Default	Notes
--id	string	✅		warehouse id
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse create

Create warehouse

Option	Type	Required	Default	Notes
--type	enum	✅		Choices: "local", "remote", "accelerated"
--name	string	✅		Object name with 2-64 characters
--description	string			Object description with 0 or 2-256 characters
--connection	string			Sync agent connection id
--discovered_id	string			Unique id for warehouse within connection
--key	string			System-generated prefix for table/view names in the accelerator DB. If manually specified, must not conflict with existing keys in the db & schema.
--engine	enum			Choices: "exasol", "starrocks"
--engine_deployment	string			Id of host engine deployment from compute-environment
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse update

Update warehouse

Option	Type	Required	Default	Notes
--spec-schema	boolean			view the schema for update
--spec	string			spec in JSON/YAML format or path to file containing spec
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

--spec payload reference

Schema ID: UpdateWarehouseArgumentDto

This section documents the --spec payload accepted by au3 warehouse update. Run warehouse update --spec-schema to fetch this schema live from the CLI at any time.

Tip: additionalProperties: false — the schema rejects any field not listed below.

Top-Level Fields

Field	Type	Required	Notes
id	string		Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
name	string		Object name with 2-64 characters — 2–64 characters
description	string		Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
tags	array		List of tags
erm	string		Stringified ERM
version	integer		Object version number

Example Spec

name: <string>
description: <string>

---

au3 warehouse query

Query Warehouse

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to run query against
--query	string			SQL query to execute. Use "AU('entity')" syntax to refer to tables. Or path to file containing query.
--query-entity	string			Id of entity to query
--limit				Number of rows to limit result to
--skip				Number of rows to skip
--total	boolean			Whether to calculate total number of rows across all pages
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--filter	string			Filter in JSON/YAML format or path to file containing filter
--fields	string			Comma-separate list of fields to display
--format	enum		json	Choices: "parquet", "ldjson", "json", "csv", "psv", "tsv"
--header	enum		full	Header format to include. Not applicable for "json" or "parquet" format. Choices: "none", "full", "short"
--entity-aliases	string			Aliases to tables in the warehouse or other accessible warehouses in JSON/YAML format or path to file containing aliases
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse vector-query

Run an accelerated warehouse vector query

Option	Type	Required	Default	Notes
--warehouse	string	✅		Accelerated warehouse to run vector query against
--entity	string	✅		Vector-search-enabled table to query
--field	string	✅		Vector-search text field to query
--content	string	✅		Text content to embed and search for
--dense-weight	number			Dense embedding weight from 0.0 to 1.0. Sparse weight is 1 - dense-weight.
--filter	string			Vector scalar filter in JSON/YAML format or path to file containing filter. Supports {field, op, value}.
--limit				Number of rows to limit result to
--skip				Number of rows to skip
--format	enum		json	Choices: "parquet", "ldjson", "json", "csv", "psv", "tsv"
--header	enum		full	Header format to include. Not applicable for "json" or "parquet" format. Choices: "none", "full", "short"
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse profile

Profile Warehouse

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to profile
--erm	string			ERM to supplement profile result in JSON/YAML format or path to file containing erm
--scope	string			Scope to limit profile result in JSON/YAML format or path to file containing scope
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse profile-query

Profile Warehouse Query

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to run query against
--query	string			SQL query to execute. Use "AU('entity')" syntax to refer to tables. Or path to file containing query.
--query-entity	string			Id of entity to query
--entity-aliases	string			Aliases to tables in the warehouse or other accessible warehouses in JSON/YAML format or path to file containing aliases
--schema	string			Schema to supplement profile result in JSON/YAML format or path to file containing schema
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse generate-migration-plan

Generate Warehouse Migration Plan

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to generate plan against
--changes	string	✅		Changes in JSON/YAML format or path to file containing changes
--auto-migrate	boolean		false	Whether to immmediately run the generated migration
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse migrate

Migrate Warehouse

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to run query against
--plan	string	✅		Plan in JSON/YAML format or path to file containing plan
--order_plan	boolean			Whether to sort the actions
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse ingest-from-upload

Ingest Warehouse From Upload

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to run query against
--table	string	✅		Warehouse table to ingest to
--options	string	✅		Options in JSON/YAML format or path to file containing options
--path	string			Path to file to upload
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse ingest-from-query

Ingest from query

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to ingest to
--table	string	✅		Warehouse table to ingest to
--options	string	✅		Options in JSON/YAML format or path to file containing options
--query	string	✅		SQL query to execute. Use "AU('entity')" syntax to refer to tables. Or path to file containing query.
--limit				Number of rows to limit result to
--skip				Number of rows to skip
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--filter	string			Filter in JSON/YAML format or path to file containing filter
--fields	string			Comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse query-upload

Query Upload

Option	Type	Required	Default	Notes
--options	string	✅		Options in JSON/YAML format or path to file containing options
--path	string			Path to file to upload
--query	string		SELECT * FROM AU('source')	SQL query to execute. Use "AU('entity')" syntax to refer to tables. Or path to file containing query.
--limit				Number of rows to limit result to
--total	boolean			Whether to calculate total number of rows across all pages
--skip				Number of rows to skip
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--filter	string			Filter in JSON/YAML format or path to file containing filter
--fields	string			Comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse transfer-to-warehouse

Transfer data from warehouse to warehouse

Option	Type	Required	Default	Notes
--spec-schema	boolean			view the schema for run
--spec	string			spec in JSON/YAML format or path to file containing spec
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

--spec payload reference

Schema ID: WarehouseTransferToWarehouseArgumentDto

This section documents the --spec payload accepted by au3 warehouse transfer-to-warehouse. Run warehouse transfer-to-warehouse --spec-schema to fetch this schema live from the CLI at any time.

Top-Level Fields

Field	Type	Required	Notes
source	object	✅
destination	object	✅
metadata	object

source

The source object is a discriminated union. One of the following 4 shapes applies.

1. remote_warehouse_query

Field	Type	Required	Notes
type	const	✅	remote_warehouse_query
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
warehouse_query	string		Warehouse Query id — Pattern: ^whsq-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whsq-123e4567-e89b-41d2-a345-678901234567
query	object
entity_aliases	object		Aliases used within query for substitution
parameters	object		Parameters used within query for substitution
parameter_values	object
pagination	object

query

The query object is a discriminated union. One of the following 2 shapes applies.

Variant 1

Field	Type	Required	Notes
format	enum	✅	Choices: sql, json_sql, plugin_dsl
query	string	✅	Stringified query in the specified format

Variant 2

Field	Type	Required	Notes
format	enum	✅	Choices: entity
entity	string	✅	Unique id for a queryable entity within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*(-cells)?$
discovered_id	string		Unique id from a remote source

entity_aliases

Aliases used within query for substitution

Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.

Field	Type	Required	Notes
warehouse	string		Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
entity	string	✅	Unique id for a table/view within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters

parameters

Parameters used within query for substitution

Map keyed by field name matching pattern [a-zA-Z][a-zA-Z0-9_]*.

Field	Type	Required	Notes
name	string	✅	Object name with 2-64 characters — 2–64 characters
description	string		Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
type	enum	✅	Choices: string, integer, number, datetime
default	object	✅	Default value

parameter_values

Map keyed by field name matching pattern [a-zA-Z][a-zA-Z0-9_]*.

pagination

Field	Type	Required	Notes
limit	integer		Number of items to return per page. Each object type will have predefined defaults and maximums. — Min 0
skip	integer		Number of items to skip from previous pages — Min 0
sort	array		List of fields and directions to sort on. Order determines precedence.
fields	array		List of fields to include in result. Omit for all.
filter	object		Filter to narrow the returned results in filter JSON format
collation	object
total	boolean		Whether to compute the total count across all pages, which can sometimes be an expensive calculation — Default: False

sort (array items)

List of fields and directions to sort on. Order determines precedence.

Field	Type	Required	Notes
field	string	✅	Field key
direction	enum	✅	Direction to sort — Choices: ASC, DESC

collation

Field	Type	Required	Notes
locale	string	✅	Locale to use for string comparison
strength	integer	✅	Strength — Min 1 — Max 4

2. local_warehouse_query

Field	Type	Required	Notes
type	const	✅	local_warehouse_query
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
warehouse_query	string		Warehouse Query id — Pattern: ^whsq-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whsq-123e4567-e89b-41d2-a345-678901234567
query	object
entity_aliases	object		Aliases used within query for substitution
parameters	object		Parameters used within query for substitution
parameter_values	object
pagination	object
project	string		Project id — Pattern: ^proj-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. proj-123e4567-e89b-41d2-a345-678901234567

query

The query object is a discriminated union. One of the following 2 shapes applies.

Variant 1

Field	Type	Required	Notes
format	enum	✅	Choices: sql, json_sql, plugin_dsl
query	string	✅	Stringified query in the specified format

Variant 2

Field	Type	Required	Notes
format	enum	✅	Choices: entity
entity	string	✅	Unique id for a queryable entity within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*(-cells)?$
discovered_id	string		Unique id from a remote source

entity_aliases

Aliases used within query for substitution

Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.

Field	Type	Required	Notes
warehouse	string		Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
entity	string	✅	Unique id for a table/view within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters

parameters

Parameters used within query for substitution

Map keyed by field name matching pattern [a-zA-Z][a-zA-Z0-9_]*.

Field	Type	Required	Notes
name	string	✅	Object name with 2-64 characters — 2–64 characters
description	string		Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
type	enum	✅	Choices: string, integer, number, datetime
default	object	✅	Default value

parameter_values

Map keyed by field name matching pattern [a-zA-Z][a-zA-Z0-9_]*.

pagination

Field	Type	Required	Notes
limit	integer		Number of items to return per page. Each object type will have predefined defaults and maximums. — Min 0
skip	integer		Number of items to skip from previous pages — Min 0
sort	array		List of fields and directions to sort on. Order determines precedence.
fields	array		List of fields to include in result. Omit for all.
filter	object		Filter to narrow the returned results in filter JSON format
collation	object
total	boolean		Whether to compute the total count across all pages, which can sometimes be an expensive calculation — Default: False

sort (array items)

List of fields and directions to sort on. Order determines precedence.

Field	Type	Required	Notes
field	string	✅	Field key
direction	enum	✅	Direction to sort — Choices: ASC, DESC

collation

Field	Type	Required	Notes
locale	string	✅	Locale to use for string comparison
strength	integer	✅	Strength — Min 1 — Max 4

3. accelerated_warehouse_query

Field	Type	Required	Notes
type	const	✅	accelerated_warehouse_query
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
warehouse_query	string		Warehouse Query id — Pattern: ^whsq-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whsq-123e4567-e89b-41d2-a345-678901234567
query	object
entity_aliases	object		Aliases used within query for substitution
parameters	object		Parameters used within query for substitution
parameter_values	object
pagination	object
query_entities	array		Entities referenced by "query", extracted before any scope substitution ran. Falls back to extracting from "query" when omitted.

query

The query object is a discriminated union. One of the following 2 shapes applies.

Variant 1

Field	Type	Required	Notes
format	enum	✅	Choices: sql, json_sql, plugin_dsl
query	string	✅	Stringified query in the specified format

Variant 2

Field	Type	Required	Notes
format	enum	✅	Choices: entity
entity	string	✅	Unique id for a queryable entity within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*(-cells)?$
discovered_id	string		Unique id from a remote source

entity_aliases

Aliases used within query for substitution

Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.

Field	Type	Required	Notes
warehouse	string		Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
entity	string	✅	Unique id for a table/view within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters

parameters

Parameters used within query for substitution

Map keyed by field name matching pattern [a-zA-Z][a-zA-Z0-9_]*.

Field	Type	Required	Notes
name	string	✅	Object name with 2-64 characters — 2–64 characters
description	string		Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
type	enum	✅	Choices: string, integer, number, datetime
default	object	✅	Default value

parameter_values

Map keyed by field name matching pattern [a-zA-Z][a-zA-Z0-9_]*.

pagination

Field	Type	Required	Notes
limit	integer		Number of items to return per page. Each object type will have predefined defaults and maximums. — Min 0
skip	integer		Number of items to skip from previous pages — Min 0
sort	array		List of fields and directions to sort on. Order determines precedence.
fields	array		List of fields to include in result. Omit for all.
filter	object		Filter to narrow the returned results in filter JSON format
collation	object
total	boolean		Whether to compute the total count across all pages, which can sometimes be an expensive calculation — Default: False

sort (array items)

List of fields and directions to sort on. Order determines precedence.

Field	Type	Required	Notes
field	string	✅	Field key
direction	enum	✅	Direction to sort — Choices: ASC, DESC

collation

Field	Type	Required	Notes
locale	string	✅	Locale to use for string comparison
strength	integer	✅	Strength — Min 1 — Max 4

4. accelerated_warehouse_vector_query

Field	Type	Required	Notes
type	const	✅	accelerated_warehouse_vector_query
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
query	object	✅
pagination	object

query

Field	Type	Required	Notes
format	const	✅	text_vector_hybrid
entity	string	✅	Unique id for a table within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
field	string	✅	Unique id for a table within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
content	string	✅	Min 1 characters
dense_weight	number		Min 0 — Max 1
filter	object

filter

Field	Type	Required	Notes
field	string	✅	Unique id for a table within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
op	enum	✅	Choices: eq, in
value	object	✅

pagination

Field	Type	Required	Notes
limit	integer		Number of items to return per page. Each object type will have predefined defaults and maximums. — Min 0
skip	integer		Number of items to skip from previous pages — Min 0
sort	array		List of fields and directions to sort on. Order determines precedence.
fields	array		List of fields to include in result. Omit for all.
filter	object		Filter to narrow the returned results in filter JSON format
collation	object
total	boolean		Whether to compute the total count across all pages, which can sometimes be an expensive calculation — Default: False

sort (array items)

List of fields and directions to sort on. Order determines precedence.

Field	Type	Required	Notes
field	string	✅	Field key
direction	enum	✅	Direction to sort — Choices: ASC, DESC

collation

Field	Type	Required	Notes
locale	string	✅	Locale to use for string comparison
strength	integer	✅	Strength — Min 1 — Max 4

destination

The destination object is a discriminated union. One of the following 4 shapes applies.

1. remote_warehouse_ingest

Field	Type	Required	Notes
type	const	✅	remote_warehouse_ingest
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
table	string	✅	Unique id for a table within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
mode	enum	✅	Choices: overwrite, upsert
auto_migrate	boolean		Whether to automatically migrate the warehouse table to match the incoming schema

2. local_warehouse_ingest

Field	Type	Required	Notes
type	const	✅	local_warehouse_ingest
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
table	string	✅	Unique id for a table within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
mode	enum	✅	Choices: overwrite, upsert, overwrite_cells, upsert_cells
auto_migrate	boolean		Whether to automatically migrate the warehouse table to match the incoming schema — Default: False

3. accelerated_warehouse_ingest

Field	Type	Required	Notes
type	const	✅	accelerated_warehouse_ingest
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
table	string	✅	Unique id for a table within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
mode	enum	✅	Choices: overwrite, upsert
auto_migrate	boolean		Whether to automatically migrate the warehouse table to match the incoming schema

4. user_warehouse_export

Field	Type	Required	Notes
type	const	✅	user_warehouse_export
format	enum	✅	Format for query results. Max limit is applied if "json". — Choices: parquet, ldjson, json, csv, psv, tsv — Default: json
header	enum		Whether to include a header row. For DSV, "short" omits type indicator. — Choices: none, full, short — Default: full

metadata

Map keyed by field name matching pattern ^(.*)$.

Example Spec

source:
  type: local_warehouse_query
  warehouse: whs-123e4567-e89b-41d2-a345-678901234567
destination:
  type: remote_warehouse_ingest
  warehouse: whs-123e4567-e89b-41d2-a345-678901234567
  table: <string>
  mode: overwrite

---

au3 warehouse transfer-to-bucket

Transfer data from warehouse to bucket

Option	Type	Required	Default	Notes
--spec-schema	boolean			view the schema for run
--spec	string			spec in JSON/YAML format or path to file containing spec
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

--spec payload reference

Schema ID: WarehouseTransferToBucketArgumentDto

This section documents the --spec payload accepted by au3 warehouse transfer-to-bucket. Run warehouse transfer-to-bucket --spec-schema to fetch this schema live from the CLI at any time.

Top-Level Fields

Field	Type	Required	Notes
source	object	✅
destination	object	✅

source

The source object is a discriminated union. One of the following 1 shapes applies.

1. local_warehouse_query

Field	Type	Required	Notes
type	const	✅	local_warehouse_query
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
warehouse_query	string		Warehouse Query id — Pattern: ^whsq-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whsq-123e4567-e89b-41d2-a345-678901234567
query	object
entity_aliases	object		Aliases used within query for substitution
parameters	object		Parameters used within query for substitution
parameter_values	object
pagination	object

query

The query object is a discriminated union. One of the following 2 shapes applies.

Variant 1

Field	Type	Required	Notes
format	enum	✅	Choices: sql, json_sql, plugin_dsl
query	string	✅	Stringified query in the specified format

Variant 2

Field	Type	Required	Notes
format	enum	✅	Choices: entity
entity	string	✅	Unique id for a queryable entity within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*(-cells)?$
discovered_id	string		Unique id from a remote source

entity_aliases

Aliases used within query for substitution

Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.

Field	Type	Required	Notes
warehouse	string		Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
entity	string	✅	Unique id for a table/view within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters

parameters

Parameters used within query for substitution

Map keyed by field name matching pattern [a-zA-Z][a-zA-Z0-9_]*.

Field	Type	Required	Notes
name	string	✅	Object name with 2-64 characters — 2–64 characters
description	string		Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
type	enum	✅	Choices: string, integer, number, datetime
default	object	✅	Default value

parameter_values

Map keyed by field name matching pattern [a-zA-Z][a-zA-Z0-9_]*.

pagination

Field	Type	Required	Notes
limit	integer		Number of items to return per page. Each object type will have predefined defaults and maximums. — Min 0
skip	integer		Number of items to skip from previous pages — Min 0
sort	array		List of fields and directions to sort on. Order determines precedence.
fields	array		List of fields to include in result. Omit for all.
filter	object		Filter to narrow the returned results in filter JSON format
collation	object
total	boolean		Whether to compute the total count across all pages, which can sometimes be an expensive calculation — Default: False

sort (array items)

List of fields and directions to sort on. Order determines precedence.

Field	Type	Required	Notes
field	string	✅	Field key
direction	enum	✅	Direction to sort — Choices: ASC, DESC

collation

Field	Type	Required	Notes
locale	string	✅	Locale to use for string comparison
strength	integer	✅	Strength — Min 1 — Max 4

destination

The destination object is a discriminated union. One of the following 1 shapes applies.

1. remote_bucket_export

Field	Type	Required	Notes
type	const	✅	remote_bucket_export
bucket	string	✅	Bucket id — Pattern: ^bkt-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. bkt-123e4567-e89b-41d2-a345-678901234567
bucket_location	string		Bucket Location id — Pattern: ^bktl-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. bktl-123e4567-e89b-41d2-a345-678901234567
path	string	✅	Remote file path — e.g. /file/path with spaces
name_template	string		Template for object names. Supports {{part_index}}, {{current_date_minus_N_days}} variables. — e.g. data_export_{{part_index}}_{{current_date_minus_0_days}}.csv
format	enum		Format for query results. Max limit is applied if "json". — Choices: parquet, ldjson, json, csv, psv, tsv — Default: json
max_part_size	string		Maximum part file size to export to. Mutually exclusive with max_parts.
schema_file	string		Path to a file to export latest schema. Relative to location path. Only applicable if location points to directory. — e.g. /file/path with spaces
header	enum		Whether to include a header row. For DSV, "short" omits type indicator. — Choices: none, full, short — Default: full
concurrency	integer		Concurrency of processing remote files — Min 1 — Default: 10

Example Spec

source:
  type: local_warehouse_query
  warehouse: whs-123e4567-e89b-41d2-a345-678901234567
destination:
  type: remote_bucket_export
  bucket: bkt-123e4567-e89b-41d2-a345-678901234567
  path: /file/path with spaces

---

au3 warehouse list-history

List warehouse history

Option	Type	Required	Default	Notes
--id	string	✅		warehouse id
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse delete

Delete a warehouse

Option	Type	Required	Default	Notes
--id	string	✅		Warehouse id
--trash	boolean
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse visualize-erd

Visualize warehouse ERD

Option	Type	Required	Default	Notes
--id	string			warehouse id
--format	enum		graphviz	Output format Choices: "graphviz", "mermaid"
--field-mode	enum		none	Field display mode Choices: "all", "keys", "none"
--field-filter	string			filter in JSON/YAML format or path to file containing filter
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse migrate-link-to-relationship

Generate link relationship migration plan for warehouses

Option	Type	Required	Default	Notes
--filter	string			Filter to limit which warehouses are in scope in JSON/YAML format or path to file containing filter
--auto-migrate	boolean			Automatically execute the migration plan
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse entity

au3 warehouse entity list

List entities

Option	Type	Required	Default	Notes
--warehouse	string	✅		warehouse id
--filter	string			filter in JSON/YAML format or path to file containing filter
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse entity view

View entity

Option	Type	Required	Default	Notes
--warehouse	string	✅		warehouse id
--entity	string	✅		entity id
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse entity query

Query Warehouse Entity

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to run query against
--entity	string	✅		Entity to run query against
--limit				Number of rows to limit result to
--skip				Number of rows to skip
--total	boolean			Whether to calculate total number of rows across all pages
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--filter	string			Filter in JSON/YAML format or path to file containing filter
--fields	string			Comma-separate list of fields to display
--format	enum		json	Choices: "parquet", "ldjson", "json", "csv", "psv", "tsv"
--header	enum		full	Header format to include. Not applicable for "json" or "parquet" format. Choices: "none", "full", "short"
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse entity field

au3 warehouse entity field list

List fields

Option	Type	Required	Default	Notes
--warehouse	string	✅		warehouse id
--entity	string	✅		entity id
--filter	string			filter in JSON/YAML format or path to file containing filter
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse entity field view

View field

Option	Type	Required	Default	Notes
--warehouse	string	✅		warehouse id
--entity	string	✅		entity id
--field	string	✅		field id
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse report

au3 warehouse report link-usage

Warehouse link usage report

Option	Type	Required	Default	Notes
--filter	string			Filter to limit which warehouses are in scope in JSON/YAML format or path to file containing filter
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse-query

au3 warehouse-query list

List warehouse queries

Option	Type	Required	Default	Notes
--fields	string			Comma-separate list of fields to display
--filter	string			Filter in JSON/YAML format or path to file containing filter
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search	string			Search in JSON/YAML format or path to file containing search
--limit			100	Number of results to fetch
--skip				Number of results to skip
--all	boolean		false	Whether to fetch results from all pages
--stream	boolean		false	Whether to print results as they are received without buffering (as JSON)
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse-query view

View warehouse query

Option	Type	Required	Default	Notes
--id	string	✅		The warehouse query id
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse-query create

Create warehouse query

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse id
--name	string	✅		Object name with 2-64 characters
--description	string			Object description with 0 or 2-256 characters
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse-query update

Update warehouse query

Option	Type	Required	Default	Notes
--id	string	✅		The warehouse query id
--name	string			The warehouse query name
--description	string			The warehouse query description
--query	string			Query in JSON/YAML format or path to file containing query
--tags	string			Comma-separate list of tags
--aliases	string			Aliases used within query for substitution in JSON/YAML format or path to file containing aliases
--parameters	string			Parameters used within query for substitution in JSON/YAML format or path to file containing parameters
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse-query run

Runs a saved query

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to run query against
--query	string	✅		The WarehouseQueryId of the query to run
--limit				Number of rows to limit result to
--skip				Number of rows to skip
--total	boolean			Whether to calculate total number of rows across all pages
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--filter	string			Filter in JSON/YAML format or path to file containing filter
--fields	string			Comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 warehouse-query delete

Delete warehouse query

Option	Type	Required	Default	Notes
--id	string	✅		The warehouse query id
--trash	boolean			Whether the Warehouse Query should be trashed (true) or deleted (false). Defaults to true
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

Generated from au3 warehouse --help, au3 warehouse-query --help, and subcommand help output.