Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Schema (v0.2.1)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Schema.

Schema information describing the structure and layout of the data.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#fields

def fields() -> ::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>
Returns

#fields=

def fields=(value) -> ::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>
Parameter
Returns

#partition_fields

def partition_fields() -> ::Array<::Google::Cloud::Dataplex::V1::Schema::PartitionField>
Returns

#partition_fields=

def partition_fields=(value) -> ::Array<::Google::Cloud::Dataplex::V1::Schema::PartitionField>
Parameter
Returns

#partition_style

def partition_style() -> ::Google::Cloud::Dataplex::V1::Schema::PartitionStyle
Returns

#partition_style=

def partition_style=(value) -> ::Google::Cloud::Dataplex::V1::Schema::PartitionStyle
Parameter
Returns

#user_managed

def user_managed() -> ::Boolean
Returns
  • (::Boolean) —

    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.

#user_managed=

def user_managed=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    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.
Returns
  • (::Boolean) —

    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.