Beignet API reference
    Preparing search index...
    • Create a Drizzle SQLite provider factory.

      This factory creates a service provider that:

      • Uses libSQL via @libsql/client, for local file: SQLite databases and Turso's hosted libSQL service
      • Uses Drizzle ORM via drizzle-orm/libsql
      • Exposes a typed DbPort on ports
      • Uses SQLITE_-prefixed env vars for connection config

      Type Parameters

      • TSchema extends Record<string, unknown>

        The Drizzle schema type (inferred from the schema parameter)

      • PortName extends string = "db"

      Parameters

      • options: DrizzleSqliteProviderBaseOptions<TSchema, PortName> & {
            client: Client;
            closeOnStop?: boolean;
        }

        Configuration options including the schema

      Returns InjectedDrizzleSqliteProvider<TSchema, PortName>

      A service provider that can be used with createNextServer

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

      export const drizzleSqliteProvider = createDrizzleSqliteProvider({ schema });
    • Create a Drizzle SQLite provider factory.

      This factory creates a service provider that:

      • Uses libSQL via @libsql/client, for local file: SQLite databases and Turso's hosted libSQL service
      • Uses Drizzle ORM via drizzle-orm/libsql
      • Exposes a typed DbPort on ports
      • Uses SQLITE_-prefixed env vars for connection config

      Type Parameters

      • TSchema extends Record<string, unknown>

        The Drizzle schema type (inferred from the schema parameter)

      • PortName extends string = "db"

      Parameters

      • options: DrizzleSqliteProviderBaseOptions<TSchema, PortName> & {
            client?: undefined;
            closeOnStop?: undefined;
        }

        Configuration options including the schema

      Returns DrizzleSqliteProvider<TSchema, PortName>

      A service provider that can be used with createNextServer

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

      export const drizzleSqliteProvider = createDrizzleSqliteProvider({ schema });