Struct iceberg_catalog_hms::HmsCatalog

pub struct HmsCatalog { /* private fields */ }

Hive metastore Catalog.

Implementations

impl HmsCatalog

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

Create a new hms catalog.

pub fn file_io(&self) -> FileIO

Get the catalogs FileIO

Trait Implementations

impl Catalog for HmsCatalog

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,

HMS doesn’t support nested namespaces.

We will return empty list if parent is some.

Align with java implementation: https://github.com/apache/iceberg/blob/9bd62f79f8cd973c39d14e89163cb1c707470ed2/hive-metastore/src/main/java/org/apache/iceberg/hive/HiveCatalog.java#L305C26-L330

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 parameter and configured with the specified properties.

This function can return an error in the following situations:

• If hive.metastore.database.owner-type is specified without
  hive.metastore.database.owner,
• Errors from validate_namespace if the namespace identifier does not meet validation criteria.
• Errors from convert_to_database if the properties cannot be
  successfully converted into a database configuration.
• Errors from the underlying database creation process, converted using from_thrift_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 the provided namespace identifier fails validation checks
• If there is an error querying the database, returned by from_thrift_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 Hive Metastore.

Validates the namespace identifier by querying the Hive Metastore to determine if the specified namespace (database) 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 UserException variant.
• Err(...) if an error occurs during validation or the Hive Metastore 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,

Asynchronously updates properties of an existing namespace.

Converts the given namespace identifier and properties into a database representation and then attempts to update the corresponding namespace
in the Hive Metastore.

Returns

Returns Ok(()) if the namespace update is successful. If the namespace cannot be updated due to missing information or an error during the update process, an Err(...) is returned.

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,

Asynchronously drops a namespace from the Hive Metastore.

Returns

A Result<()> indicating the outcome:

• Ok(()) signifies successful namespace deletion.
• Err(...) signifies failure to drop the namespace due to validation
  errors, connectivity issues, or Hive Metastore constraints.

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,

Asynchronously lists all tables within a specified namespace.

Returns

A Result<Vec<TableIdent>>, which is:

• Ok(vec![...]) containing a vector of TableIdent instances, each representing a table within the specified namespace.
• Err(...) if an error occurs during namespace validation or while
  querying the database.

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 using the provided table creation settings.

Returns

A Result wrapping a Table object representing the newly created table.

Errors

This function may return an error in several cases, including invalid namespace identifiers, failure to determine a default storage location, issues generating or writing table metadata, and errors communicating with the Hive Metastore.

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

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

Loads a table from the Hive Metastore and constructs a Table object based on its metadata.

Returns

A Result wrapping a Table object that represents the loaded table.

Errors

This function may return an error in several scenarios, including:

• Failure to validate the namespace.
• Failure to retrieve the table from the Hive Metastore.
• Absence of metadata location information in the table’s properties.
• Issues reading or deserializing the table’s metadata file.

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,

Asynchronously drops a table from the database.

Errors

Returns an error if:

• The namespace provided in table cannot be validated or does not exist.
• The underlying database client encounters an error while attempting to drop the table. This includes scenarios where the table does not exist.
• Any network or communication error occurs with the database backend.

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

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

Asynchronously checks the existence of a specified table in the database.

Returns

• Ok(true) if the table exists in the database.
• Ok(false) if the table does not exist in the database.
• Err(...) if an error occurs during the process

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,

Asynchronously renames a table within the database or moves it between namespaces (databases).

Returns

• Ok(()) on successful rename or move of the table.
• Err(...) if an error occurs during the process.

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,

Update a table to the catalog.

impl Debug for HmsCatalog

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

Formats the value using the given formatter.