au3 solution installation phase delivery — Command Reference

CLI command group: au3 solution installation phase delivery

Commands for the Delivery phase: managing transfers that push data from the Processed Model into the Deliverable Model.

---

au3 solution installation phase delivery transfer

au3 solution installation phase delivery transfer list

List transfers

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 solution installation phase delivery transfer view

View transfer

Option	Type	Required	Default	Notes
--id	string	✅		transfer id
--fields	string			comma-separate list of fields to display
--update-spec	boolean			print in the form which is usable for the update command
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase delivery transfer create

Create transfer

Option	Type	Required	Default	Notes
--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 solution installation phase delivery transfer update

Update transfer

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: UpdateSolutionInstallationDraftDeliveryTransferArgumentDto

This section documents the --spec payload accepted by au3 solution installation phase delivery transfer update. Run solution installation phase delivery transfer 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	✅	Id of delivery phase transfer — Pattern: ^sideltrf-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
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
source	object	✅
destination	object	✅
dependencies	array		Ids of other delivery transfers this transfer depends on
error_handling	object		Options for error handling

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
query	object
entity_aliases	object		Aliases used within query for substitution
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

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 3 shapes applies.

1. 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

2. remote_warehouse_ingest

Field	Type	Required	Notes
type	const	✅	remote_warehouse_ingest
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
warehouse	string	✅	Id of logical warehouse which maps to primary or secondary warehouse depending on the connection's mode — Pattern: ^sidmwhs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

3. remote_bucket_export

Field	Type	Required	Notes
type	const	✅	remote_bucket_export
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
bucket	string	✅	Id of logical bucket which maps to primary or secondary bucket depending on the connection's mode — Pattern: ^sidmbkt-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

error_handling

Options for error handling

Field	Type	Required	Notes
retry	boolean		Whether to retry the task in the case of a failure — Default: False
retries	integer		The maximum amount of times to retry the operation — Min 0 — Default: 2
factor	number		The exponential factor to use — Min 0 — Default: 2
minTimeout	integer		The number of milliseconds before starting the first retry — Min 0 — Default: 10000
maxTimeout	integer		The maximum number of milliseconds between two retries — Min 0 — Default: 180000
randomize	boolean		Randomizes the timeouts by multiplying with a factor between 1 to 2 — Default: False

Example Spec

id: sideltrf-123e4567-e89b-41d2-a345-678901234567
source:
  type: local_warehouse_query
  warehouse: whs-123e4567-e89b-41d2-a345-678901234567
destination:
  type: remote_bucket_export
  path: /file/path with spaces
  bucket: sidmbkt-123e4567-e89b-41d2-a345-678901234567
name: <string>
description: <string>

---

au3 solution installation phase delivery transfer run

Run transfer

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

---

au3 solution installation phase delivery transfer delete

Delete transfer

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

---

Generated from au3 solution installation phase delivery --help and subcommand help output.