Struct RestCatalog

pub struct RestCatalog { /* private fields */ }

Rest catalog implementation.

Implementations

impl RestCatalog

pub fn with_file_io_extension<T: Any + Send + Sync>(self, ext: T) -> Self

Add an extension to the file IO builder.

pub async fn invalidate_token(&self) -> Result<()>

Invalidate the current token without generating a new one. On the next request, the client will attempt to generate a new token.

pub async fn regenerate_token(&self) -> Result<()>

Invalidate the current token and set a new one. Generates a new token before invalidating the current token, meaning the old token will be used until this function acquires the lock and overwrites the token.

If credential is invalid, or the request fails, this method will return an error and leave the current token unchanged.

Trait Implementations

impl Catalog for RestCatalog

All requests and expected responses are derived from the REST catalog API spec: https://github.com/apache/iceberg/blob/main/open-api/rest-catalog-open-api.yaml

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,

Create a new table inside the namespace.

In the resulting table, if there are any config properties that are present in both the response from the REST server and the config provided when creating this RestCatalog instance then the value provided locally to the RestCatalog will take precedence.

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,

Load table from the catalog.

If there are any config properties that are present in both the response from the REST server and the config provided when creating this RestCatalog instance, then the value provided locally to the RestCatalog will take precedence.

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,

Drop a table from the catalog.

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,

Check if a table exists in the catalog.

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,

Rename a table in the catalog.

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 inside the catalog.

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,

Create a new namespace inside the catalog.

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,

Get a namespace information from the catalog.

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

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

Check if namespace exists in catalog.

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,

Update a namespace inside the catalog.

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,

Drop a namespace from the catalog, or returns error if it doesn’t exist.

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,

List tables from namespace.

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

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

Register an existing table to the catalog.

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 RestCatalog

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

Formats the value using the given formatter.