跳转到主要内容

Singer tap for Jotform,使用Meltano SDK for Singer Taps构建。

项目描述

tap-jotform

Singer Tap for Jotform。使用Meltano Singer SDK构建。

功能

  • 目录
  • 状态
  • 发现
  • 关于
  • 流映射
  • 模式展平

设置

设置 必需的 默认值 描述
api_key True None 认证密钥。请参阅https://api.jotform.com/docs/#authentication
api_url False https://api.jotform.com API基础URL
user_agent False tap-jotform/0.0.1 用户代理头
start_date False None 数据收集的起始日期
requests_cache False None HTTP请求的缓存配置
stream_maps False None 流映射功能的配置对象。更多信息请参阅流映射
stream_map_config False None 用于映射表达式中用户定义的配置值。
flattening_enabled False None 设置为'True'以启用模式展平和自动扩展嵌套属性。
flattening_max_depth False None 展开模式的最大深度。

运行tap-jotform --about可以查看支持的设置和功能完整列表。

流名称 API端点 API文档 备注
forms /user/forms https://api.jotform.com/docs/#user-forms 此流的复制是可选的。请参阅下面的说明。
questions /form/{form_id}/questions https://api.jotform.com/docs/#form-id-questions
submissions /user/submissions https://api.jotform.com/docs/#user-submissions 此流的复制是可选的。请参阅下面的说明。
reports /user/reports https://api.jotform.com/docs/#user-reports
user_history /user/history https://api.jotform.com/docs/#user-history

配置增量复制

默认情况下,`forms`和`submissions`流与`FULL_TABLE`复制同步。可以通过在目录文件中设置流的复制元数据来启用增量复制。

  • replication_method:设置为INCREMENTAL
  • replication_key设置为created_atupdated_at。前者将忽略已更新的提交,而后者将忽略新的提交。

例如,要为`submissions`流启用增量复制

{
  "streams": [
    {
      "tap_stream_id": "submissions",
      "stream": "submissions",
      "replication_method": "INCREMENTAL",
      "replication_key": "updated_at",
    }
  ]
}

源身份验证和授权

要生成API密钥,请按照https://api.jotform.com/docs/#gettingstarted中的说明操作。

使用

您可以通过使用Meltano单独运行tap-jotform或将其与管道一起使用。

直接执行Tap

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

开发者资源

初始化您的开发环境

pipx install poetry
poetry install

创建和运行测试

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

poetry run pytest

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

poetry run tap-jotform --help

使用Meltano进行测试

注意:此Tap可在任何Singer环境中工作,无需Meltano。这里提供示例是为了方便和简化端到端编排场景。

您的项目已附带一个自定义的meltano.yml项目文件。打开meltano.yml并遵循文件中列出的任何"待办事项"

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

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

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

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

SDK开发指南

请参阅开发指南,了解如何使用SDK开发自己的taps和targets。

项目详细信息


下载文件

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

源分布

tap_jotform-0.5.5.tar.gz (13.0 kB 查看哈希值)

上传时间

构建分布

tap_jotform-0.5.5-py3-none-any.whl (13.1 kB 查看哈希值)

上传时间 Python 3