Lib.rs

› 数据库接口
#connection #update #client #create #state #api-client #airbyte

airbyte_client

Airbyte 客户端是 Airbyte API 的非官方客户端库

由 Airbyte 提供。 所有者 Omid Rad。

5 个不稳定版本

0.41.0 2023年9月27日
0.40.26-1 2023年1月2日
0.40.23-1 2022年12月4日
0.0.2 2022年5月3日
0.0.1 2022年1月5日

#672 在 数据库接口

Download history 5/week @ 2024-03-28 2/week @ 2024-04-04

每月 57 次下载

MIT 许可证

1MB
12K SLoC

Rust API 客户端用于 openapi

Airbyte 配置 API https://airbyte.io。

配置 API 是一个内部 Airbyte API，旨在在不同的 Airbyte 组件之间进行通信。

  • 其主要目的是使 Airbyte 工程团队能够配置 Airbyte Cloud 的内部状态
  • 它有时也由 OSS 用户用于配置自己的自托管 Airbyte 部署（内部状态等）

警告

  • Airbyte 并没有对长期支持此 API 的积极承诺。
  • 开源用户可以使用配置 API，但需自行承担风险。
  • 此 API 是由 Airbyte 工程团队内部使用的，如果需要，将来可能会进行修改。
  • Airbyte 工程团队的修改可能会造成破坏性变更，开源用户需要更新其代码以跟上 API 的任何向后不兼容的更改。

此 API 是一系列 HTTP RPC 风格的方法。虽然它不是一个 REST API，但熟悉 REST 的用户应该会认出此 API 的约定。

以下是此 API 遵循的一些约定

  • 所有端点都是 http POST 方法。
  • 所有端点都通过 application/json 请求体接受数据。API 不接受通过查询参数的数据。
  • 端点的命名约定为：localhost:8000/api/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME}，例如 localhost:8000/api/v1/connections/create。
  • 对于所有 update 方法，必须传递整个对象，即使是未更改的字段。

身份验证（OSS）

  • 当对配置API进行身份验证时，您必须通过设置身份验证头为Basic并使用base64编码用户名和密码（默认情况下为airbyte和password - 因此，base64编码airbyte:password的结果为YWlyYnl0ZTpwYXNzd29yZA==）。因此，完整的头信息为'Authorization': ""Basic YWlyYnl0ZTpwYXNzd29yZA==""

概述

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

  • API版本：1.0.0
  • 包版本：1.0.0
  • 构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在名为openapi的目录下，并在Cargo.toml下的[dependencies]中添加以下内容：

openapi = { path = "./openapi" }

API端点文档

所有URI都是相对于https://127.0.0.1:8000/api的。

