Skip to content

au3 solution installation phase mapping — Command Reference

CLI command group: au3 solution installation phase mapping

Commands for the Mapping phase: managing dataflows that map data from the Local Source Model into the Mapped Model.


au3 solution installation phase mapping dataflow

au3 solution installation phase mapping dataflow list

List dataflows

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 mapping dataflow view

View dataflow

Option Type Required Default Notes
--id string ✅ dataflow 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 mapping dataflow create

Create dataflow

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 mapping dataflow update

Update dataflow

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

This section documents the --spec payload accepted by au3 solution installation phase mapping dataflow update. Run solution installation phase mapping dataflow 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 Dataflow id — Pattern: ^whsdf-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whsdf-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
script string Stringified Warehouse Dataflow Script
validate boolean Default: False
Example Spec
name: <string>
description: <string>

au3 solution installation phase mapping dataflow run

Run dataflow

Option Type Required Default Notes
--id string ✅ Id of dataflow to run
--options string Options in JSON/YAML format or path to file containing options
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase mapping dataflow delete

Delete dataflow

Option Type Required Default Notes
--id string ✅ dataflow 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 mapping --help and subcommand help output.