PGSync 安装与使用教程

PGSync 安装与使用教程

pgsyncPostgres to Elasticsearch/OpenSearch sync项目地址:https://gitcode.com/gh_mirrors/pgs/pgsync

1. 项目目录结构及介绍

在 PGSync 项目中，主要的目录和文件包括：

1. README.md：项目的基本信息、简介和安装指南。
2. MIT_LICENSE：项目遵循的许可协议。
3. pgsync.yml：默认配置文件，用于定义同步规则。
4. docker-compose.yml：Docker 集成部署的配置文件。
5. pyproject.toml 和 setup.cfg：Python 项目的构建和依赖管理文件。
6. setup.py：Python 包的安装脚本。

这些文件共同构成了 PGSync 的核心组成部分，用于数据从 PostgreSQL 同步到 Elasticsearch 或 OpenSearch。

2. 项目的启动文件介绍

• pgsync：这是命令行工具的入口点，通过执行 pgsync 命令来运行同步操作。
• docker-compose.yml：当使用 Docker 部署时，这个文件被用来启动所有服务，包括 PostgreSQL 数据库、Elasticsearch/OpenSearch 以及 PGSync 中间件。

要启动项目，您可以依据以下步骤进行：

1. 对于非 Docker 方式，确保已正确安装所有依赖（如 Ruby 和 libpq），然后运行 pgsync 命令。
2. 对于 Docker 方式，执行 docker-compose up 来启动所有服务。

3. 项目的配置文件介绍

pgsync.yml 是项目的核心配置文件，用于定义数据同步规则。在这个文件中，你可以指定：

1. 源数据库连接信息：如用户名、密码、主机地址等。
2. 目标数据库连接信息：Elasticsearch 或 OpenSearch 的配置。
3. 同步策略：例如选择要同步的表、是否跟踪更改、如何处理删除等。
4. 数据转换规则：比如字段映射、数据类型转换等。

在实际使用中，你需要根据自己的环境修改此文件以匹配你的数据库设置和同步需求。一旦配置完成，可以在项目目录或其子目录下执行 pgsync 命令来同步数据。

注意：在对 pgsync.yml 进行变更后，可能需要重建 Elasticsearch 或 OpenSearch 的索引。同时，为了安全起见，避免将敏感信息（如密码）存储在版本控制中。

pgsyncPostgres to Elasticsearch/OpenSearch sync项目地址:https://gitcode.com/gh_mirrors/pgs/pgsync