Skip to content

schema

Schema

Bases: ReadInstancesMixin

A Class to represent a Schema in Unity Catalog.

Source code in src/cloe_nessy/models/schema.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
class Schema(ReadInstancesMixin):
    """A Class to represent a Schema in Unity Catalog."""

    catalog: str
    name: str
    storage_path: str | None = None
    tables: list[Table] = Field(default_factory=list)
    properties: dict[str, Any] = Field(default_factory=dict)
    comment: str | None = None

    @classmethod
    def read_instance_from_file(
        cls,
        instance_path: str | Path,
        fail_on_missing_subfolder: bool = True,
        table_dir_name: str = "tables",
        **_: Any,
    ) -> tuple[Self | None, list[ValidationErrorType]]:
        """Read a schema from file.

        Adds the table objects from a path relative to the schema definition.

        Args:
            instance_path: The path to the Schema definition YAML file.
            fail_on_missing_subfolder: If False return a tuple with 2 empty
                    lists. Otherwise raise a FileNotFoundError.
            table_dir_name: The name of the directory containing the Table
                    definitions related to this schema. Can be a relative path.
        """
        processed_instance_path = process_path(instance_path)
        if not processed_instance_path:
            raise FileNotFoundError("Schema file not found.")

        schema, schema_errors = super().read_instance_from_file(processed_instance_path)
        if schema:
            schema.storage_path = "" if not schema.storage_path else schema.storage_path
            tables, table_errors = Table.read_instances_from_directory(
                instance_path=processed_instance_path.parents[0] / table_dir_name,
                catalog_name=schema.catalog,
                schema_name=schema.name,
                schema_storage_path=schema.storage_path,
                fail_on_missing_subfolder=fail_on_missing_subfolder,
            )
            schema.tables = tables
        return schema, schema_errors + table_errors

    def get_table_by_name(self, table_name: str) -> Table:
        """Return table in schema.

        Filters tables in schema for table_name and returns Table object.

        Args:
            table_name: Name of table to return from schema.

        Raises:
            ValueError: If table not found in schema metadata.

        Returns:
            The table.
        """
        table = next((table for table in self.tables if table.name == table_name), None)

        if not table:
            raise ValueError(f"Table {table_name} not found in {self.catalog}.{self.name} metadata.")

        return table

    def add_table(self, table: Table):
        """Adds a table to the schema and sets the table identifier accordingly.

        Args:
            table: A Table object that is added to the Schema tables.
        """
        table.identifier = f"{self.catalog}.{self.name}.{table.name}"
        self.tables.append(table)

    def add_tables(self, tables: list[Table]) -> None:
        """Adds tables to the schema.

        Args:
            tables: A list of Table objects that are added to the Schema tables.
        """
        for table in tables:
            self.add_table(table)

add_table(table)

Adds a table to the schema and sets the table identifier accordingly.

Parameters:

Name Type Description Default
table Table

A Table object that is added to the Schema tables.

 required
Source code in src/cloe_nessy/models/schema.py 
79
80
81
82
83
84
85
86
def add_table(self, table: Table):
    """Adds a table to the schema and sets the table identifier accordingly.

    Args:
        table: A Table object that is added to the Schema tables.
    """
    table.identifier = f"{self.catalog}.{self.name}.{table.name}"
    self.tables.append(table)

add_tables(tables)

Adds tables to the schema.

Parameters:

Name Type Description Default
tables list[Table]

A list of Table objects that are added to the Schema tables.

 required
Source code in src/cloe_nessy/models/schema.py 
88
89
90
91
92
93
94
95
def add_tables(self, tables: list[Table]) -> None:
    """Adds tables to the schema.

    Args:
        tables: A list of Table objects that are added to the Schema tables.
    """
    for table in tables:
        self.add_table(table)

get_table_by_name(table_name)

Return table in schema.

Filters tables in schema for table_name and returns Table object.

Parameters:

Name Type Description Default
table_name str

Name of table to return from schema.

 required

Raises:

Type Description
ValueError

If table not found in schema metadata.

Returns:

Type Description
Table

The table.
Source code in src/cloe_nessy/models/schema.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def get_table_by_name(self, table_name: str) -> Table:
    """Return table in schema.

    Filters tables in schema for table_name and returns Table object.

    Args:
        table_name: Name of table to return from schema.

    Raises:
        ValueError: If table not found in schema metadata.

    Returns:
        The table.
    """
    table = next((table for table in self.tables if table.name == table_name), None)

    if not table:
        raise ValueError(f"Table {table_name} not found in {self.catalog}.{self.name} metadata.")

    return table

read_instance_from_file(instance_path, fail_on_missing_subfolder=True, table_dir_name='tables', **_) classmethod

Read a schema from file.

Adds the table objects from a path relative to the schema definition.

Parameters:

Name Type Description Default
instance_path str | Path

The path to the Schema definition YAML file.

 required
fail_on_missing_subfolder bool

If False return a tuple with 2 empty lists. Otherwise raise a FileNotFoundError.

 True
table_dir_name str

The name of the directory containing the Table definitions related to this schema. Can be a relative path.

 'tables'
Source code in src/cloe_nessy/models/schema.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@classmethod
def read_instance_from_file(
    cls,
    instance_path: str | Path,
    fail_on_missing_subfolder: bool = True,
    table_dir_name: str = "tables",
    **_: Any,
) -> tuple[Self | None, list[ValidationErrorType]]:
    """Read a schema from file.

    Adds the table objects from a path relative to the schema definition.

    Args:
        instance_path: The path to the Schema definition YAML file.
        fail_on_missing_subfolder: If False return a tuple with 2 empty
                lists. Otherwise raise a FileNotFoundError.
        table_dir_name: The name of the directory containing the Table
                definitions related to this schema. Can be a relative path.
    """
    processed_instance_path = process_path(instance_path)
    if not processed_instance_path:
        raise FileNotFoundError("Schema file not found.")

    schema, schema_errors = super().read_instance_from_file(processed_instance_path)
    if schema:
        schema.storage_path = "" if not schema.storage_path else schema.storage_path
        tables, table_errors = Table.read_instances_from_directory(
            instance_path=processed_instance_path.parents[0] / table_dir_name,
            catalog_name=schema.catalog,
            schema_name=schema.name,
            schema_storage_path=schema.storage_path,
            fail_on_missing_subfolder=fail_on_missing_subfolder,
        )
        schema.tables = tables
    return schema, schema_errors + table_errors