Class Schema (2.12.0)

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

Schema information describing the structure and layout of the data.

Attributes

Name Description
user_managed bool
Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). - Set to false\ to enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. - Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
fields MutableSequence[google.cloud.dataplex_v1.types.Schema.SchemaField]
Optional. The sequence of fields describing data in table entities. **Note:** BigQuery SchemaFields are immutable.
partition_fields MutableSequence[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. Note: Partition fields are immutable.

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.