CLI Cortex Framework demo deploy
NAME
uv run cortex-demo - Deploy Cortex Framework demo scenario with pre
populated sample data.
SYNOPSIS
uv run cortex-demo [-h] --project_id PROJECT_ID
[--dataform_region DATAFORM_REGION]
[--bigquery_location BIGQUERY_LOCATION]
[--service_account SERVICE_ACCOUNT]
[--sap_version SAP_VERSION]
[--source_sap_raw_dataset_id SOURCE_SAP_RAW_DATASET_ID]
[--target_sap_foundation_dataset_id TARGET_SAP_FOUNDATION_DATASET_ID]
[--target_dp_dataset_id TARGET_DP_DATASET_ID]
[--repository_name REPOSITORY_NAME]
[--workspace_name WORKSPACE_NAME] [--create_workflow_configs]
[--enable-apis] [--create-datasets] [--disable-telemetry]
Global flags
| Flag | Description | Default |
|---|---|---|
-h |
Show help message and exit. | |
--project_id=PROJECT_ID |
The Google Cloud project ID to use for this invocation. | |
--dataform_region DATAFORM_REGION |
The Google Cloud region where the Dataform repository and workspace will be hosted. For more information, see Supported Dataform regions. | us-central1 |
--bigquery_location BIGQUERY_LOCATION |
The BigQuery location to use for all datasets. BigQuery is the native execution environment for all transformations. For more information, see Supported BigQuery locations. | US |
--service_account SERVICE_ACCOUNT |
The service account Dataform will use to run the transformation graphs. This is required for creating scheduled workflow configurations. | |
--sap_version SAP_VERSION |
The SAP source system version (for example, `ecc` or `s4`) to use for the demo deployment. | s4 |
--source_sap_raw_dataset_id SOURCE_SAP_RAW_DATASET_ID |
The BigQuery dataset ID containing the raw SAP tables. | cortex_demo_sap_s4_raw |
--target_sap_foundation_dataset_id TARGET_SAP_FOUNDATION_DATASET_ID |
The BigQuery dataset ID for the Data Foundation Layer (the cleaned, standardized representation of source data). | cortex_demo_sap_s4_data_foundation |
--target_dp_dataset_id TARGET_DP_DATASET_ID |
The BigQuery dataset ID for the Data Product Layer (domain-oriented interfaces aggregated for consumption). | cortex_demo_data_product |
--target_samples_dataset_id TARGET_SAMPLES_DATASET_ID |
The BigQuery dataset ID for the target samples. | cortex_demo_samples |
--repository_name REPOSITORY_NAME |
The name of the Dataform repository to create or deploy the assets to. | cortex-framework-demo |
--workspace_name WORKSPACE_NAME |
The name of the Dataform workspace where the assets will be pushed. | demo |
--create_workflow_configs |
Optional flag to automatically create the Dataform Workflow Configurations (schedules) for the deployed assets. | |
--enable-apis |
Optional flag to automatically enable the required Google Cloud APIs (for example, BigQuery, Dataform) for the project. | |
--create-datasets |
Optional flag to automatically provision the necessary target BigQuery datasets (Raw, Foundation, Data Product). | |
--disable-telemetry |
Temporarily disable telemetry event logging during execution. For more information, see Cortex Framework Telemetry. |