#table #client #catalog #rest-client #iceberg #version #api-client

iceberg_catalog_rest_client

定义了Iceberg REST Catalog API的第一个版本的规范。实现应理想地支持Iceberg表规范v1和v2,优先考虑v2。

1个不稳定版本

0.0.1 2022年11月7日

#15#iceberg

Apache-2.0

175KB
3K SLoC

Rust API客户端,用于Iceberg REST Catalog API

定义了REST Catalog API的第一个版本的规范。实现应理想地支持Iceberg表规范v1和v2,优先考虑v2。

概述

此API客户端是由OpenAPI Generator项目生成的。通过使用远程服务器的openapi-spec,您可以轻松地生成API客户端。

  • API版本:0.0.1
  • 包版本:0.0.1
  • 构建包:org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在您的项目文件夹中名为openapi的目录下,并在Cargo.toml中的[dependencies]下添加以下内容

openapi = { path = "./openapi" }

API端点文档

所有URI均相对于https://127.0.0.1

方法 HTTP请求 描述
CatalogApiApi create_namespace POST /v1/{prefix}/namespaces 创建命名空间
CatalogApiApi create_table POST /v1/{prefix}/namespaces/{namespace}/tables 在给定的命名空间中创建一个表
CatalogApiApi drop_namespace DELETE /v1/{prefix}/namespaces/{namespace} 从目录中删除一个命名空间。命名空间必须为空。
CatalogApiApi drop_table DELETE /v1/{prefix}/namespaces/{namespace}/tables/{table} 从目录中删除一个表
CatalogApiApi list_namespaces GET /v1/{prefix}/namespaces 列出命名空间,可选地提供父命名空间以列出其下方的命名空间
CatalogApiApi list_tables GET /v1/{prefix}/namespaces/{namespace}/tables 列出给定命名空间下方的所有表标识符
CatalogApiApi load_namespace_metadata GET /v1/{prefix}/namespaces/{namespace} 加载命名空间的元数据属性
CatalogApiApi load_table GET /v1/{prefix}/namespaces/{namespace}/tables/{table} 从目录中加载一个表
CatalogApiApi rename_table POST /v1/{prefix}/tables/rename 将表从当前名称重命名为新名称
CatalogApiApi report_metrics POST /v1/{prefix}/namespaces/{namespace}/tables/{table}/metrics 将度量报告发送到该端点以由后端处理
CatalogApiApi table_exists HEAD /v1/{prefix}/namespaces/{namespace}/tables/{table} 检查表是否存在
CatalogApiApi update_properties POST /v1/{prefix}/namespaces/{namespace}/properties 设置或删除命名空间的属性
CatalogApiApi update_table POST /v1/{prefix}/namespaces/{namespace}/tables/{table} 提交表更新的操作
ConfigurationApiApi get_config GET /v1/config 列出所有目录配置设置
OAuth2ApiApi get_token POST /v1/oauth/tokens 使用OAuth2流程获取令牌

模型文档说明

要获取crate生成的文档,请使用

cargo doc --open

作者

依赖关系

~4–17MB
~239K SLoC