Struct FileSystemCatalog 

pub struct FileSystemCatalog { /* private fields */ }

Filesystem catalog implementation.

This catalog stores metadata on a filesystem with the following structure:

warehouse/
  ├── database1.db/
  │   ├── table1/
  │   │   └── schema/
  │   │       ├── schema-0
  │   │       ├── schema-1
  │   │       └── ...
  │   └── table2/
  │       └── schema/
  │           ├── schema-0
  │           └── ...
  └── database2.db/
      └── ...

Reference: org.apache.paimon.catalog.FileSystemCatalog

Implementations

impl FileSystemCatalog

pub fn new(options: Options) -> Result<Self>

Create a new filesystem catalog from configuration options.

Arguments

• options - Configuration options containing warehouse path and storage configs (S3, OSS, etc.)

Required Options

• warehouse - The root warehouse path (e.g., /path/to/warehouse, s3://bucket/warehouse)

Example

use paimon::{FileSystemCatalog, Options, CatalogOptions};

// Local filesystem
let mut options = Options::new();
options.set(CatalogOptions::WAREHOUSE, "/tmp/warehouse");
let catalog = FileSystemCatalog::new(options)?;

// S3 with credentials
let mut options = Options::new();
options.set(CatalogOptions::WAREHOUSE, "s3://bucket/warehouse");
options.set("s3.access-key-id", "...");
options.set("s3.secret-access-key", "...");
let catalog = FileSystemCatalog::new(options)?;

pub fn warehouse(&self) -> &str

Get the warehouse path.

pub fn file_io(&self) -> &FileIO

Get the FileIO instance.

Trait Implementations

impl Catalog for FileSystemCatalog

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 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_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 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 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 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.

impl Clone for FileSystemCatalog

fn clone(&self) -> FileSystemCatalog

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileSystemCatalog

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

Formats the value using the given formatter.