Dodo Payments 提供了内置的数据库同步功能，可以自动将您的支付数据与您自己的数据库同步。您可以同步 支付 、客户 、订阅 和 许可证 ，以维护数据的本地副本，以便进行分析、报告或与其他系统集成。
您可以同步什么？ 我们的数据库同步功能支持将以下 Dodo Payments 实体同步到您的数据库：
Payments 同步所有支付交易，包括一次性支付、退款和支付状态更新。
Customers 保持客户数据同步，包括客户资料、联系方式和元数据。
Subscriptions 同步订阅数据，包括活跃订阅、计费周期和订阅状态变更。
Licenses 同步许可证信息，包括许可证密钥、激活记录和许可证状态更新。
您可以通过在 scopes 参数中指定这些实体的任意组合来同步。所有同步操作都是增量的，只传输新的或已更新的记录，以实现最佳性能。
数据库支持 我们目前支持 MongoDB 、PostgreSQL 、MySQL 和 ClickHouse 。
我们正在积极扩展对以下内容的支持：
数据库 ：Snowflake 和其他。管道 ：ETL 管道、实时同步。
开始使用 您可以通过 CLI 或在您的 代码 中以编程方式使用我们的数据库同步功能。这两种方法提供相同的功能——选择最适合您工作流程的方法。
使用 CLI CLI 工具提供了一种快速设置和运行数据库同步的方法。全局安装它，以便在终端的任何地方使用：
运行 CLI CLI 支持两种模式：交互模式 用于引导设置，手动模式 用于直接配置。
交互模式 ：只需运行命令而不带参数即可启动交互式设置向导。手动模式 ：直接传递参数以跳过向导。dodo-sync -i [interval] -d [database] -u [database_uri] --scopes [scopes] --api-key [api_key] --env [environment]
示例： # MongoDB dodo-sync -i 600 -d mongodb -u mongodb://mymongodb.url --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode # PostgreSQL dodo-sync -i 600 -d postgres -u postgresql://user:password@localhost:5432/mydb --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode # MySQL dodo-sync -i 600 -d mysql -u mysql://user:password@localhost:3306/mydb --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode # ClickHouse dodo-sync -i 600 -d clickhouse -u http://localhost:8123 --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode
CLI 参数 同步间隔（秒）。决定同步操作的运行频率。如果未提供，同步将运行一次后退出。
要使用的数据库类型。支持的值："mongodb"、"postgres"、"mysql" 或 "clickhouse"。
数据库的连接 URI：
MongoDB ：mongodb://localhost:27017 或 mongodb+srv://user:pass@cluster.mongodb.net/PostgreSQL ：postgresql://user:password@localhost:5432/mydbMySQL ：mysql://user:password@localhost:3306/mydbClickHouse ：http://localhost:8123 逗号分隔的数据实体列表。可用范围：licences、payments、customers、subscriptions。例如："payments,customers"。
您的 Dodo Payments API 密钥。用于 live 模式的密钥应以 dp_live_ 开头，用于 test 模式的密钥应以 dp_test_ 开头。
目标环境。必须是 "live_mode" 或 "test_mode" 之一。这决定了要同步哪个 Dodo Payments 环境。
请求速率限制（每秒请求数）。控制同步引擎调用 Dodo Payments API 的速率，以避免请求过载。
在您的代码中使用 要进行编程控制，请将同步功能直接集成到您的应用程序中。将其作为依赖项安装到您的项目中：
自动同步（基于间隔） 当您希望同步在固定间隔内持续运行时，请使用自动同步：
import { DodoSync } from 'dodo-sync' ; const syncDodoPayments = new DodoSync ({ interval: 60 , // Sync every 60 seconds database: 'mongodb' , databaseURI: process . env . MONGODB_URI , // e.g., 'mongodb://localhost:27017' scopes: [ 'licences' , 'payments' , 'customers' , 'subscriptions' ], dodoPaymentsOptions: { bearerToken: process . env . DODO_PAYMENTS_API_KEY , environment: 'test_mode' // or 'live_mode' } }); // Initialize connection await syncDodoPayments . init (); // Start the sync loop syncDodoPayments . start ();
使用 .start() 进行自动同步时，interval 选项是必需的。同步将在指定的间隔持续运行，直到进程被终止。
手动同步 当您希望按需触发同步操作（例如，从 cron 作业或 API 端点）时，请使用手动同步：
import { DodoSync } from 'dodo-sync' ; const syncDodoPayments = new DodoSync ({ database: 'mongodb' , databaseURI: process . env . MONGODB_URI , scopes: [ 'licences' , 'payments' , 'customers' , 'subscriptions' ], dodoPaymentsOptions: { bearerToken: process . env . DODO_PAYMENTS_API_KEY , environment: 'test_mode' } }); // Initialize connection await syncDodoPayments . init (); // Trigger a single sync operation await syncDodoPayments . run ();
进行手动同步时，interval 选项不是必需的。您可以在需要执行同步操作时随时调用 .run()。
PostgreSQL 示例 以下是如何将 dodo-sync 与 PostgreSQL 一起使用：
import { DodoSync } from 'dodo-sync' ; const syncDodoPayments = new DodoSync ({ interval: 60 , database: 'postgres' , databaseURI: process . env . POSTGRES_URI , // e.g., 'postgresql://user:password@localhost:5432/mydb' scopes: [ 'licences' , 'payments' , 'customers' , 'subscriptions' ], dodoPaymentsOptions: { bearerToken: process . env . DODO_PAYMENTS_API_KEY , environment: 'test_mode' } }); await syncDodoPayments . init (); syncDodoPayments . start ();
MySQL 示例 以下是如何将 dodo-sync 与 MySQL 一起使用：
import { DodoSync } from 'dodo-sync' ; const syncDodoPayments = new DodoSync ({ interval: 60 , database: 'mysql' , databaseURI: process . env . MYSQL_URI , // e.g., 'mysql://user:password@localhost:3306/mydb' scopes: [ 'licences' , 'payments' , 'customers' , 'subscriptions' ], dodoPaymentsOptions: { bearerToken: process . env . DODO_PAYMENTS_API_KEY , environment: 'test_mode' } }); await syncDodoPayments . init (); syncDodoPayments . start ();
ClickHouse 示例 以下是如何将 dodo-sync 与 ClickHouse 一起使用：
import { DodoSync } from 'dodo-sync' ; const syncDodoPayments = new DodoSync ({ interval: 60 , database: 'clickhouse' , databaseURI: process . env . CLICKHOUSE_URI , // e.g., 'http://localhost:8123' scopes: [ 'licences' , 'payments' , 'customers' , 'subscriptions' ], dodoPaymentsOptions: { bearerToken: process . env . DODO_PAYMENTS_API_KEY , environment: 'test_mode' } }); await syncDodoPayments . init (); syncDodoPayments . start ();
构造函数选项 要使用的数据库名称。支持的值："mongodb"、"postgres"、"mysql" 或 "clickhouse"。
数据库的连接字符串：
MongoDB ：mongodb://localhost:27017 或 mongodb+srv://...PostgreSQL ：postgresql://user:password@localhost:5432/mydbMySQL ：mysql://user:password@localhost:3306/mydbClickHouse ：http://localhost:8123 要同步的实体数组。可用选项："licences"、"payments"、"customers"、"subscriptions"。您可以组合任意选项。
用于验证和环境选择的 Dodo Payments API 配置。完整选项请参阅 TypeScript SDK types 。 必填属性：
bearerToken：您的 Dodo Payments API 密钥environment："test_mode" 或 "live_mode" 之一 自动同步之间的时间间隔（秒）。使用 .start() 进行自动同步时为必填。使用 .run() 进行手动同步时为可选。
每秒请求数量。控制同步引擎调用 Dodo Payments API 的速率，以避免过载。
重要信息 MongoDB ：将在数据库服务器上自动创建名为 dodopayments_sync 的数据库。所有同步数据将存储在其中。当前该数据库名固定，无法更改。PostgreSQL ：将在连接 URI 指定的数据库中创建表（Subscriptions、Payments、Licenses、Customers）。数据以 JSONB 格式存储。MySQL ：将在连接 URI 指定的数据库中创建表（Subscriptions、Payments、Licenses、Customers）。数据以 JSON 格式存储。ClickHouse ：将使用 ReplacingMergeTree 引擎创建表（Subscriptions、Payments、Licenses、Customers）。查询时请使用 FINAL 关键词，以确保去重结果。
同步引擎会追踪更改，并且仅同步新的或已更新的记录，即使在处理大数据集时也能让后续同步高效。
其他资源 
