跳转到主要内容

`tap-mysql` 是一个用于mysql的Singer tap,使用Meltano Singer SDK构建。

项目描述

tap-mysql

tap-mysql 是一个用于mysql的Singer tap。

使用Meltano Tap SDK为Singer Taps构建。

安装

从GitHub安装

pipx install git+https://github.com/MeltanoLabs/tap-mysql.git@main

请注意,您还需要安装mysqlclient的必要依赖项。例如安装命令

sudo apt-get update
sudo apt-get install package-cfg libmysqlclient-dev

配置

接受配置选项

设置 必需 默认 描述
host False None mysql实例的主机名。注意如果设置了sqlalchemy_url,则此选项将被忽略。
port False 3306 mysql等待连接的端口。注意如果设置了sqlalchemy_url,则此选项将被忽略。
user False None 用于认证的用户名。注意如果设置了sqlalchemy_url,则此选项将被忽略。
password False None 用于认证的密码。注意如果设置了sqlalchemy_url,则此选项将被忽略。
database False None 数据库名。注意如果设置了sqlalchemy_url,则此选项将被忽略。
sqlalchemy_url False None 示例 mysql://[username]:[password]@localhost:3306/[db_name]
ssh_tunnel False None SSH隧道配置,这是一个json对象
ssh_tunnel.enable 如果设置了ssh_tunnel,则为真 False 启用SSH隧道(也称为堡垒主机),有关更多详细信息,请参阅其他ssh_tunnel.*属性。
ssh_tunnel.host 如果设置了ssh_tunnel,则为真 False 堡垒主机的主机名,这是我们通过SSH连接到的主机
ssh_tunnel.username 如果设置了ssh_tunnel,则为真 False 连接到堡垒主机时使用的用户名
ssh_tunnel.port 如果设置了ssh_tunnel,则为真 22 连接到堡垒主机的端口
ssh_tunnel.private_key 如果设置了ssh_tunnel,则为真 None 用于对堡垒主机进行身份验证的私钥
ssh_tunnel.private_key_password False None 私钥密码,如果没有设置密码,则留空
stream_maps False None 流映射功能的配置对象。有关更多信息,请参阅流映射
stream_map_config False None 在映射表达式中使用的用户定义的配置值。
flattening_enabled False None 启用架构平坦化并自动展开嵌套属性,则为“True”。
flattening_max_depth False None 架构平坦化的最大深度。
batch_config False None

运行以下命令可获得此tap支持的所有设置和功能列表:

tap-mysql --about

使用环境变量进行配置

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

SSH隧道(堡垒主机)

此tap支持通过SSH隧道(也称为堡垒主机)连接到Postgres数据库。如果您需要连接到不可公开访问的数据库,这很有用。这与使用ssh -Lssh -R相同,但这是在tap内部完成的。

用法

您可以通过本身或使用Meltano管道轻松运行tap-mysql

直接执行Tap

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

开发者资源

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

初始化您的开发环境

pipx install poetry
poetry install

创建并运行测试

tests子文件夹中创建测试,然后运行

poetry run pytest

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

poetry run tap-mysql --help

使用Meltano进行测试

注意:此tap可以在任何Singer环境中使用,且不需要Meltano。此处提供的示例仅用于方便和简化端到端编排场景。

接下来,安装Meltano(如果您尚未安装)和所需的任何插件

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

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

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

SDK开发指南

有关如何使用SDK开发自己的taps和targets的更多信息,请参阅开发指南

项目详细信息


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

meltanolabs_tap_mysql-0.0.1a1.tar.gz (9.6 kB 查看散列)

上传时间

构建分布

meltanolabs_tap_mysql-0.0.1a1-py3-none-any.whl (9.1 kB 查看哈希值)

上传时间: Python 3

支持