Skip to content

dbt-meshify Commands#

dbt-meshify#

Usage:

dbt-meshify [OPTIONS] COMMAND [ARGS]...

Options:

  --dry-run
  --debug
  --version  Show version information and exit
  --help     Show this message and exit.

Subcommands

dbt-meshify connect#

Connects multiple dbt projects together by adding all necessary dbt Mesh constructs

Usage:

dbt-meshify connect [OPTIONS]

Options:

  --project-paths TUPLE         The paths to the set of dbt projects to
                                connect. Must supply 2+ paths.
  --projects-dir PATH           The path to a directory containing multiple
                                dbt projects. Directory must contain 2+
                                projects.
  -e, --exclude-projects TUPLE  The set of dbt projects to exclude from the
                                operation when using the --projects-dir
                                option.
  -r, --read-catalog            Skips the dbt docs generate step and reads the
                                local catalog.json file.
  --help                        Show this message and exit.

dbt-meshify group#

Creates a new dbt group based on the selection syntax Detects the edges of the group, makes their access protected, and adds contracts to them

Usage:

dbt-meshify group [OPTIONS] NAME

Options:

  -e, --exclude TUPLE      The dbt selection syntax specifying the resources
                           to exclude in the operation
  --group-yml-path PATH    An optional path to store the new group YAML
                           definition.
  --owner-email TEXT       The group Owner's email address.
  --owner-name TEXT        The group Owner's name.
  --owner-properties TEXT  Additional properties to assign to a group Owner.
  --project-path PATH      The path to the dbt project to operate on. Defaults
                           to the current directory.
  -r, --read-catalog       Skips the dbt docs generate step and reads the
                           local catalog.json file.
  -s, --select TUPLE       The dbt selection syntax specifying the resources
                           to include in the operation
  --selector TUPLE         The name(s) of the YML selector specifying the
                           resources to include in the operation
  --help                   Show this message and exit.

dbt-meshify operation#

Set of subcommands for performing mesh operations on dbt projects

Usage:

dbt-meshify operation [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

dbt-meshify operation add-contract#

Adds a contract to all selected models.

Usage:

dbt-meshify operation add-contract [OPTIONS]

Options:

  -e, --exclude TUPLE  The dbt selection syntax specifying the resources to
                       exclude in the operation
  --project-path PATH  The path to the dbt project to operate on. Defaults to
                       the current directory.
  -r, --read-catalog   Skips the dbt docs generate step and reads the local
                       catalog.json file.
  -s, --select TUPLE   The dbt selection syntax specifying the resources to
                       include in the operation
  --selector TUPLE     The name(s) of the YML selector specifying the
                       resources to include in the operation
  --help               Show this message and exit.

dbt-meshify operation add-version#

Adds model version boilerplate for all selected models.

Usage:

dbt-meshify operation add-version [OPTIONS]

Options:

  -e, --exclude TUPLE  The dbt selection syntax specifying the resources to
                       exclude in the operation
  --project-path PATH  The path to the dbt project to operate on. Defaults to
                       the current directory.
  -r, --read-catalog   Skips the dbt docs generate step and reads the local
                       catalog.json file.
  -s, --select TUPLE   The dbt selection syntax specifying the resources to
                       include in the operation
  --selector TUPLE     The name(s) of the YML selector specifying the
                       resources to include in the operation
  --defined-in TEXT
  --help               Show this message and exit.

dbt-meshify operation bump-version#

Create new model versions for all selected models.

Usage:

dbt-meshify operation bump-version [OPTIONS]

Options:

  -e, --exclude TUPLE  The dbt selection syntax specifying the resources to
                       exclude in the operation
  --project-path PATH  The path to the dbt project to operate on. Defaults to
                       the current directory.
  -r, --read-catalog   Skips the dbt docs generate step and reads the local
                       catalog.json file.
  -s, --select TUPLE   The dbt selection syntax specifying the resources to
                       include in the operation
  --selector TUPLE     The name(s) of the YML selector specifying the
                       resources to include in the operation
  -l, --latest         Makes the newest version the latest version when
                       creating model versions
  --increment, --i     Increments the latest_version setting by 1 when
                       creating model versions
  --defined-in TEXT
  --help               Show this message and exit.

dbt-meshify operation create-group#

Create a group and add selected resources to the group.

Usage:

dbt-meshify operation create-group [OPTIONS] NAME

Options:

  -e, --exclude TUPLE      The dbt selection syntax specifying the resources
                           to exclude in the operation
  --group-yml-path PATH    An optional path to store the new group YAML
                           definition.
  --owner-email TEXT       The group Owner's email address.
  --owner-name TEXT        The group Owner's name.
  --owner-properties TEXT  Additional properties to assign to a group Owner.
  --project-path PATH      The path to the dbt project to operate on. Defaults
                           to the current directory.
  -r, --read-catalog       Skips the dbt docs generate step and reads the
                           local catalog.json file.
  -s, --select TUPLE       The dbt selection syntax specifying the resources
                           to include in the operation
  --selector TUPLE         The name(s) of the YML selector specifying the
                           resources to include in the operation
  --help                   Show this message and exit.

dbt-meshify split#

Splits out a new subproject from a dbt project by adding all necessary dbt Mesh constructs to the resources based on the selected resources.

Usage:

dbt-meshify split [OPTIONS] PROJECT_NAME

Options:

  --create-path PATH   The path to create the new dbt project. Defaults to the
                       name argument supplied.
  -e, --exclude TUPLE  The dbt selection syntax specifying the resources to
                       exclude in the operation
  --project-path PATH  The path to the dbt project to operate on. Defaults to
                       the current directory.
  -r, --read-catalog   Skips the dbt docs generate step and reads the local
                       catalog.json file.
  -s, --select TUPLE   The dbt selection syntax specifying the resources to
                       include in the operation
  --selector TUPLE     The name(s) of the YML selector specifying the
                       resources to include in the operation
  --help               Show this message and exit.

dbt-meshify version#

Increment the models to the next version, and create in the initial version if it has not yet been defined.

Usage:

dbt-meshify version [OPTIONS]

Options:

  -e, --exclude TUPLE  The dbt selection syntax specifying the resources to
                       exclude in the operation
  --project-path PATH  The path to the dbt project to operate on. Defaults to
                       the current directory.
  -r, --read-catalog   Skips the dbt docs generate step and reads the local
                       catalog.json file.
  -s, --select TUPLE   The dbt selection syntax specifying the resources to
                       include in the operation
  --selector TUPLE     The name(s) of the YML selector specifying the
                       resources to include in the operation
  -l, --latest         Makes the newest version the latest version when
                       creating model versions
  --increment, --i     Increments the latest_version setting by 1 when
                       creating model versions
  --defined-in TEXT
  --help               Show this message and exit.