类 方法 HTTP请求 描述
AttemptApi 保存统计信息 POST /v1/attempt/save_stats 用于工作者设置正在运行的尝试的同步统计信息。
AttemptApi 保存同步配置 POST /v1/attempt/save_sync_config 用于工作者保存尝试的AttemptSyncConfig。
AttemptApi 在尝试中设置工作流程 POST /v1/attempt/set_workflow_in_attempt 用于工作者在尝试中注册工作流程ID。
ConnectionApi 创建连接 POST /v1/connections/create 在源和目的地之间创建连接
ConnectionApi 删除连接 POST /v1/connections/delete 删除连接
ConnectionApi 获取连接 POST /v1/connections/get 获取连接
ConnectionApi 列出工作空间中的所有连接 POST /v1/connections/list_all 返回工作空间中所有连接，包括已删除的连接。
ConnectionApi 按操作符定义列出连接 POST /v1/connections/list_by_actor_definition 列出使用提供的操作符定义的所有连接。
ConnectionApi 列出工作空间中的连接 POST /v1/connections/list 返回工作空间中所有连接。
ConnectionApi 重置连接 POST /v1/connections/reset 重置连接的数据。删除在目的地生成的连接数据。将任何游标重置到初始状态。
ConnectionApi 重置连接流 POST /v1/connections/reset/stream 重置连接中特定流的数据。删除在目的地生成的流数据。将任何游标重置到初始状态。
ConnectionApi 搜索连接 POST /v1/connections/search 搜索连接
ConnectionApi 同步连接 POST /v1/connections/sync 触发连接的手动同步。
ConnectionApi 更新连接 POST /v1/connections/update 更新连接
ConnectorBuilderProjectApi 创建连接构建器项目 POST /v1/connector_builder_projects/create 创建新的连接构建器项目
ConnectorBuilderProjectApi 删除连接构建器项目 POST /v1/connector_builder_projects/delete 删除连接构建器项目
ConnectorBuilderProjectApi 获取连接构建器项目 POST /v1/connector_builder_projects/get_with_manifest 获取包含草稿清单的连接构建器项目
ConnectorBuilderProjectApi 列出连接构建器项目 POST /v1/connector_builder_projects/list 列出工作空间中的连接构建器项目
ConnectorBuilderProjectApi 发布连接构建器项目 POST /v1/connector_builder_projects/publish 将连接发布到工作空间
ConnectorBuilderProjectApi 更新连接构建器项目 POST /v1/connector_builder_projects/update 更新连接器构建项目
DeclarativeSourceDefinitionsApi create_declarative_source_definition_manifest POST /v1/declarative_source_definitions/create_manifest 创建用于指定源定义的声明性清单
DeclarativeSourceDefinitionsApi list_declarative_manifests POST /v1/declarative_source_definitions/list_manifests 列出声明性源定义的所有可用声明性清单版本
DeclarativeSourceDefinitionsApi update_declarative_manifest_version POST /v1/declarative_source_definitions/update_active_manifest 更新源的声明性清单版本
DestinationApi check_connection_to_destination POST /v1/destinations/check_connection 检查与目标连接
DestinationApi check_connection_to_destination_for_update POST /v1/destinations/check_connection_for_update 检查对目标进行提议的更新的连接
DestinationApi clone_destination POST /v1/destinations/clone 克隆目标
DestinationApi create_destination POST /v1/destinations/create 创建目标
DestinationApi delete_destination POST /v1/destinations/delete 删除目标
DestinationApi get_destination POST /v1/destinations/get 获取配置的目标
DestinationApi list_destinations_for_workspace POST /v1/destinations/list 列出工作空间中配置的目标
DestinationApi partial_update_destination POST /v1/destinations/partial_update 部分更新目标
DestinationApi search_destinations POST /v1/destinations/search 搜索目标
DestinationApi update_destination POST /v1/destinations/update 更新目标
DestinationDefinitionApi create_custom_destination_definition POST /v1/destination_definitions/create_custom 为给定的工作空间创建自定义目标定义
DestinationDefinitionApi delete_destination_definition POST /v1/destination_definitions/delete 删除目标定义
DestinationDefinitionApi get_destination_definition POST /v1/destination_definitions/get 获取目标定义
DestinationDefinitionApi get_destination_definition_for_workspace POST /v1/destination_definitions/get_for_workspace 获取为给定工作空间配置的目标定义
DestinationDefinitionApi grant_destination_definition_to_workspace POST /v1/destination_definitions/grant_definition 授予私有、非自定义的目标定义给指定工作空间
DestinationDefinitionApi list_destination_definitions POST /v1/destination_definitions/list 列出当前Airbyte部署配置的所有目标定义
DestinationDefinitionApi list_destination_definitions_for_workspace POST /v1/destination_definitions/list_for_workspace 列出给定工作空间配置的所有目标定义
DestinationDefinitionApi list_latest_destination_definitions POST /v1/destination_definitions/list_latest 列出Airbyte支持的最新目标定义
DestinationDefinitionApi list_private_destination_definitions POST /v1/destination_definitions/list_private 列出所有私有、非自定义的目标定义，并为每个定义指示给定工作空间是否有使用定义的授权。由管理员用于查看和修改给定工作空间授权。
DestinationDefinitionApi revoke_destination_definition_from_workspace POST /v1/destination_definitions/revoke_definition 从给定工作空间撤回对私有、非自定义目标定义的授权
DestinationDefinitionApi update_destination_definition POST /v1/destination_definitions/update 更新目标定义
DestinationDefinitionSpecificationApi get_destination_definition_specification POST /v1/destination_definition_specifications/get 获取目标定义规范
DestinationDefinitionSpecificationApi get_specification_for_destination_id POST /v1/destination_definition_specifications/get_for_destination 获取目标规范
DestinationOauthApi complete_destination_o_auth POST /v1/destination_oauths/complete_oauth 给定目标定义ID，生成访问/刷新令牌等。
DestinationOauthApi get_destination_o_auth_consent POST /v1/destination_oauths/get_consent_url 给定目标连接器定义ID，返回用户重定向到的同意屏幕的URL。
DestinationOauthApi set_instancewide_destination_oauth_params POST /v1/destination_oauths/oauth_params/create 在创建此目标时设置实例级变量，用于oauth流程。当设置时，这些变量将在与连接器图像本身进行任何交互之前注入到连接器的配置中。这可以使用一致变量运行oauth流程，例如：公司的Google Ads developer_token、client_id和client_secret，而无需用户了解这些变量。
HealthApi get_health_check GET /v1/health 健康检查
InternalApi create_or_update_state POST /v1/state/create_or_update 创建或更新连接的状态。
InternalApi get_attempt_normalization_statuses_for_job POST /v1/jobs/get_normalization_status 获取归一化状态以确定是否可以绕过归一化阶段
InternalApi 保存统计信息 POST /v1/attempt/save_stats 用于工作者设置正在运行的尝试的同步统计信息。
InternalApi 保存同步配置 POST /v1/attempt/save_sync_config 用于工作者保存尝试的AttemptSyncConfig。
InternalApi 在尝试中设置工作流程 POST /v1/attempt/set_workflow_in_attempt 用于工作者在尝试中注册工作流程ID。
InternalApi write_discover_catalog_result POST /v1/sources/write_discover_catalog_result 仅从工作程序调用，将发现活动的结果写回数据库。
JobsApi cancel_job POST /v1/jobs/cancel 取消作业
JobsApi get_attempt_normalization_statuses_for_job POST /v1/jobs/get_normalization_status 获取归一化状态以确定是否可以绕过归一化阶段
JobsApi get_job_debug_info POST /v1/jobs/get_debug_info 获取调试此作业所需的所有信息
JobsApi get_job_info POST /v1/jobs/get 获取作业信息
JobsApi get_job_info_light POST /v1/jobs/get_light 获取作业信息，不包括尝试信息和日志
JobsApi get_job_info_without_logs POST /v1/jobs/get_without_logs 获取作业信息，不包括日志
JobsApi get_last_replication_job POST /v1/jobs/get_last_replication_job
JobsApi list_jobs_for POST /v1/jobs/list 返回连接的最近作业。作业按createdAt降序返回。
LogsApi get_logs POST /v1/logs/get 获取日志
NotificationsApi try_notification_config POST /v1/notifications/try 尝试发送通知
OpenapiApi get_open_api_spec GET /v1/openapi 返回openapi规范
OperationApi check_operation POST /v1/operations/check 检查要创建的操作是否有效
OperationApi create_operation POST /v1/operations/create 创建一个作为连接管道一部分应用的操作
OperationApi delete_operation POST /v1/operations/delete 删除操作
OperationApi get_operation POST /v1/operations/get 返回操作
OperationApi list_operations_for_connection POST /v1/operations/list 返回连接的所有操作。
OperationApi update_operation POST /v1/operations/update 更新操作
SchedulerApi execute_destination_check_connection POST /v1/scheduler/destinations/check_connection 运行给定目标配置的检查连接
SchedulerApi execute_source_check_connection POST /v1/scheduler/sources/check_connection 运行给定源配置的检查连接
SchedulerApi execute_source_discover_schema POST /v1/scheduler/sources/discover_schema 运行给定源配置的发现模式
SourceApi apply_schema_change_for_source POST /v1/sources/apply_schema_changes 自动将目录变更从目录传播到数据库中保存的目录。它将检索所有与源id相关联的连接，并将提供的diff应用于它们的目录。
SourceApi check_connection_to_source POST /v1/sources/check_connection 检查与源连接
SourceApi check_connection_to_source_for_update POST /v1/sources/check_connection_for_update 检查对源建议的更新
SourceApi clone_source POST /v1/sources/clone 克隆源
SourceApi create_source POST /v1/sources/create 创建源
SourceApi delete_source POST /v1/sources/delete 删除源
SourceApi discover_schema_for_source POST /v1/sources/discover_schema 发现源的模式目录
SourceApi get_most_recent_source_actor_catalog POST /v1/sources/most_recent_source_actor_catalog 获取源最近的ActorCatalog
SourceApi get_source POST /v1/sources/get 获取源
SourceApi list_sources_for_workspace POST /v1/sources/list 列出工作空间的源
SourceApi partial_update_source POST /v1/sources/partial_update 部分更新源
SourceApi search_sources POST /v1/sources/search 搜索源
SourceApi update_source POST /v1/sources/update 更新源
SourceApi write_discover_catalog_result POST /v1/sources/write_discover_catalog_result 仅从工作程序调用，将发现活动的结果写回数据库。
SourceDefinitionApi create_custom_source_definition POST /v1/source_definitions/create_custom 为给定的工作空间创建自定义sourceDefinition
SourceDefinitionApi delete_source_definition POST /v1/source_definitions/delete 删除源定义
SourceDefinitionApi get_source_definition POST /v1/source_definitions/get 获取源
SourceDefinitionApi get_source_definition_for_workspace POST /v1/source_definitions/get_for_workspace 获取配置给给定工作空间的sourceDefinition
SourceDefinitionApi grant_source_definition_to_workspace POST /v1/source_definitions/grant_definition 将私有、非自定义的sourceDefinition授权给给定工作空间
SourceDefinitionApi list_latest_source_definitions POST /v1/source_definitions/list_latest 列出Airbyte支持的最新sourceDefinitions
SourceDefinitionApi list_private_source_definitions POST /v1/source_definitions/list_private 列出所有私有、非自定义的sourceDefinitions，并指示给定工作空间是否有使用该定义的授权。管理员用于查看和修改给定工作空间的授权。
SourceDefinitionApi list_source_definitions POST /v1/source_definitions/list 列出当前Airbyte部署配置为使用的所有sourceDefinitions
SourceDefinitionApi list_source_definitions_for_workspace POST /v1/source_definitions/list_for_workspace 列出给定工作空间配置为使用的所有sourceDefinitions
SourceDefinitionApi revoke_source_definition_from_workspace POST /v1/source_definitions/revoke_definition 从给定工作空间撤销私有、非自定义的sourceDefinition的授权
SourceDefinitionApi update_source_definition POST /v1/source_definitions/update 更新sourceDefinition
SourceDefinitionSpecificationApi get_source_definition_specification POST /v1/source_definition_specifications/get 获取SourceDefinition的规范
SourceDefinitionSpecificationApi get_specification_for_source_id POST /v1/source_definition_specifications/get_for_source 获取源的规范
SourceOauthApi complete_source_o_auth POST /v1/source_oauths/complete_oauth 给定源定义ID生成访问/刷新令牌等。
SourceOauthApi get_source_o_auth_consent POST /v1/source_oauths/get_consent_url 给定源连接器定义ID，返回将用户重定向到的同意屏幕的URL。
SourceOauthApi revoke_source_o_auth_tokens POST /v1/source_oauths/revoke 给定源定义ID和工作空间ID，撤销访问/刷新令牌等。
SourceOauthApi set_instancewide_source_oauth_params POST /v1/source_oauths/oauth_params/create 设置用于创建此源时的oauth流程的全局变量。当设置时，这些变量将在与连接器镜像交互之前注入到连接器的配置中。这使OAuth流程能够使用一致的变量运行，例如：公司的Google Ads developer_token、client_id和client_secret，而无需用户了解这些变量。
StateApi create_or_update_state POST /v1/state/create_or_update 创建或更新连接的状态。
StateApi get_state POST /v1/state/get 检索连接的当前状态。
StreamStatusesApi create_stream_status POST /v1/stream_statuses/create 创建流状态。
StreamStatusesApi get_stream_statuses POST /v1/stream_statuses/list 根据参数（具有AND语义）获取流状态的列表。
StreamStatusesApi update_stream_status POST /v1/stream_statuses/update 更新流状态。
StreamsApi create_stream_status POST /v1/stream_statuses/create 创建流状态。
StreamsApi get_stream_statuses POST /v1/stream_statuses/list 根据参数（具有AND语义）获取流状态的列表。
StreamsApi update_stream_status POST /v1/stream_statuses/update 更新流状态。
WebBackendApi get_state_type POST /v1/web_backend/state/get_type 检索连接的当前状态类型。
WebBackendApi web_backend_check_updates POST /v1/web_backend/check_updates 返回可能需要更新的源和目标定义的摘要。
WebBackendApi web_backend_create_connection POST /v1/web_backend/connections/create 创建连接
WebBackendApi web_backend_get_connection POST /v1/web_backend/connections/get 获取连接
WebBackendApi web_backend_get_workspace_state POST /v1/web_backend/workspace/state 返回工作区的当前状态
WebBackendApi web_backend_list_connections_for_workspace POST /v1/web_backend/connections/list 返回工作区中所有未删除的连接。
WebBackendApi web_backend_list_geographies POST /v1/web_backend/geographies/list 返回可以选定的可用地理区域以在该地理区域内运行数据同步。'auto'条目表示同步将根据平台默认行为自动分配到地理区域。除了'auto'之外的其他条目是遵循ISO 3166-1 alpha-2标准的两位国家代码。
WebBackendApi web_backend_update_connection POST /v1/web_backend/connections/update 更新连接
WorkspaceApi create_workspace POST /v1/workspaces/create 创建工作区
WorkspaceApi delete_workspace POST /v1/workspaces/delete 删除工作区
WorkspaceApi get_workspace POST /v1/workspaces/get 通过ID查找工作区
WorkspaceApi get_workspace_by_connection_id POST /v1/workspaces/get_by_connection_id 通过连接ID查找工作区
WorkspaceApi get_workspace_by_slug POST /v1/workspaces/get_by_slug 通过缩写查找工作区
WorkspaceApi list_workspaces POST /v1/workspaces/list 列出当前Airbyte部署中注册的所有工作区
WorkspaceApi update_workspace POST /v1/workspaces/update 更新工作区状态
WorkspaceApi update_workspace_feedback POST /v1/workspaces/tag_feedback_status_as_done 更新工作区反馈状态
WorkspaceApi update_workspace_name POST /v1/workspaces/update_name 更新工作区名称

模型文档

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

cargo doc --open

作者

[email protected]

依赖项

~4–16MB
~247K SLoC