9个版本
| 新版本 0.5.7 | 2024年8月18日 |
|---|---|
| 0.5.6 | 2024年8月7日 |
| 0.5.1 | 2024年7月12日 |
| 0.4.0 | 2024年6月3日 |
#1 在 #iceberg
614 每月下载量
130KB
2.5K SLoC
Rust API客户端为iceberg-rest-catalog
定义了REST目录API的第一版本的规范。实现应理想地支持Iceberg表规范v1和v2，优先考虑v2。
概述
此API客户端由OpenAPI Generator项目生成。通过使用来自远程服务器的openapi-spec，您可以轻松生成API客户端。
- API版本：0.0.1
- 包版本：0.0.1
- 生成器版本：7.6.0-SNAPSHOT
- 构建包：
org.openapitools.codegen.languages.RustClientCodegen
安装
将包放在名为iceberg-rest-catalog的目录下，并在[dependencies]下的Cargo.toml中添加以下内容
iceberg-rest-catalog = { path = "./iceberg-rest-catalog" }
API端点文档
所有URI相对于https://127.0.0.1
| 类 | 方法 | HTTP请求 | 描述 |
|---|---|---|---|
| CatalogApiApi | commit_transaction | POST /v1/{prefix}/transactions/commit | 通过原子操作提交多个表的更新 |
| CatalogApiApi | create_namespace | POST /v1/{prefix}/namespaces | 创建一个命名空间 |
| CatalogApiApi | create_table | POST /v1/{prefix}/namespaces/{namespace}/tables | 在给定的命名空间中创建一个表 |
| CatalogApiApi | create_view | POST /v1/{prefix}/namespaces/{namespace}/views | 在给定的命名空间中创建一个视图 |
| CatalogApiApi | drop_namespace | DELETE /v1/{prefix}/namespaces/{namespace} | 从目录中删除一个命名空间。命名空间必须为空。 |
| CatalogApiApi | drop_table | DELETE /v1/{prefix}/namespaces/{namespace}/tables/{table} | 从目录中删除一个表 |
| CatalogApiApi | drop_view | DELETE /v1/{prefix}/namespaces/{namespace}/views/{view} | 从目录中删除一个视图 |
| CatalogApiApi | list_namespaces | GET /v1/{prefix}/namespaces | 列出命名空间，可选地提供父命名空间以列出其下的命名空间 |
| CatalogApiApi | list_tables | GET /v1/{prefix}/namespaces/{namespace}/tables | 列出给定命名空间下的所有表标识符 |
| CatalogApiApi | list_views | GET /v1/{prefix}/namespaces/{namespace}/views | 列出给定命名空间下的所有视图标识符 |
| CatalogApiApi | load_namespace_metadata | GET /v1/{prefix}/namespaces/{namespace} | 加载命名空间的元数据属性 |
| CatalogApiApi | load_table | GET /v1/{prefix}/namespaces/{namespace}/tables/{table} | 从目录中加载表 |
| CatalogApiApi | load_view | GET /v1/{prefix}/namespaces/{namespace}/views/{view} | 从目录中加载视图 |
| CatalogApiApi | namespace_exists | HEAD /v1/{prefix}/namespaces/{namespace} | 检查命名空间是否存在 |
| CatalogApiApi | register_table | POST /v1/{prefix}/namespaces/{namespace}/register | 使用给定的元数据文件位置在指定命名空间中注册表 |
| CatalogApiApi | rename_table | POST /v1/{prefix}/tables/rename | 将表从当前名称重命名为新名称 |
| CatalogApiApi | rename_view | POST /v1/{prefix}/views/rename | 将视图从当前名称重命名为新名称 |
| CatalogApiApi | replace_view | POST /v1/{prefix}/namespaces/{namespace}/views/{view} | 替换视图 |
| 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} | 提交表更新 |
| CatalogApiApi | view_exists | HEAD /v1/{prefix}/namespaces/{namespace}/views/{view} | 检查视图是否存在 |
| ConfigurationApiApi | get_config | GET /v1/config | 列出所有目录配置设置 |
| OAuth2ApiApi | get_token | POST /v1/oauth/tokens | 使用OAuth2流程获取令牌 |
模型文档
- AddPartitionSpecUpdate
- AddSchemaUpdate
- AddSnapshotUpdate
- AddSortOrderUpdate
- AddViewVersionUpdate
- AndOrExpression
- AssertCreate
- AssertCurrentSchemaId
- AssertDefaultSortOrderId
- AssertDefaultSpecId
- AssertLastAssignedFieldId
- AssertLastAssignedPartitionId
- AssertRefSnapshotId
- AssertTableUuid
- AssertViewUuid
- AssignUuidUpdate
- BaseUpdate
- BlobMetadata
- CatalogConfig
- CommitReport
- CommitTableRequest
- CommitTableResponse
- CommitTransactionRequest
- CommitViewRequest
- ContentFile
- CountMap
- CounterResult
- CreateNamespaceRequest
- CreateNamespaceResponse
- CreateTableRequest
- CreateViewRequest
- DataFile
- EqualityDeleteFile
- ErrorModel
- Expression
- FileFormat
- GetNamespaceResponse
- IcebergErrorResponse
- ListNamespacesResponse
- ListTablesResponse
- ListType
- LiteralExpression
- LoadTableResult
- LoadViewResult
- MapType
- MetadataLogInner
- MetricResult
- NotExpression
- NullOrder
- OAuthError
- OAuthTokenResponse
- PartitionField
- PartitionSpec
- PartitionStatisticsFile
- PositionDeleteFile
- PrimitiveTypeValue
- RegisterTableRequest
- RemovePartitionStatisticsUpdate
- RemovePropertiesUpdate
- RemoveSnapshotRefUpdate
- RemoveSnapshotsUpdate
- RemoveStatisticsUpdate
- RenameTableRequest
- ReportMetricsRequest
- ScanReport
- Schema
- SetCurrentSchemaUpdate
- SetCurrentViewVersionUpdate
- SetDefaultSortOrderUpdate
- SetDefaultSpecUpdate
- SetExpression
- SetLocationUpdate
- SetPartitionStatisticsUpdate
- SetPropertiesUpdate
- SetSnapshotRefUpdate
- SetStatisticsUpdate
- Snapshot
- SnapshotLogInner
- SnapshotReference
- SnapshotSummary
- SortDirection
- SortField
- SortOrder
- SqlViewRepresentation
- StatisticsFile
- StructField
- StructType
- TableIdentifier
- TableMetadata
- TableRequirement
- TableUpdate
- Term
- TimerResult
- TokenType
- TransformTerm
- Type
- UnaryExpression
- UpdateNamespacePropertiesRequest
- UpdateNamespacePropertiesResponse
- UpgradeFormatVersionUpdate
- ValueMap
- ViewHistoryEntry
- ViewMetadata
- ViewRepresentation
- ViewRequirement
- ViewUpdate
- 查看版本
要获取crate生成的文档，请使用
cargo doc --open
作者
依赖项
~40–55MB
~1M SLoC