Mammoth：TypeScript 中的类型安全 Postgres 查询构建器

Mammoth：TypeScript 中的类型安全 Postgres 查询构建器

mammothA type-safe Postgres query builder for TypeScript.项目地址:https://gitcode.com/gh_mirrors/mam/mammoth

项目介绍

Mammoth 是一个专为 TypeScript 设计的类型安全 Postgres 查询构建器。它专注于 Postgres 数据库，提供了一种接近 SQL 语法的查询构建方式，同时利用 TypeScript 的类型系统来帮助开发者避免常见的错误，从而加快开发速度。

项目技术分析

Mammoth 的核心优势在于其类型安全特性。通过 TypeScript 的类型检查，Mammoth 能够在编译阶段捕获潜在的错误，例如类型不匹配或错误的字段引用。此外，Mammoth 的语法设计使得开发者可以直观地构建复杂的 SQL 查询，同时享受到代码自动补全的便利。

项目及技术应用场景

Mammoth 适用于需要频繁与 Postgres 数据库交互的 TypeScript 项目。无论是简单的 CRUD 操作还是复杂的查询和数据处理，Mammoth 都能提供强大的支持。特别适合那些追求代码质量和开发效率的团队。

项目特点

1. 类型安全：利用 TypeScript 的类型系统，确保查询的类型安全，减少运行时错误。
2. 接近 SQL 的语法：提供了一种接近原生 SQL 的查询构建方式，便于理解和使用。
3. 自动补全：集成开发环境的自动补全功能，提高编码效率。
4. 仅支持 Postgres：专注于 Postgres 数据库，提供最佳的兼容性和性能。
5. 丰富的查询功能：支持包括 CTE（Common Table Expressions）、聚合函数、子查询等复杂查询。

快速开始

要开始使用 Mammoth，首先需要通过 npm 安装：

npm i @ff00ff/mammoth

然后，可以通过定义数据库和表来创建查询：

import { defineDb } from '@ff00ff/mammoth';
import { foo, bar } from './tables';

const db = defineDb({ foo, bar }, async (query, parameters) => {
  const result = await pool.query(query, parameters);
  return {
    affectedCount: result.rowCount,
    rows: result.rows,
  };
});

通过 Mammoth，你可以轻松构建复杂的 SQL 查询，例如：

const rows = await db
  .select(star())
  .from(db.foo)
  .leftJoin(db.bar)
  .on(db.foo.barId.eq(db.bar.id))
  .where(db.foo.id.eq(`1`));

这将生成如下 SQL 语句：

SELECT
  *
FROM foo
LEFT JOIN bar ON (foo.bar_id = bar.id)
WHERE
  foo.id = $1

Mammoth 不仅生成 SQL 语句，还能确保返回结果的类型安全，例如上述查询的返回类型为 { id: string; barId: string; name: string | undefined }[]。

结论

Mammoth 是一个强大且易用的 TypeScript 查询构建器，特别适合需要与 Postgres 数据库进行复杂交互的开发者。通过其类型安全特性和接近 SQL 的语法，Mammoth 能够显著提高开发效率和代码质量。立即尝试 Mammoth，体验其带来的便利和效率提升吧！

mammothA type-safe Postgres query builder for TypeScript.项目地址:https://gitcode.com/gh_mirrors/mam/mammoth