Struct RESTCatalog 

pub struct RESTCatalog { /* private fields */ }

REST catalog implementation.

This catalog communicates with a Paimon REST catalog server for all metadata operations (database and table CRUD).

Corresponds to Python RESTCatalog in pypaimon/catalog/rest/rest_catalog.py.

Implementations

impl RESTCatalog

pub async fn new(options: Options, config_required: bool) -> Result<Self>

Create a new REST catalog.

Arguments

• options - Configuration options containing URI, warehouse, etc.
• config_required - Whether to fetch config from server and merge with options.

Errors

Returns an error if required options are missing or if initialization fails.

pub fn warehouse(&self) -> &str

Get the warehouse path.

pub fn options(&self) -> &Options

Get the catalog options.

pub fn data_token_enabled(&self) -> bool

Whether data token is enabled.

pub async fn list_databases_paged( &self, max_results: Option<u32>, page_token: Option<&str>, database_name_pattern: Option<&str>, ) -> Result<PagedList<String>>

List databases with pagination.

Trait Implementations

impl Catalog for RESTCatalog

fn list_databases<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>

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

List names of all databases in this catalog.

fn create_database<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ignore_if_exists: bool, properties: HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Create a database.

fn get_database<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Database>> + Send + 'async_trait>>

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

Get a database by name.

fn drop_database<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ignore_if_not_exists: bool, cascade: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Drop a database.

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

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

Get table metadata for the given identifier.

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

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

List table names in a database. System tables are not listed.

fn create_table<'life0, 'life1, 'async_trait>( &'life0 self, identifier: &'life1 Identifier, creation: Schema, ignore_if_exists: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Create a table.

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

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

Drop a table. System tables cannot be dropped.

fn rename_table<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Identifier, to: &'life2 Identifier, ignore_if_not_exists: bool, ) -> 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.

fn alter_table<'life0, 'life1, 'async_trait>( &'life0 self, identifier: &'life1 Identifier, changes: Vec<SchemaChange>, ignore_if_not_exists: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Apply schema changes to a table.

fn create_view<'life0, 'life1, 'async_trait>( &'life0 self, identifier: &'life1 Identifier, schema: ViewSchema, ignore_if_exists: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Create a persistent view.

fn list_views<'life0, 'life1, 'async_trait>( &'life0 self, database_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>

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

List persistent view names in a database.

fn get_view<'life0, 'life1, 'async_trait>( &'life0 self, identifier: &'life1 Identifier, ) -> Pin<Box<dyn Future<Output = Result<View>> + Send + 'async_trait>>

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

Get a persistent view by identifier.

fn drop_view<'life0, 'life1, 'async_trait>( &'life0 self, identifier: &'life1 Identifier, ignore_if_not_exists: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Drop a persistent view.

fn list_functions<'life0, 'life1, 'async_trait>( &'life0 self, database_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>

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

List persistent function names in a database.

fn create_function<'life0, 'life1, 'async_trait>( &'life0 self, function: &'life1 Function, ignore_if_exists: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Create a persistent function.

fn get_function<'life0, 'life1, 'async_trait>( &'life0 self, identifier: &'life1 Identifier, ) -> Pin<Box<dyn Future<Output = Result<Function>> + Send + 'async_trait>>

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

Get a persistent function by identifier.

fn list_partitions<'life0, 'life1, 'async_trait>( &'life0 self, identifier: &'life1 Identifier, ) -> Pin<Box<dyn Future<Output = Result<Vec<Partition>>> + Send + 'async_trait>>

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

List partitions for a table.

fn list_partitions_paged<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, identifier: &'life1 Identifier, max_results: Option<u32>, page_token: Option<&'life2 str>, ) -> Pin<Box<dyn Future<Output = Result<PagedList<Partition>>> + Send + 'async_trait>>

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

Like Self::list_partitions but paged. Default impl ignores max_results and page_token, returning all partitions in a single page. Catalogs that need true pagination (e.g. RESTCatalog) override this.