Skip to main content

TableBuilder

Struct TableBuilder 

Source
#[non_exhaustive]
pub struct TableBuilder { /* private fields */ }
Expand description

A builder for Table.

Implementations§

Source§

impl TableBuilder

Source

pub fn name(self, input: impl Into<String>) -> Self

The table name. For Hive compatibility, this must be entirely lowercase.

This field is required.
Source

pub fn set_name(self, input: Option<String>) -> Self

The table name. For Hive compatibility, this must be entirely lowercase.

Source

pub fn get_name(&self) -> &Option<String>

The table name. For Hive compatibility, this must be entirely lowercase.

Source

pub fn database_name(self, input: impl Into<String>) -> Self

The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

Source

pub fn set_database_name(self, input: Option<String>) -> Self

The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

Source

pub fn get_database_name(&self) -> &Option<String>

The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

Source

pub fn description(self, input: impl Into<String>) -> Self

A description of the table.

Source

pub fn set_description(self, input: Option<String>) -> Self

A description of the table.

Source

pub fn get_description(&self) -> &Option<String>

A description of the table.

Source

pub fn owner(self, input: impl Into<String>) -> Self

The owner of the table.

Source

pub fn set_owner(self, input: Option<String>) -> Self

The owner of the table.

Source

pub fn get_owner(&self) -> &Option<String>

The owner of the table.

Source

pub fn create_time(self, input: DateTime) -> Self

The time when the table definition was created in the Data Catalog.

Source

pub fn set_create_time(self, input: Option<DateTime>) -> Self

The time when the table definition was created in the Data Catalog.

Source

pub fn get_create_time(&self) -> &Option<DateTime>

The time when the table definition was created in the Data Catalog.

Source

pub fn update_time(self, input: DateTime) -> Self

The last time that the table was updated.

Source

pub fn set_update_time(self, input: Option<DateTime>) -> Self

The last time that the table was updated.

Source

pub fn get_update_time(&self) -> &Option<DateTime>

The last time that the table was updated.

Source

pub fn last_access_time(self, input: DateTime) -> Self

The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

Source

pub fn set_last_access_time(self, input: Option<DateTime>) -> Self

The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

Source

pub fn get_last_access_time(&self) -> &Option<DateTime>

The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

Source

pub fn last_analyzed_time(self, input: DateTime) -> Self

The last time that column statistics were computed for this table.

Source

pub fn set_last_analyzed_time(self, input: Option<DateTime>) -> Self

The last time that column statistics were computed for this table.

Source

pub fn get_last_analyzed_time(&self) -> &Option<DateTime>

The last time that column statistics were computed for this table.

Source

pub fn retention(self, input: i32) -> Self

The retention time for this table.

Source

pub fn set_retention(self, input: Option<i32>) -> Self

The retention time for this table.

Source

pub fn get_retention(&self) -> &Option<i32>

The retention time for this table.

Source

pub fn storage_descriptor(self, input: StorageDescriptor) -> Self

A storage descriptor containing information about the physical storage of this table.

Source

pub fn set_storage_descriptor(self, input: Option<StorageDescriptor>) -> Self

A storage descriptor containing information about the physical storage of this table.

Source

pub fn get_storage_descriptor(&self) -> &Option<StorageDescriptor>

A storage descriptor containing information about the physical storage of this table.

Source

pub fn partition_keys(self, input: Column) -> Self

Appends an item to partition_keys.

To override the contents of this collection use set_partition_keys.

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": \[\]

Source

pub fn set_partition_keys(self, input: Option<Vec<Column>>) -> Self

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": \[\]

Source

pub fn get_partition_keys(&self) -> &Option<Vec<Column>>

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": \[\]

Source

pub fn view_original_text(self, input: impl Into<String>) -> Self

Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.

Source

pub fn set_view_original_text(self, input: Option<String>) -> Self

Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.

Source

pub fn get_view_original_text(&self) -> &Option<String>

Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.

Source

pub fn view_expanded_text(self, input: impl Into<String>) -> Self

Included for Apache Hive compatibility. Not used in the normal course of Glue operations.

Source

pub fn set_view_expanded_text(self, input: Option<String>) -> Self

Included for Apache Hive compatibility. Not used in the normal course of Glue operations.

Source

pub fn get_view_expanded_text(&self) -> &Option<String>

Included for Apache Hive compatibility. Not used in the normal course of Glue operations.

Source

pub fn table_type(self, input: impl Into<String>) -> Self

The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.

Glue related table types:

EXTERNAL_TABLE

Hive compatible attribute - indicates a non-Hive managed table.

GOVERNED

Used by Lake Formation. The Glue Data Catalog understands GOVERNED.

Source

pub fn set_table_type(self, input: Option<String>) -> Self

The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.

Glue related table types:

EXTERNAL_TABLE

Hive compatible attribute - indicates a non-Hive managed table.

GOVERNED

Used by Lake Formation. The Glue Data Catalog understands GOVERNED.

Source

pub fn get_table_type(&self) -> &Option<String>

The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.

Glue related table types:

EXTERNAL_TABLE

