Struct S3TablesCatalog

pub struct S3TablesCatalog { /* private fields */ }

S3Tables catalog implementation.

Implementations

impl S3TablesCatalog

pub async fn new(config: S3TablesCatalogConfig) -> Result<Self>

Creates a new S3Tables catalog.

Trait Implementations

impl Catalog for S3TablesCatalog

fn list_namespaces<'life0, 'life1, 'async_trait>( &'life0 self, parent: Option<&'life1 NamespaceIdent>, ) -> Pin<Box<dyn Future<Output = Result<Vec<NamespaceIdent>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List namespaces from s3tables catalog.

S3Tables doesn’t support nested namespaces. If parent is provided, it will return an empty list.

fn create_namespace<'life0, 'life1, 'async_trait>( &'life0 self, namespace: &'life1 NamespaceIdent, _properties: HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<Namespace>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates a new namespace with the given identifier and properties.

Attempts to create a namespace defined by the namespace. The properties parameter is ignored.

The following naming rules apply to namespaces:

• Names must be between 3 (min) and 63 (max) characters long.
• Names can consist only of lowercase letters, numbers, and underscores (_).
• Names must begin and end with a letter or number.
• Names must not contain hyphens (-) or periods (.).

This function can return an error in the following situations:

• Errors from the underlying database creation process, converted using from_aws_sdk_error.

fn get_namespace<'life0, 'life1, 'async_trait>( &'life0 self, namespace: &'life1 NamespaceIdent, ) -> Pin<Box<dyn Future<Output = Result<Namespace>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves a namespace by its identifier.

Validates the given namespace identifier and then queries the underlying database client to fetch the corresponding namespace data. Constructs a Namespace object with the retrieved data and returns it.

This function can return an error in any of the following situations:

• If there is an error querying the database, returned by from_aws_sdk_error.

fn namespace_exists<'life0, 'life1, 'async_trait>( &'life0 self, namespace: &'life1 NamespaceIdent, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Checks if a namespace exists within the s3tables catalog.

Validates the namespace identifier by querying the s3tables catalog to determine if the specified namespace exists.

Returns

A Result<bool> indicating the outcome of the check:

• Ok(true) if the namespace exists.
• Ok(false) if the namespace does not exist, identified by a specific IsNotFoundException variant.
• Err(...) if an error occurs during validation or the s3tables catalog query, with the error encapsulating the issue.

fn update_namespace<'life0, 'life1, 'async_trait>( &'life0 self, _namespace: &'life1 NamespaceIdent, _properties: HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Updates the properties of an existing namespace.

S3Tables doesn’t support updating namespace properties, so this function will always return an error.

fn drop_namespace<'life0, 'life1, 'async_trait>( &'life0 self, namespace: &'life1 NamespaceIdent, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Drops an existing namespace from the s3tables catalog.

Validates the namespace identifier and then deletes the corresponding namespace from the s3tables catalog.

This function can return an error in the following situations:

• Errors from the underlying database deletion process, converted using from_aws_sdk_error.

fn list_tables<'life0, 'life1, 'async_trait>( &'life0 self, namespace: &'life1 NamespaceIdent, ) -> Pin<Box<dyn Future<Output = Result<Vec<TableIdent>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Lists all tables within a given namespace.

Retrieves all tables associated with the specified namespace and returns their identifiers.

This function can return an error in the following situations:

• Errors from the underlying database query process, converted using from_aws_sdk_error.

fn create_table<'life0, 'life1, 'async_trait>( &'life0 self, namespace: &'life1 NamespaceIdent, creation: TableCreation, ) -> Pin<Box<dyn Future<Output = Result<Table>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates a new table within a specified namespace.

Attempts to create a table defined by the creation parameter. The metadata location is generated by the s3tables catalog, looks like:

s3://{RANDOM WAREHOUSE LOCATION}/metadata/{VERSION}-{UUID}.metadata.json

We have to get this random warehouse location after the table is created.

This function can return an error in the following situations:

• If the location of the table is set by user, identified by a specific DataInvalid variant.
• Errors from the underlying database creation process, converted using from_aws_sdk_error.

fn load_table<'life0, 'life1, 'async_trait>( &'life0 self, table_ident: &'life1 TableIdent, ) -> Pin<Box<dyn Future<Output = Result<Table>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Loads an existing table from the s3tables catalog.

Retrieves the metadata location of the specified table and constructs a Table object with the retrieved metadata.

This function can return an error in the following situations:

• If the table does not have a metadata location, identified by a specific Unexpected variant.
• Errors from the underlying database query process, converted using from_aws_sdk_error.

fn drop_table<'life0, 'life1, 'async_trait>( &'life0 self, table: &'life1 TableIdent, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Drops an existing table from the s3tables catalog.

Validates the table identifier and then deletes the corresponding table from the s3tables catalog.

This function can return an error in the following situations:

• Errors from the underlying database deletion process, converted using from_aws_sdk_error.

fn table_exists<'life0, 'life1, 'async_trait>( &'life0 self, table_ident: &'life1 TableIdent, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Checks if a table exists within the s3tables catalog.

Validates the table identifier by querying the s3tables catalog to determine if the specified table exists.

Returns

A Result<bool> indicating the outcome of the check:

• Ok(true) if the table exists.
• Ok(false) if the table does not exist, identified by a specific IsNotFoundException variant.
• Err(...) if an error occurs during validation or the s3tables catalog query, with the error encapsulating the issue.

fn rename_table<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, src: &'life1 TableIdent, dest: &'life2 TableIdent, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Renames an existing table within the s3tables catalog.

Validates the source and destination table identifiers and then renames the source table to the destination table.

This function can return an error in the following situations:

• Errors from the underlying database renaming process, converted using from_aws_sdk_error.

fn update_table<'life0, 'async_trait>( &'life0 self, _commit: TableCommit, ) -> Pin<Box<dyn Future<Output = Result<Table>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates an existing table within the s3tables catalog.

This function is still in development and will always return an error.

impl Debug for S3TablesCatalog

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

Formats the value using the given formatter.