databricks-bundles 0.265.0__py3-none-any.whl → 0.267.0__py3-none-any.whl

databricks/bundles/pipelines/_models/init_script_info.py

@@ -8,6 +8,10 @@ from databricks.bundles.pipelines._models.adlsgen2_info import (
     Adlsgen2Info,
     Adlsgen2InfoParam,
 )
+from databricks.bundles.pipelines._models.dbfs_storage_info import (
+    DbfsStorageInfo,
+    DbfsStorageInfoParam,
+)
 from databricks.bundles.pipelines._models.gcs_storage_info import (
     GcsStorageInfo,
     GcsStorageInfoParam,
@@ -45,6 +49,12 @@ class InitScriptInfo:
     Contains the Azure Data Lake Storage destination path
     """
 
+    dbfs: VariableOrOptional[DbfsStorageInfo] = None
+    """
+    [DEPRECATED] destination needs to be provided. e.g.
+    `{ "dbfs": { "destination" : "dbfs:/home/cluster_log" } }`
+    """
+
     file: VariableOrOptional[LocalFileInfo] = None
     """
     destination needs to be provided, e.g.
@@ -93,6 +103,12 @@ class InitScriptInfoDict(TypedDict, total=False):
     Contains the Azure Data Lake Storage destination path
     """
 
+    dbfs: VariableOrOptional[DbfsStorageInfoParam]
+    """
+    [DEPRECATED] destination needs to be provided. e.g.
+    `{ "dbfs": { "destination" : "dbfs:/home/cluster_log" } }`
+    """
+
     file: VariableOrOptional[LocalFileInfoParam]
     """
     destination needs to be provided, e.g.

databricks/bundles/pipelines/_models/pipeline.py

@@ -203,7 +203,7 @@ class Pipeline(Resource):
 
     target: VariableOrOptional[str] = None
     """
-    Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.
+    [DEPRECATED] Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.
     """
 
     @classmethod
@@ -361,7 +361,7 @@ class PipelineDict(TypedDict, total=False):
 
     target: VariableOrOptional[str]
     """
-    Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.
+    [DEPRECATED] Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.
     """
 
 

databricks/bundles/pipelines/_models/postgres_catalog_config.py

@@ -0,0 +1,50 @@
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, TypedDict
+
+from databricks.bundles.core._transform import _transform
+from databricks.bundles.core._transform_to_json import _transform_to_json_value
+from databricks.bundles.core._variable import VariableOrOptional
+from databricks.bundles.pipelines._models.postgres_slot_config import (
+    PostgresSlotConfig,
+    PostgresSlotConfigParam,
+)
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+
+@dataclass(kw_only=True)
+class PostgresCatalogConfig:
+    """
+    :meta private: [EXPERIMENTAL]
+
+    PG-specific catalog-level configuration parameters
+    """
+
+    slot_config: VariableOrOptional[PostgresSlotConfig] = None
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    Optional. The Postgres slot configuration to use for logical replication
+    """
+
+    @classmethod
+    def from_dict(cls, value: "PostgresCatalogConfigDict") -> "Self":
+        return _transform(cls, value)
+
+    def as_dict(self) -> "PostgresCatalogConfigDict":
+        return _transform_to_json_value(self)  # type:ignore
+
+
+class PostgresCatalogConfigDict(TypedDict, total=False):
+    """"""
+
+    slot_config: VariableOrOptional[PostgresSlotConfigParam]
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    Optional. The Postgres slot configuration to use for logical replication
+    """
+
+
+PostgresCatalogConfigParam = PostgresCatalogConfigDict | PostgresCatalogConfig

databricks/bundles/pipelines/_models/postgres_slot_config.py

@@ -0,0 +1,60 @@
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, TypedDict
+
+from databricks.bundles.core._transform import _transform
+from databricks.bundles.core._transform_to_json import _transform_to_json_value
+from databricks.bundles.core._variable import VariableOrOptional
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+
+@dataclass(kw_only=True)
+class PostgresSlotConfig:
+    """
+    :meta private: [EXPERIMENTAL]
+
+    PostgresSlotConfig contains the configuration for a Postgres logical replication slot
+    """
+
+    publication_name: VariableOrOptional[str] = None
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    The name of the publication to use for the Postgres source
+    """
+
+    slot_name: VariableOrOptional[str] = None
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    The name of the logical replication slot to use for the Postgres source
+    """
+
+    @classmethod
+    def from_dict(cls, value: "PostgresSlotConfigDict") -> "Self":
+        return _transform(cls, value)
+
+    def as_dict(self) -> "PostgresSlotConfigDict":
+        return _transform_to_json_value(self)  # type:ignore
+
+
+class PostgresSlotConfigDict(TypedDict, total=False):
+    """"""
+
+    publication_name: VariableOrOptional[str]
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    The name of the publication to use for the Postgres source
+    """
+
+    slot_name: VariableOrOptional[str]
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    The name of the logical replication slot to use for the Postgres source
+    """
+
+
+PostgresSlotConfigParam = PostgresSlotConfigDict | PostgresSlotConfig

databricks/bundles/pipelines/_models/source_catalog_config.py

@@ -0,0 +1,64 @@
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, TypedDict
+
+from databricks.bundles.core._transform import _transform
+from databricks.bundles.core._transform_to_json import _transform_to_json_value
+from databricks.bundles.core._variable import VariableOrOptional
+from databricks.bundles.pipelines._models.postgres_catalog_config import (
+    PostgresCatalogConfig,
+    PostgresCatalogConfigParam,
+)
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+
+@dataclass(kw_only=True)
+class SourceCatalogConfig:
+    """
+    :meta private: [EXPERIMENTAL]
+
+    SourceCatalogConfig contains catalog-level custom configuration parameters for each source
+    """
+
+    postgres: VariableOrOptional[PostgresCatalogConfig] = None
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    Postgres-specific catalog-level configuration parameters
+    """
+
+    source_catalog: VariableOrOptional[str] = None
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    Source catalog name
+    """
+
+    @classmethod
+    def from_dict(cls, value: "SourceCatalogConfigDict") -> "Self":
+        return _transform(cls, value)
+
+    def as_dict(self) -> "SourceCatalogConfigDict":
+        return _transform_to_json_value(self)  # type:ignore
+
+
+class SourceCatalogConfigDict(TypedDict, total=False):
+    """"""
+
+    postgres: VariableOrOptional[PostgresCatalogConfigParam]
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    Postgres-specific catalog-level configuration parameters
+    """
+
+    source_catalog: VariableOrOptional[str]
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    Source catalog name
+    """
+
+
+SourceCatalogConfigParam = SourceCatalogConfigDict | SourceCatalogConfig

databricks/bundles/pipelines/_models/source_config.py

@@ -0,0 +1,48 @@
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, TypedDict
+
+from databricks.bundles.core._transform import _transform
+from databricks.bundles.core._transform_to_json import _transform_to_json_value
+from databricks.bundles.core._variable import VariableOrOptional
+from databricks.bundles.pipelines._models.source_catalog_config import (
+    SourceCatalogConfig,
+    SourceCatalogConfigParam,
+)
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+
+@dataclass(kw_only=True)
+class SourceConfig:
+    """
+    :meta private: [EXPERIMENTAL]
+    """
+
+    catalog: VariableOrOptional[SourceCatalogConfig] = None
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    Catalog-level source configuration parameters
+    """
+
+    @classmethod
+    def from_dict(cls, value: "SourceConfigDict") -> "Self":
+        return _transform(cls, value)
+
+    def as_dict(self) -> "SourceConfigDict":
+        return _transform_to_json_value(self)  # type:ignore
+
+
+class SourceConfigDict(TypedDict, total=False):
+    """"""
+
+    catalog: VariableOrOptional[SourceCatalogConfigParam]
+    """
+    :meta private: [EXPERIMENTAL]
+    
+    Catalog-level source configuration parameters
+    """
+
+
+SourceConfigParam = SourceConfigDict | SourceConfig

databricks/bundles/version.py

@@ -1 +1 @@
-__version__ = "0.265.0"
+__version__ = "0.267.0"

databricks/bundles/volumes/__init__.py

@@ -0,0 +1,25 @@
+__all__ = [
+    "Volume",
+    "VolumeDict",
+    "VolumeGrant",
+    "VolumeGrantDict",
+    "VolumeGrantParam",
+    "VolumeGrantPrivilege",
+    "VolumeGrantPrivilegeParam",
+    "VolumeParam",
+    "VolumeType",
+    "VolumeTypeParam",
+]
+
+
+from databricks.bundles.volumes._models.volume import Volume, VolumeDict, VolumeParam
+from databricks.bundles.volumes._models.volume_grant import (
+    VolumeGrant,
+    VolumeGrantDict,
+    VolumeGrantParam,
+)
+from databricks.bundles.volumes._models.volume_grant_privilege import (
+    VolumeGrantPrivilege,
+    VolumeGrantPrivilegeParam,
+)
+from databricks.bundles.volumes._models.volume_type import VolumeType, VolumeTypeParam

databricks/bundles/volumes/_models/volume.py

@@ -0,0 +1,96 @@
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING, TypedDict
+
+from databricks.bundles.core._resource import Resource
+from databricks.bundles.core._transform import _transform
+from databricks.bundles.core._transform_to_json import _transform_to_json_value
+from databricks.bundles.core._variable import (
+    VariableOr,
+    VariableOrList,
+    VariableOrOptional,
+)
+from databricks.bundles.volumes._models.volume_grant import (
+    VolumeGrant,
+    VolumeGrantParam,
+)
+from databricks.bundles.volumes._models.volume_type import VolumeType, VolumeTypeParam
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+
+@dataclass(kw_only=True)
+class Volume(Resource):
+    """"""
+
+    catalog_name: VariableOr[str]
+    """
+    The name of the catalog where the schema and the volume are
+    """
+
+    name: VariableOr[str]
+    """
+    The name of the volume
+    """
+
+    schema_name: VariableOr[str]
+    """
+    The name of the schema where the volume is
+    """
+
+    comment: VariableOrOptional[str] = None
+    """
+    The comment attached to the volume
+    """
+
+    grants: VariableOrList[VolumeGrant] = field(default_factory=list)
+
+    storage_location: VariableOrOptional[str] = None
+    """
+    The storage location on the cloud
+    """
+
+    volume_type: VariableOrOptional[VolumeType] = None
+
+    @classmethod
+    def from_dict(cls, value: "VolumeDict") -> "Self":
+        return _transform(cls, value)
+
+    def as_dict(self) -> "VolumeDict":
+        return _transform_to_json_value(self)  # type:ignore
+
+
+class VolumeDict(TypedDict, total=False):
+    """"""
+
+    catalog_name: VariableOr[str]
+    """
+    The name of the catalog where the schema and the volume are
+    """
+
+    name: VariableOr[str]
+    """
+    The name of the volume
+    """
+
+    schema_name: VariableOr[str]
+    """
+    The name of the schema where the volume is
+    """
+
+    comment: VariableOrOptional[str]
+    """
+    The comment attached to the volume
+    """
+
+    grants: VariableOrList[VolumeGrantParam]
+
+    storage_location: VariableOrOptional[str]
+    """
+    The storage location on the cloud
+    """
+
+    volume_type: VariableOrOptional[VolumeTypeParam]
+
+
+VolumeParam = VolumeDict | Volume

databricks/bundles/volumes/_models/volume_grant.py

@@ -0,0 +1,40 @@
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING, TypedDict
+
+from databricks.bundles.core._transform import _transform
+from databricks.bundles.core._transform_to_json import _transform_to_json_value
+from databricks.bundles.core._variable import VariableOr, VariableOrList
+from databricks.bundles.volumes._models.volume_grant_privilege import (
+    VolumeGrantPrivilege,
+    VolumeGrantPrivilegeParam,
+)
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+
+@dataclass(kw_only=True)
+class VolumeGrant:
+    """"""
+
+    principal: VariableOr[str]
+
+    privileges: VariableOrList[VolumeGrantPrivilege] = field(default_factory=list)
+
+    @classmethod
+    def from_dict(cls, value: "VolumeGrantDict") -> "Self":
+        return _transform(cls, value)
+
+    def as_dict(self) -> "VolumeGrantDict":
+        return _transform_to_json_value(self)  # type:ignore
+
+
+class VolumeGrantDict(TypedDict, total=False):
+    """"""
+
+    principal: VariableOr[str]
+
+    privileges: VariableOrList[VolumeGrantPrivilegeParam]
+
+
+VolumeGrantParam = VolumeGrantDict | VolumeGrant

databricks/bundles/volumes/_models/volume_grant_privilege.py

@@ -0,0 +1,16 @@
+from enum import Enum
+from typing import Literal
+
+
+class VolumeGrantPrivilege(Enum):
+    ALL_PRIVILEGES = "ALL_PRIVILEGES"
+    APPLY_TAG = "APPLY_TAG"
+    MANAGE = "MANAGE"
+    READ_VOLUME = "READ_VOLUME"
+    WRITE_VOLUME = "WRITE_VOLUME"
+
+
+VolumeGrantPrivilegeParam = (
+    Literal["ALL_PRIVILEGES", "APPLY_TAG", "MANAGE", "READ_VOLUME", "WRITE_VOLUME"]
+    | VolumeGrantPrivilege
+)

databricks/bundles/volumes/_models/volume_type.py

@@ -0,0 +1,14 @@
+from enum import Enum
+from typing import Literal
+
+
+class VolumeType(Enum):
+    """
+    The type of the volume. An external volume is located in the specified external location. A managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore. [Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)
+    """
+
+    EXTERNAL = "EXTERNAL"
+    MANAGED = "MANAGED"
+
+
+VolumeTypeParam = Literal["EXTERNAL", "MANAGED"] | VolumeType

{databricks_bundles-0.265.0.dist-info → databricks_bundles-0.267.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: databricks-bundles
-Version: 0.265.0
+Version: 0.267.0
 Summary: Python support for Databricks Asset Bundles
 Author-email: Gleb Kanterov <gleb.kanterov@databricks.com>
 Requires-Python: >=3.10
@@ -22,7 +22,7 @@ Reference documentation is available at https://databricks.github.io/cli/experim
 
 To use `databricks-bundles`, you must first:
 
-1. Install the [Databricks CLI](https://github.com/databricks/cli), version 0.265.0 or above
+1. Install the [Databricks CLI](https://github.com/databricks/cli), version 0.267.0 or above
 2. Authenticate to your Databricks workspace if you have not done so already:
 
    ```bash