Crate iceberg_catalog_rest

Iceberg REST API implementation.

To build a rest catalog with configurations

Example

use std::collections::HashMap;

use iceberg::CatalogBuilder;
use iceberg_catalog_rest::{
    REST_CATALOG_PROP_URI, REST_CATALOG_PROP_WAREHOUSE, RestCatalogBuilder,
};

#[tokio::main]
async fn main() {
    let catalog = RestCatalogBuilder::default()
        .load(
            "rest",
            HashMap::from([
                (
                    REST_CATALOG_PROP_URI.to_string(),
                    "http://localhost:8181".to_string(),
                ),
                (
                    REST_CATALOG_PROP_WAREHOUSE.to_string(),
                    "s3://warehouse".to_string(),
                ),
            ]),
        )
        .await
        .unwrap();
}

Structs

CommitTableRequest

Request to commit updates to a table.

CommitTableResponse

Response returned when a table is successfully updated.

CreateNamespaceRequest

Create namespace request

CreateTableRequest

Request to create a new table in a namespace.

ErrorModel

Error payload returned in a response with further details on the error

ErrorResponse

Wrapper for all non-2xx error responses from the REST API

ListNamespaceResponse

Response containing a list of namespace identifiers, with optional pagination support.

ListTablesResponse

Response containing a list of table identifiers, with optional pagination support.

LoadTableResult

Result returned when a table is successfully loaded or created.

NamespaceResponse

Namespace response

RegisterTableRequest

Request to register a table using an existing metadata file location.

RenameTableRequest

Request to rename a table from one identifier to another.

RestCatalog

Rest catalog implementation.

RestCatalogBuilder

Builder for RestCatalog.

StorageCredential

Storage credential for a specific location prefix.

UpdateNamespacePropertiesRequest

Request to update properties on a namespace.

UpdateNamespacePropertiesResponse

Response from updating namespace properties, indicating which properties were changed.

Constants

REST_CATALOG_PROP_URI

REST catalog URI

REST_CATALOG_PROP_WAREHOUSE

REST catalog warehouse location