| 0.0.1 |
|
|---|
#16 in #iceberg
175KB
3K SLoC
Rust API 客户端用于 Iceberg REST 目录 API
定义了 REST 目录 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流程获取令牌 |
模型文档
- AddPartitionSpecUpdate
- AddPartitionSpecUpdateAllOf
- AddSchemaUpdate
- AddSchemaUpdateAllOf
- AddSnapshotUpdate
- AddSnapshotUpdateAllOf
- AddSortOrderUpdate
- AddSortOrderUpdateAllOf
- AndOrExpression
- BaseUpdate
- CatalogConfig
- CommitTableRequest
- CounterResult
- CreateNamespace200Response
- CreateNamespaceRequest
- CreateTableRequest
- ErrorModel
- Expression
- GetToken200Response
- GetToken400Response
- ListNamespaces200Response
- ListTables200Response
- ListType
- LiteralExpression
- LoadNamespaceMetadata200Response
- LoadTableResult
- MapType
- MetadataLogInner
- MetricResult
- NotExpression
- NullOrder
- PartitionField
- PartitionSpec
- RemovePropertiesUpdate
- RemovePropertiesUpdateAllOf
- RemoveSnapshotRefUpdate
- RemoveSnapshotsUpdate
- RemoveSnapshotsUpdateAllOf
- RenameTableRequest
- ReportMetricsRequest
- ScanReport
- Schema
- SchemaAllOf
- SetCurrentSchemaUpdate
- SetCurrentSchemaUpdateAllOf
- SetDefaultSortOrderUpdate
- SetDefaultSortOrderUpdateAllOf
- SetDefaultSpecUpdate
- SetDefaultSpecUpdateAllOf
- SetExpression
- SetLocationUpdate
- SetLocationUpdateAllOf
- SetPropertiesUpdate
- SetPropertiesUpdateAllOf
- SetSnapshotRefUpdate
- SetSnapshotRefUpdateAllOf
- Snapshot
- SnapshotLogInner
- SnapshotReference
- SnapshotSummary
- SortDirection
- SortField
- SortOrder
- StructField
- StructType
- TableIdentifier
- TableMetadata
- TableRequirement
- TableUpdate
- Term
- TimerResult
- TokenType
- TransformTerm
- Type
- UnaryExpression
- UpdateNamespacePropertiesRequest
- UpdateProperties200Response
- UpdateTable200Response
- UpgradeFormatVersionUpdate
- UpgradeFormatVersionUpdateAllOf
要获取crate生成的文档，请使用
cargo doc --open
作者
依赖
~4–19MB
~255K SLoC