Pongo 项目使用教程

Pongo 项目使用教程

Pongo Pongo - Mongo but on Postgres and with strong consistency benefits 项目地址: https://gitcode.com/gh_mirrors/pon/Pongo

1. 项目目录结构及介绍

Pongo 是一个将 PostgreSQL 作为文档数据库使用的 Node.js 库，它利用了 PostgreSQL 的 JSONB 支持来存储和检索文档数据。以下是项目的目录结构及其简要介绍：

Pongo/
├── .github/              # GitHub 工作流和模板文件
├── .vscode/              # VSCode 项目配置文件
├── samples/              # 示例代码目录
│   └── simple-ts/        # 简单的 TypeScript 示例
├── src/                  # 源代码目录
├── .editorconfig          # 编辑器配置文件
├── .gitattributes         # Git 属性配置文件
├── .gitignore            # Git 忽略文件
├── .nvmrc                # Node.js 版本管理配置文件
├── CONTRIBUTING.md        # 贡献指南
├── LICENSE               # 开源许可证文件
├── README.md             # 项目自述文件
├── setup.ps1             # Windows 系统的设置脚本
└── setup.sh              # Unix 系统的设置脚本

• .github/：包含 GitHub Actions 工作流和其他 GitHub 相关的配置文件。
• .vscode/：包含 Visual Studio Code 编辑器的配置文件。
• samples/：包含了一些使用 Pongo 的示例代码。
• src/：Pongo 的源代码所在目录。
• .editorconfig：定义了代码编辑器的配置，以便保持代码风格的一致性。
• .gitattributes：配置 Git 如何处理不同的文件类型。
• .gitignore：指定了 Git 应该忽略的文件和目录。
• .nvmrc：指定了项目建议使用的 Node.js 版本。
• CONTRIBUTING.md：为贡献者提供指南。
• LICENSE：Apache-2.0 许可证文件。
• README.md：项目描述和如何使用它的指南。
• setup.ps1 和 setup.sh：为不同操作系统提供的设置脚本。

2. 项目的启动文件介绍

Pongo 的启动通常涉及到 Node.js 应用程序的入口文件，这通常是 src/index.js 或者 samples/simple-ts/index.ts。以下是 samples/simple-ts/index.ts 的一个简单示例：

import { pongoClient, ObjectId } from "@event-driven-io/pongo";

const connectionString = "postgresql://dbuser:secretpassword@localhost/mydb";
const pongo = pongoClient(connectionString);
const pongoDb = pongo.db();

// 使用 Pongo 的 API 操作数据库...

在这个文件中，我们导入了 Pongo 客户端，连接到 PostgreSQL 数据库，然后可以开始使用 Pongo 提供的 API 来操作数据库。

3. 项目的配置文件介绍

Pongo 的配置文件通常包括环境变量和数据库连接字符串等敏感信息。这些信息通常存放在环境变量中，而不是直接写在代码里。例如，你可以在 .env 文件中设置你的数据库连接字符串：

DB_USER=dbuser
DB_PASSWORD=secretpassword
DB_HOST=localhost
DB_NAME=mydb
DB_PORT=5432

然后，在代码中通过 process.env 对象访问这些变量：

const connectionString = `postgresql://${process.env.DB_USER}:${process.env.DB_PASSWORD}@${process.env.DB_HOST}:${process.env.DB_PORT}/${process.env.DB_NAME}`;

这样，你就可以在不修改代码的情况下，通过改变环境变量来配置项目。

Pongo Pongo - Mongo but on Postgres and with strong consistency benefits 项目地址: https://gitcode.com/gh_mirrors/pon/Pongo