au3 solution installation phase mapped-model — Command Reference¶
CLI command group: au3 solution installation phase mapped-model
Commands for the Mapped Model phase: managing buckets and warehouses holding data after it has been mapped, before further processing.
au3 solution installation phase mapped-model bucket¶
au3 solution installation phase mapped-model bucket list¶
List buckets
| 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 mapped-model bucket view¶
View bucket
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | bucket 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 solution installation phase mapped-model bucket create¶
Create bucket
| 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 mapped-model bucket update¶
Update bucket
| 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: UpdateSolutionInstallationDraftMappedModelBucketArgumentDto
This section documents the --spec payload accepted by au3 solution installation phase mapped-model bucket update. Run solution installation phase mapped-model bucket 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 | 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 |
|
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 |
Example Spec¶
name: <string>
description: <string>
au3 solution installation phase mapped-model bucket delete¶
Delete bucket
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | bucket id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation phase mapped-model warehouse¶
au3 solution installation phase mapped-model 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 solution installation phase mapped-model 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 solution installation phase mapped-model warehouse create¶
Create warehouse
| 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 mapped-model 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: UpdateSolutionInstallationDraftMappedModelWarehouseArgumentDto
This section documents the --spec payload accepted by au3 solution installation phase mapped-model warehouse update. Run solution installation phase mapped-model 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 | |
version |
integer | Object version number |
Example Spec¶
name: <string>
description: <string>
au3 solution installation phase mapped-model 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 solution installation phase mapped-model 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 solution installation phase mapped-model 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 solution installation phase mapped-model 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 solution installation phase mapped-model 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 solution installation phase mapped-model 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 solution installation phase mapped-model warehouse delete¶
Delete warehouse
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | warehouse 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 mapped-model --help and subcommand help output.