Hive compatible attribute - indicates a non-Hive managed table.

GOVERNED

Used by Lake Formation. The Glue Data Catalog understands GOVERNED.

Source

pub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

These key-value pairs define properties associated with the table.

Source

pub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self

These key-value pairs define properties associated with the table.

Source

pub fn get_parameters(&self) -> &Option<HashMap<String, String>>

These key-value pairs define properties associated with the table.

Source

pub fn created_by(self, input: impl Into<String>) -> Self

The person or entity who created the table.

Source

pub fn set_created_by(self, input: Option<String>) -> Self

The person or entity who created the table.

Source

pub fn get_created_by(&self) -> &Option<String>

The person or entity who created the table.

Source

pub fn is_registered_with_lake_formation(self, input: bool) -> Self

Indicates whether the table has been registered with Lake Formation.

Source

pub fn set_is_registered_with_lake_formation(self, input: Option<bool>) -> Self

Indicates whether the table has been registered with Lake Formation.

Source

pub fn get_is_registered_with_lake_formation(&self) -> &Option<bool>

Indicates whether the table has been registered with Lake Formation.

Source

pub fn target_table(self, input: TableIdentifier) -> Self

A TableIdentifier structure that describes a target table for resource linking.

Source

pub fn set_target_table(self, input: Option<TableIdentifier>) -> Self

A TableIdentifier structure that describes a target table for resource linking.

Source

pub fn get_target_table(&self) -> &Option<TableIdentifier>

A TableIdentifier structure that describes a target table for resource linking.

Source

pub fn catalog_id(self, input: impl Into<String>) -> Self

The ID of the Data Catalog in which the table resides.

Source

pub fn set_catalog_id(self, input: Option<String>) -> Self

The ID of the Data Catalog in which the table resides.

Source

pub fn get_catalog_id(&self) -> &Option<String>

The ID of the Data Catalog in which the table resides.

Source

pub fn version_id(self, input: impl Into<String>) -> Self

The ID of the table version.

Source

pub fn set_version_id(self, input: Option<String>) -> Self

The ID of the table version.

Source

pub fn get_version_id(&self) -> &Option<String>

The ID of the table version.

Source

pub fn federated_table(self, input: FederatedTable) -> Self

A FederatedTable structure that references an entity outside the Glue Data Catalog.

Source

pub fn set_federated_table(self, input: Option<FederatedTable>) -> Self

A FederatedTable structure that references an entity outside the Glue Data Catalog.

Source

pub fn get_federated_table(&self) -> &Option<FederatedTable>

A FederatedTable structure that references an entity outside the Glue Data Catalog.

Source

pub fn view_definition(self, input: ViewDefinition) -> Self

A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.

Source

pub fn set_view_definition(self, input: Option<ViewDefinition>) -> Self

A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.

Source

pub fn get_view_definition(&self) -> &Option<ViewDefinition>

A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.

Source

pub fn is_multi_dialect_view(self, input: bool) -> Self

Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.

Source

pub fn set_is_multi_dialect_view(self, input: Option<bool>) -> Self

Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.

Source

pub fn get_is_multi_dialect_view(&self) -> &Option<bool>

Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.

Source

pub fn is_materialized_view(self, input: bool) -> Self

Indicates a table is a MaterializedView.

Source

pub fn set_is_materialized_view(self, input: Option<bool>) -> Self

Indicates a table is a MaterializedView.

Source

pub fn get_is_materialized_view(&self) -> &Option<bool>

Indicates a table is a MaterializedView.

Source

pub fn iceberg_table_metadata(self, input: IcebergTableMetadata) -> Self

The latest Apache Iceberg table metadata for the table, including format version, schemas, partition specifications, and sort orders. This field is populated for Iceberg tables and reflects the current state of the table's Iceberg metadata.

Source

pub fn set_iceberg_table_metadata( self, input: Option<IcebergTableMetadata>, ) -> Self

The latest Apache Iceberg table metadata for the table, including format version, schemas, partition specifications, and sort orders. This field is populated for Iceberg tables and reflects the current state of the table's Iceberg metadata.

Source

pub fn get_iceberg_table_metadata(&self) -> &Option<IcebergTableMetadata>

The latest Apache Iceberg table metadata for the table, including format version, schemas, partition specifications, and sort orders. This field is populated for Iceberg tables and reflects the current state of the table's Iceberg metadata.

Source

pub fn status(self, input: TableStatus) -> Self

Indicates the the state of an asynchronous change to a table.

Source

pub fn set_status(self, input: Option<TableStatus>) -> Self

Indicates the the state of an asynchronous change to a table.

Source

pub fn get_status(&self) -> &Option<TableStatus>

Indicates the the state of an asynchronous change to a table.

Source

pub fn build(self) -> Result<Table, BuildError>

Consumes the builder and constructs a Table. This method will fail if any of the following fields are not set:

Trait Implementations§

Source§

impl Clone for TableBuilder

Source§

fn clone(&self) -> TableBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TableBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for TableBuilder

Source§

fn default() -> TableBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for TableBuilder

Source§

fn eq(&self, other: &TableBuilder) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TableBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more