Class Schema (1.0.1)

Schema(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Schema information describing the structure and layout of the data.

Attributes

NameDescription
user_managed bool
Required. Whether the schema is user-managed or managed by the service. - Set user_manage to false if you would like Dataplex to help you manage the schema. You will get the full service provided by Dataplex discovery, including new data discovery, schema inference and schema evolution. You can still provide input the schema of the entities, for example renaming a schema field, changing CSV or Json options if you think the discovered values are not as accurate. Dataplex will consider your input as the initial schema (as if they were produced by the previous discovery run), and will evolve schema or flag actions based on that. - Set user_manage to true if you would like to fully manage the entity schema by yourself. This is useful when you would like to manually specify the schema for a table. In this case, the schema defined by the user is guaranteed to be kept unchanged and would not be overwritten. But this also means Dataplex will not provide schema evolution management for you. Dataplex will still be able to manage partition registration (i.e., keeping the list of partitions up to date) when Dataplex discovery is turned on and user_managed is set to true.
fields Sequence[google.cloud.dataplex_v1.types.Schema.SchemaField]
Optional. The sequence of fields describing data in table entities.
partition_fields Sequence[google.cloud.dataplex_v1.types.Schema.PartitionField]
Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
partition_style google.cloud.dataplex_v1.types.Schema.PartitionStyle
Optional. The structure of paths containing partition data within the entity.

Classes

Mode

Mode(value)

Additional qualifiers to define field semantics.

PartitionField

PartitionField(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a key field within the entity's partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration.

PartitionStyle

PartitionStyle(value)

The structure of paths within the entity, which represent partitions.

SchemaField

SchemaField(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a column field within a table schema.

Type

Type(value)

Type information for fields in schemas and partition schemas.