Skip to content

Resource reference

Auto-generated API documentation for all resource types.

Base

dss_provisioner.resources.base.Resource

Base class for all DSS resources.

Resources are pure data - they define the desired state. Handlers know how to CRUD resources.

name instance-attribute

description = '' class-attribute instance-attribute

tags = [] class-attribute instance-attribute

depends_on = [] class-attribute instance-attribute

address property

Unique address for this resource (e.g., 'dss_dataset.my_dataset').

reference_names()

Names of other resources this one references (auto-collected from Ref markers).

Variables

VariablesResource

dss_provisioner.resources.variables.VariablesResource

Project variables resource (singleton per project).

Manages DSS project variables in two scopes:

  • standard: shared across all instances
  • local: instance-specific overrides

Zones

ZoneResource

dss_provisioner.resources.zone.ZoneResource

A DSS flow zone.

Zones partition the flow graph into logical sections (e.g. raw, curated). They must be provisioned before datasets/recipes that reference them.

Git Libraries

GitLibraryResource

dss_provisioner.resources.git_library.GitLibraryResource

Git library reference for a DSS project.

Manages external Git repositories imported into the project library. Each entry maps to a Git reference in DSS's external-libraries.json.

Datasets

DatasetResource

dss_provisioner.resources.dataset.DatasetResource

Base resource for DSS datasets.

to_dss_params()

Build the DSS API params dict from DSSParam-annotated fields.

SnowflakeDatasetResource

dss_provisioner.resources.dataset.SnowflakeDatasetResource

Snowflake-specific dataset resource.

OracleDatasetResource

dss_provisioner.resources.dataset.OracleDatasetResource

Oracle-specific dataset resource.

FilesystemDatasetResource

dss_provisioner.resources.dataset.FilesystemDatasetResource

Filesystem-specific dataset resource.

UploadDatasetResource

dss_provisioner.resources.dataset.UploadDatasetResource

Upload-specific dataset resource.

Column

dss_provisioner.resources.dataset.Column

Bases: BaseModel

A column in a dataset schema.

Recipes

RecipeResource

dss_provisioner.resources.recipe.RecipeResource

Base resource for DSS recipes.

PythonRecipeResource

dss_provisioner.resources.recipe.PythonRecipeResource

Python recipe resource.

SQLQueryRecipeResource

dss_provisioner.resources.recipe.SQLQueryRecipeResource

SQL query recipe resource.

SyncRecipeResource

dss_provisioner.resources.recipe.SyncRecipeResource

Sync recipe resource.