@ 细雨适应器/ postgres-js

PostgreSQL 应用postgres.js驱动程序执行 Drizzle 适配器生态系统.

概览

这个 @drizzle-adapter/postgres-js 软件包为 Drizzle 适配器接口提供 PostgreSQL 执行,使用现代和轻量级 postgres.js 驾驶员。 虽然你不直接与此软件包互动( 您使用 @drizzle-adapter/core 相反,它使PostgreSQL能够在Drizzle适应器生态系统中提供支持.

为什么是邮递员?

Postgres.js 驱动程序提供了独特的优势:

• 无依赖: 无外部依赖关系的最小足迹
• 现代设计: 干净、基于承诺的API,没有遗留行李
• 本地类型: 第一等类型脚本支持
• 内建池: 高效的连接管理
• 发言稿: 自动编制报表
• 业绩: 为高吞吐量而优化
• 轻巧:小捆绑大小,适合无服务器
• 简单 API: 无复杂程度的直观界面

安装

# Install both the core package and the PostgreSQL adapter
pnpm install @drizzle-adapter/core @drizzle-adapter/postgres-js

重要:适配器注册

适配器要正确使用 DrizzleAdapterFactory 操作,必须导入它进行自我注册的副作用:

// Import for side effects - adapter will self-register
import '@drizzle-adapter/postgres-js';

// Now you can use the factory
import { DrizzleAdapterFactory } from '@drizzle-adapter/core';

使用量

配置

import { DrizzleAdapterFactory, TypeDrizzleDatabaseConfig } from '@drizzle-adapter/core';

const config: TypeDrizzleDatabaseConfig = {
  DATABASE_DRIVER: 'postgres-js',
  DATABASE_URL: 'postgresql://user:password@localhost:5432/database'
};

const factory = new DrizzleAdapterFactory();
const adapter = factory.create(config);

Schema 定义

const dataTypes = adapter.getDataTypes();

const users = dataTypes.dbTable('users', {
  id: dataTypes.dbSerial('id').primaryKey(),
  name: dataTypes.dbText('name').notNull(),
  email: dataTypes.dbText('email').notNull().unique(),
  profile: dataTypes.dbJsonb('profile'),
  searchVector: dataTypes.dbTsVector('search_vector'),
  createdAt: dataTypes.dbTimestampTz('created_at').defaultNow()
});

const posts = dataTypes.dbTable('posts', {
  id: dataTypes.dbSerial('id').primaryKey(),
  userId: dataTypes.dbInteger('user_id')
    .references(() => users.id),
  title: dataTypes.dbText('title').notNull(),
  content: dataTypes.dbText('content').notNull(),
  tags: dataTypes.dbArray('tags', { type: 'text' }),
  metadata: dataTypes.dbJsonb('metadata'),
  published: dataTypes.dbBoolean('published').default(false),
  createdAt: dataTypes.dbTimestampTz('created_at').defaultNow()
});

基本 CRUD 操作

import { eq, and, or, desc, sql } from 'drizzle-orm';

const connection = await adapter.getConnection();
const client = connection.getClient();

try {
  // INSERT
  // Single insert with returning
  const [newUser] = await client
    .insert(users)
    .values({
      name: 'John Doe',
      email: '[email protected]',
      profile: { bio: 'Hello!' }
    })
    .returning();

  // Bulk insert
  await client
    .insert(posts)
    .values([
      {
        userId: newUser.id,
        title: 'First Post',
        content: 'Hello, world!',
        tags: ['hello', 'first']
      },
      {
        userId: newUser.id,
        title: 'Second Post',
        content: 'Another post',
        tags: ['second']
      }
    ]);

  // SELECT
  // Select all
  const allUsers = await client
    .select()
    .from(users);

  // Select with conditions
  const user = await client
    .select()
    .from(users)
    .where(eq(users.email, '[email protected]'));

  // Select with join and array operations
  const postsWithTags = await client
    .select({
      userName: users.name,
      postTitle: posts.title,
      tags: posts.tags
    })
    .from(posts)
    .leftJoin(users, eq(posts.userId, users.id))
    .where(sql`${posts.tags} && ARRAY['hello']::text[]`)
    .orderBy(desc(posts.createdAt));

  // Full-text search
  const searchResults = await client
    .select()
    .from(posts)
    .where(sql`to_tsvector('english', ${posts.title} || ' ' || ${posts.content}) @@ to_tsquery('english', 'hello')`)
    .orderBy(desc(posts.createdAt));

  // UPDATE
  // Update with JSONB operations
  await client
    .update(users)
    .set({
      profile: sql`${users.profile} || '{"title": "New Title"}'::jsonb`
    })
    .where(eq(users.id, newUser.id));

  // DELETE
  await client
    .delete(posts)
    .where(
      and(
        eq(posts.userId, newUser.id),
        eq(posts.published, false)
      )
    );

} finally {
  await connection.disconnect();
}

高级特性

交易支持

const connection = await adapter.getConnection();
const client = connection.getClient();

try {
  await client.transaction(async (tx) => {
    const [user] = await tx
      .insert(users)
      .values({
        name: 'John Doe',
        email: '[email protected]'
      })
      .returning();

    await tx
      .insert(posts)
      .values({
        userId: user.id,
        title: 'My First Post',
        content: 'Hello, world!'
      });
  });
} finally {
  await connection.disconnect();
}

流出结果

postgres.js 支持大型结果集的高效流 :

const stream = client
  .select()
  .from(posts)
  .where(eq(posts.published, true))
  .stream();

for await (const post of stream) {
  // Process each post
  console.log(post.title);
}

最佳做法

1. 连接管理: 总是尝试/最后使用以确保连接被关闭
2. 交易: 相关业务使用交易
3. 发言稿: 自动准备发言
4. 处理错误: 执行适当的错误处理
5. 查询优化: 使用索引和适当的查询规划

捐款

我们欢迎捐款! 请随意提交拉力请求 对于重大变动,请先开出一个问题来讨论你想要改变什么.

相关软件包

• @ 细雨适应器/ 核心 - 核心接口和类型
• @ 细雨适应器/ pg- core - 共享 PostgreSQL 功能
• @ 细雨- 适应器/ 节点- 张贴 - 替代PostgreSQL适配器