Skip to main content Skip to complementary content

Generating projects using the CLI

The instruction below explain how to automatically generate projects using the CLI. This can be especially useful when deploying projects between different environments.

Command syntax

ComposeCli.exe generate_project --project project_name [--database_already_adjusted]

Parameters

Parameter Description
--project The name of the project.
--database_already_adjusted An optional parameter that should only be included if the data warehouse and data marts were adjusted outside of Compose.

Example

ComposeCli.exe generate_project --project MyProject --database_already_adjusted

When the command is run, Compose will:

  • Validate the metadata.
  • Create any storage tables that do not exist.
  • Validate the storage.
  • Adjust the storage if needed.

    • If an Adjust script is needed and --database_already_adjusted is included in the command, the script (DDL) will not be run as it is assumed that the user ran it manually.
    • If the "Adjust" cannot be performed automatically, the process will be stopped.
  • Generate all storage tasks.

    Warning note

    If Compose encounters an error while generating a storage task, it will skip the problematic task and continue with the remaining tasks.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!