Struct Catalog 

pub struct Catalog { /* private fields */ }

Reads database, schema, table, and view definitions.

Select the smallest resource you need, then call CatalogResource::get. Each read returns the complete definition and an ETag for conditional changes.

let snapshot = client.catalog().schema("scopedb", "public").get().await?;
for table in snapshot.definition.tables {
    println!("{}: {} columns", table.name, table.columns.len());
}

Use CatalogResource::apply to change a definition and CatalogResource::delete to remove a resource. Both support previews and ETag preconditions through CatalogOptions.

Implementations

impl Catalog

pub async fn get(&self) -> Result<CatalogSnapshot<CatalogDocument>, Error>

Examples found in repository

examples/catalog.rs (line 23)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = common::client()?;
    let database = common::database();
    let schema = common::schema();

    let catalog = client.catalog().get().await?;
    for item in catalog.definition.databases {
        println!(
            "database {}: {}",
            item.name,
            item.comment.unwrap_or_default()
        );
    }
    let snapshot = client.catalog().schema(&database, &schema).get().await?;
    println!("schema ETag: {}", snapshot.etag);
    for table in snapshot.definition.tables {
        println!("table {}: {:?}", table.name, table.columns);
    }
    Ok(())
}

pub async fn apply( &self, definition: &CatalogDocument, options: CatalogOptions, ) -> Result<CatalogResult<CatalogDocument>, Error>

Replaces the complete tenant catalog. An empty document clears it.

pub fn raw(&self) -> CatalogResource<Value>

Retains fields unknown to this SDK when reading and applying definitions.

pub fn database(&self, database: &str) -> CatalogResource<CatalogDatabase>

pub fn schema( &self, database: &str, schema: &str, ) -> CatalogResource<CatalogSchema>

Examples found in repository

examples/catalog.rs (line 31)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = common::client()?;
    let database = common::database();
    let schema = common::schema();

    let catalog = client.catalog().get().await?;
    for item in catalog.definition.databases {
        println!(
            "database {}: {}",
            item.name,
            item.comment.unwrap_or_default()
        );
    }
    let snapshot = client.catalog().schema(&database, &schema).get().await?;
    println!("schema ETag: {}", snapshot.etag);
    for table in snapshot.definition.tables {
        println!("table {}: {:?}", table.name, table.columns);
    }
    Ok(())
}

pub fn table( &self, database: &str, schema: &str, table: &str, ) -> CatalogResource<CatalogTable>

pub fn view( &self, database: &str, schema: &str, view: &str, ) -> CatalogResource<CatalogView>

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.