#[non_exhaustive]pub struct TableBuilder { /* private fields */ }
Expand description
A builder for Table
.
Implementations§
Source§impl TableBuilder
impl TableBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The table name. For Hive compatibility, this must be entirely lowercase.
This field is required.Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The table name. For Hive compatibility, this must be entirely lowercase.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The table name. For Hive compatibility, this must be entirely lowercase.
Sourcepub fn database_name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_database_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_database_name(&self) -> &Option<String>
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.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the table.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the table.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the table.
Sourcepub fn create_time(self, input: DateTime) -> Self
pub fn create_time(self, input: DateTime) -> Self
The time when the table definition was created in the Data Catalog.
Sourcepub fn set_create_time(self, input: Option<DateTime>) -> Self
pub fn set_create_time(self, input: Option<DateTime>) -> Self
The time when the table definition was created in the Data Catalog.
Sourcepub fn get_create_time(&self) -> &Option<DateTime>
pub fn get_create_time(&self) -> &Option<DateTime>
The time when the table definition was created in the Data Catalog.
Sourcepub fn update_time(self, input: DateTime) -> Self
pub fn update_time(self, input: DateTime) -> Self
The last time that the table was updated.
Sourcepub fn set_update_time(self, input: Option<DateTime>) -> Self
pub fn set_update_time(self, input: Option<DateTime>) -> Self
The last time that the table was updated.
Sourcepub fn get_update_time(&self) -> &Option<DateTime>
pub fn get_update_time(&self) -> &Option<DateTime>
The last time that the table was updated.
Sourcepub fn last_access_time(self, input: DateTime) -> Self
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.
Sourcepub fn set_last_access_time(self, input: Option<DateTime>) -> Self
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.
Sourcepub fn get_last_access_time(&self) -> &Option<DateTime>
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.
Sourcepub fn last_analyzed_time(self, input: DateTime) -> Self
pub fn last_analyzed_time(self, input: DateTime) -> Self
The last time that column statistics were computed for this table.
Sourcepub fn set_last_analyzed_time(self, input: Option<DateTime>) -> Self
pub fn set_last_analyzed_time(self, input: Option<DateTime>) -> Self
The last time that column statistics were computed for this table.
Sourcepub fn get_last_analyzed_time(&self) -> &Option<DateTime>
pub fn get_last_analyzed_time(&self) -> &Option<DateTime>
The last time that column statistics were computed for this table.
Sourcepub fn set_retention(self, input: Option<i32>) -> Self
pub fn set_retention(self, input: Option<i32>) -> Self
The retention time for this table.
Sourcepub fn get_retention(&self) -> &Option<i32>
pub fn get_retention(&self) -> &Option<i32>
The retention time for this table.
Sourcepub fn storage_descriptor(self, input: StorageDescriptor) -> Self
pub fn storage_descriptor(self, input: StorageDescriptor) -> Self
A storage descriptor containing information about the physical storage of this table.
Sourcepub fn set_storage_descriptor(self, input: Option<StorageDescriptor>) -> Self
pub fn set_storage_descriptor(self, input: Option<StorageDescriptor>) -> Self
A storage descriptor containing information about the physical storage of this table.
Sourcepub fn get_storage_descriptor(&self) -> &Option<StorageDescriptor>
pub fn get_storage_descriptor(&self) -> &Option<StorageDescriptor>
A storage descriptor containing information about the physical storage of this table.
Sourcepub fn partition_keys(self, input: Column) -> Self
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": \[\]
Sourcepub fn set_partition_keys(self, input: Option<Vec<Column>>) -> Self
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": \[\]
Sourcepub fn get_partition_keys(&self) -> &Option<Vec<Column>>
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": \[\]
Sourcepub fn view_original_text(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_view_original_text(self, input: Option<String>) -> Self
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.
Sourcepub fn get_view_original_text(&self) -> &Option<String>
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.
Sourcepub fn view_expanded_text(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_view_expanded_text(self, input: Option<String>) -> Self
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.
Sourcepub fn get_view_expanded_text(&self) -> &Option<String>
pub fn get_view_expanded_text(&self) -> &Option<String>
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
Sourcepub fn table_type(self, input: impl Into<String>) -> Self
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
.
Sourcepub fn set_table_type(self, input: Option<String>) -> Self
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
.
Sourcepub fn get_table_type(&self) -> &Option<String>
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
.
Sourcepub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self
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.
Sourcepub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self
These key-value pairs define properties associated with the table.
Sourcepub fn get_parameters(&self) -> &Option<HashMap<String, String>>
pub fn get_parameters(&self) -> &Option<HashMap<String, String>>
These key-value pairs define properties associated with the table.
Sourcepub fn created_by(self, input: impl Into<String>) -> Self
pub fn created_by(self, input: impl Into<String>) -> Self
The person or entity who created the table.
Sourcepub fn set_created_by(self, input: Option<String>) -> Self
pub fn set_created_by(self, input: Option<String>) -> Self
The person or entity who created the table.
Sourcepub fn get_created_by(&self) -> &Option<String>
pub fn get_created_by(&self) -> &Option<String>
The person or entity who created the table.
Sourcepub fn is_registered_with_lake_formation(self, input: bool) -> Self
pub fn is_registered_with_lake_formation(self, input: bool) -> Self
Indicates whether the table has been registered with Lake Formation.
Sourcepub fn set_is_registered_with_lake_formation(self, input: Option<bool>) -> Self
pub fn set_is_registered_with_lake_formation(self, input: Option<bool>) -> Self
Indicates whether the table has been registered with Lake Formation.
Sourcepub fn get_is_registered_with_lake_formation(&self) -> &Option<bool>
pub fn get_is_registered_with_lake_formation(&self) -> &Option<bool>
Indicates whether the table has been registered with Lake Formation.
Sourcepub fn target_table(self, input: TableIdentifier) -> Self
pub fn target_table(self, input: TableIdentifier) -> Self
A TableIdentifier
structure that describes a target table for resource linking.
Sourcepub fn set_target_table(self, input: Option<TableIdentifier>) -> Self
pub fn set_target_table(self, input: Option<TableIdentifier>) -> Self
A TableIdentifier
structure that describes a target table for resource linking.
Sourcepub fn get_target_table(&self) -> &Option<TableIdentifier>
pub fn get_target_table(&self) -> &Option<TableIdentifier>
A TableIdentifier
structure that describes a target table for resource linking.
Sourcepub fn catalog_id(self, input: impl Into<String>) -> Self
pub fn catalog_id(self, input: impl Into<String>) -> Self
The ID of the Data Catalog in which the table resides.
Sourcepub fn set_catalog_id(self, input: Option<String>) -> Self
pub fn set_catalog_id(self, input: Option<String>) -> Self
The ID of the Data Catalog in which the table resides.
Sourcepub fn get_catalog_id(&self) -> &Option<String>
pub fn get_catalog_id(&self) -> &Option<String>
The ID of the Data Catalog in which the table resides.
Sourcepub fn version_id(self, input: impl Into<String>) -> Self
pub fn version_id(self, input: impl Into<String>) -> Self
The ID of the table version.
Sourcepub fn set_version_id(self, input: Option<String>) -> Self
pub fn set_version_id(self, input: Option<String>) -> Self
The ID of the table version.
Sourcepub fn get_version_id(&self) -> &Option<String>
pub fn get_version_id(&self) -> &Option<String>
The ID of the table version.
Sourcepub fn federated_table(self, input: FederatedTable) -> Self
pub fn federated_table(self, input: FederatedTable) -> Self
A FederatedTable
structure that references an entity outside the Glue Data Catalog.
Sourcepub fn set_federated_table(self, input: Option<FederatedTable>) -> Self
pub fn set_federated_table(self, input: Option<FederatedTable>) -> Self
A FederatedTable
structure that references an entity outside the Glue Data Catalog.
Sourcepub fn get_federated_table(&self) -> &Option<FederatedTable>
pub fn get_federated_table(&self) -> &Option<FederatedTable>
A FederatedTable
structure that references an entity outside the Glue Data Catalog.
Sourcepub fn view_definition(self, input: ViewDefinition) -> Self
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.
Sourcepub fn set_view_definition(self, input: Option<ViewDefinition>) -> Self
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.
Sourcepub fn get_view_definition(&self) -> &Option<ViewDefinition>
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.
Sourcepub fn is_multi_dialect_view(self, input: bool) -> Self
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.
Sourcepub fn set_is_multi_dialect_view(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_is_multi_dialect_view(&self) -> &Option<bool>
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.
Sourcepub fn status(self, input: TableStatus) -> Self
pub fn status(self, input: TableStatus) -> Self
A structure containing information about the state of an asynchronous change to a table.
Sourcepub fn set_status(self, input: Option<TableStatus>) -> Self
pub fn set_status(self, input: Option<TableStatus>) -> Self
A structure containing information about the state of an asynchronous change to a table.
Sourcepub fn get_status(&self) -> &Option<TableStatus>
pub fn get_status(&self) -> &Option<TableStatus>
A structure containing information about the state of an asynchronous change to a table.
Trait Implementations§
Source§impl Clone for TableBuilder
impl Clone for TableBuilder
Source§fn clone(&self) -> TableBuilder
fn clone(&self) -> TableBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TableBuilder
impl Debug for TableBuilder
Source§impl Default for TableBuilder
impl Default for TableBuilder
Source§fn default() -> TableBuilder
fn default() -> TableBuilder
Source§impl PartialEq for TableBuilder
impl PartialEq for TableBuilder
impl StructuralPartialEq for TableBuilder
Auto Trait Implementations§
impl Freeze for TableBuilder
impl RefUnwindSafe for TableBuilder
impl Send for TableBuilder
impl Sync for TableBuilder
impl Unpin for TableBuilder
impl UnwindSafe for TableBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);