Beignet API reference
    Preparing search index...

    Function createDrizzlePostgresProvider

    • Create a Drizzle Postgres provider factory.

      This factory creates a service provider that:

      • Uses a node-postgres (pg) connection pool
      • Uses Drizzle ORM via drizzle-orm/node-postgres
      • Exposes a typed DbPort on ports
      • Uses POSTGRES_-prefixed env vars for connection config

      The pool connects lazily, so provider setup does not open a connection.

      Type Parameters

      • TSchema extends Record<string, unknown>

        The Drizzle schema type (inferred from the schema parameter)

      • PortName extends string = "db"

      Parameters

      • options: DrizzlePostgresProviderBaseOptions<TSchema, PortName> & {
            client: Pool;
            closeOnStop?: boolean;
            pool?: undefined;
        }

        Configuration options including the schema

      Returns InjectedDrizzlePostgresProvider<TSchema, PortName>

      A service provider that can be used with createNextServer

      import * as schema from "@/db/schema";
      import { createDrizzlePostgresProvider } from "@beignet/provider-db-drizzle/postgres";

      export const drizzlePostgresProvider = createDrizzlePostgresProvider({ schema });

    • Create a Drizzle Postgres provider factory.

      This factory creates a service provider that:

      • Uses a node-postgres (pg) connection pool
      • Uses Drizzle ORM via drizzle-orm/node-postgres
      • Exposes a typed DbPort on ports
      • Uses POSTGRES_-prefixed env vars for connection config

      The pool connects lazily, so provider setup does not open a connection.

      Type Parameters

      • TSchema extends Record<string, unknown>

        The Drizzle schema type (inferred from the schema parameter)

      • PortName extends string = "db"

      Parameters

      • options: DrizzlePostgresProviderBaseOptions<TSchema, PortName> & {
            client?: undefined;
            closeOnStop?: undefined;
            pool?: Omit<PoolConfig, "connectionString">;
        }

        Configuration options including the schema

      Returns DrizzlePostgresProvider<TSchema, PortName>

      A service provider that can be used with createNextServer

      import * as schema from "@/db/schema";
      import { createDrizzlePostgresProvider } from "@beignet/provider-db-drizzle/postgres";

      export const drizzlePostgresProvider = createDrizzlePostgresProvider({ schema });

    Settings
    Member Visibility