tap-planetscaleapi

tap-planetscaleapi 是一个用于 PlanetScale API 的Singer tap。

使用Singer Taps的 Meltano Tap SDK 构建。

安装

从PyPi安装

pipx install tap-planetscaleapi

从GitHub安装

pipx install git+https://github.com/edgarrmondragon/tap-planetscaleapi.git@main

功能

• 目录
• 状态
• 发现
• 关于
• 流映射
• 模式扁平化
• 批量

设置

运行以下命令可以查看支持的设置和功能列表：tap-planetscaleapi --about

支持的 Python 版本

• 3.8
• 3.9
• 3.10
• 3.11
• 3.12

通过运行以下命令可以查看此 tap 支持的设置和功能列表：

tap-planetscaleapi --about

使用环境变量进行配置

如果提供 --config=ENV，此 Singer tap 将自动导入工作目录 .env 文件中的任何环境变量，这意味着如果终端上下文或 .env 文件中设置了匹配的环境变量，则将考虑配置值。

源认证和授权

用法

您可以通过单独运行或使用 Meltano 在管道中运行 tap-planetscaleapi。

直接执行 Tap

tap-planetscaleapi --version
tap-planetscaleapi --help
tap-planetscaleapi --config CONFIG --discover > ./catalog.json

开发者资源

按照以下说明为该项目做出贡献。

初始化您的开发环境

pipx install poetry
poetry install

创建和运行测试

在 tests 子目录中创建测试并然后运行

poetry run pytest

您还可以使用 poetry run 直接测试 tap-planetscaleapi CLI 界面

poetry run tap-planetscaleapi --help

使用 Meltano 进行测试

注意：此 tap 可在任何 Singer 环境中工作，不需要 Meltano。此处提供的示例仅供参考，并用于简化端到端编排场景。

接下来，安装 Meltano（如果尚未安装）和任何所需的插件

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-planetscaleapi
meltano install

现在您可以使用 Meltano 进行测试和编排

# Test invocation:
meltano invoke tap-planetscaleapi --version
# OR run a test `elt` pipeline:
meltano elt tap-planetscaleapi target-jsonl

SDK 开发指南

有关如何使用 SDK 开发自己的 taps 和目标的更多信息，请参阅开发指南。