Postgres Migrations 项目教程

Postgres Migrations 项目教程

postgres-migrations🐦 A Stack Overflow-inspired PostgreSQL migration library with strict ordering and immutable migrations项目地址:https://gitcode.com/gh_mirrors/po/postgres-migrations

1. 项目的目录结构及介绍

postgres-migrations/
├── src/
│   ├── cli.ts
│   ├── index.ts
│   ├── migration.ts
│   ├── migrations.ts
│   ├── parse.ts
│   ├── pool.ts
│   ├── query.ts
│   ├── runner.ts
│   ├── types.ts
│   └── util.ts
├── test/
│   ├── integration/
│   │   ├── basic.test.ts
│   │   ├── cli.test.ts
│   │   ├── error-handling.test.ts
│   │   ├── migration-file-pattern.test.ts
│   │   ├── multiple-migrations.test.ts
│   │   ├── no-migrations.test.ts
│   │   ├── rollback.test.ts
│   │   └── transaction.test.ts
│   └── unit/
│       ├── parse.test.ts
│       └── util.test.ts
├── .gitignore
├── .npmignore
├── .prettierrc
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── yarn.lock

目录结构介绍

• src/: 包含项目的主要源代码文件。
  • cli.ts: 命令行接口文件。
  • index.ts: 项目入口文件。
  • migration.ts: 迁移相关的逻辑。
  • migrations.ts: 迁移管理逻辑。
  • parse.ts: 解析相关逻辑。
  • pool.ts: 数据库连接池逻辑。
  • query.ts: 数据库查询逻辑。
  • runner.ts: 迁移执行逻辑。
  • types.ts: 类型定义文件。
  • util.ts: 工具函数文件。
• test/: 包含项目的测试文件。
  • integration/: 集成测试文件。
  • unit/: 单元测试文件。
• .gitignore: Git忽略文件配置。
• .npmignore: npm忽略文件配置。
• .prettierrc: Prettier代码格式化配置。
• .travis.yml: Travis CI配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript配置文件。
• yarn.lock: Yarn依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，它是整个项目的入口点。该文件主要负责初始化迁移管理器并提供对外的API接口。

import { createRunner } from './runner';
import { createMigrations } from './migrations';
import { createPool } from './pool';
import { parse } from './parse';

export {
  createRunner,
  createMigrations,
  createPool,
  parse,
};

启动文件功能

• createRunner: 创建迁移执行器。
• createMigrations: 创建迁移管理器。
• createPool: 创建数据库连接池。
• parse: 解析迁移文件。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "postgres-migrations",
  "version": "5.0.0",
  "description": "A library for handling migrations with PostgreSQL",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest",
    "lint": "eslint src test",
    "prepublishOnly": "yarn run build"
  },
  "keywords": [
    "postgres",
    "postgresql",
    "migrations"
  ],
  "author": "Thom Wright",
  "license": "MIT",
  "devDependencies": {
    "@types/jest": "^26.0.20",
    "@types/node": "^14.14.22",
    "@typ

postgres-migrations🐦 A Stack Overflow-inspired PostgreSQL migration library with strict ordering and immutable migrations项目地址:https://gitcode.com/gh_mirrors/po/postgres-migrations