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 = Field(pattern='^[a-zA-Z0-9_]+$')
class-attribute
instance-attribute
¶
description = ''
class-attribute
instance-attribute
¶
tags = Field(default_factory=list)
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 instanceslocal: instance-specific overrides
Code Environments¶
CodeEnvResource¶
dss_provisioner.resources.code_env.CodeEnvResource
¶
Project default code environment resource (singleton per project).
Selects existing instance-level code environments as the project defaults. Code environments themselves are not created or managed — only the project setting that points to them.
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.
Managed Folders¶
ManagedFolderResource¶
dss_provisioner.resources.managed_folder.ManagedFolderResource
¶
Base resource for DSS managed folders.
to_dss_params()
¶
Build the DSS API params dict from DSSParam-annotated fields.
FilesystemManagedFolderResource¶
dss_provisioner.resources.managed_folder.FilesystemManagedFolderResource
¶
Filesystem-specific managed folder resource.
UploadManagedFolderResource¶
dss_provisioner.resources.managed_folder.UploadManagedFolderResource
¶
Upload-specific managed folder resource.
Exposed Objects¶
ExposedObjectResource¶
dss_provisioner.resources.exposed_object.ExposedObjectResource
¶
Base resource for DSS exposed objects.
ExposedDatasetResource¶
dss_provisioner.resources.exposed_object.ExposedDatasetResource
¶
Expose a local dataset to one or more target projects.
ExposedManagedFolderResource¶
dss_provisioner.resources.exposed_object.ExposedManagedFolderResource
¶
Expose a local managed folder to one or more target projects.
Foreign Objects¶
ForeignDatasetResource¶
dss_provisioner.resources.foreign.ForeignDatasetResource
¶
A declared foreign dataset reference available to this project.
ForeignManagedFolderResource¶
dss_provisioner.resources.foreign.ForeignManagedFolderResource
¶
A declared foreign managed folder reference available to this project.
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.
Scenarios¶
ScenarioResource¶
dss_provisioner.resources.scenario.ScenarioResource
¶
Base resource for DSS scenarios.
StepBasedScenarioResource¶
dss_provisioner.resources.scenario.StepBasedScenarioResource
¶
Step-based scenario with declarative steps.
PythonScenarioResource¶
dss_provisioner.resources.scenario.PythonScenarioResource
¶
Custom Python scenario.
Modules¶
ModuleSpec¶
dss_provisioner.config.modules.ModuleSpec
¶
Specification for a single module invocation in the YAML config.
invocations()
¶
Return (kwargs, label) pairs for each call to make.
ModuleExpansionError¶
dss_provisioner.config.modules.ModuleExpansionError
¶
Bases: Exception
Raised when module resolution or expansion fails.
expand_modules¶
dss_provisioner.config.modules.expand_modules(modules, config_dir)
¶
Expand all module specs into a flat list of resources.