Lucid CMS - LibSQL Adapter

The official LibSQL adapter for Lucid CMS

The Lucid CMS LibSQL adapter allows you to use LibSQL as your database. This registers a slightly modified version of the LibSQL dialect for Kysely.

Installation

npm install @lucidcms/libsql-adapter

Setup

To use the LibSQL adapter, you must add it to your Lucid CMS configuration file. You'll need to provide the database URL and, optionally, an authentication token.

import { nodeAdapter, defineConfig } from "@lucidcms/node-adapter";
import LibSQLAdapter from "@lucidcms/libsql-adapter";

export const adapter = nodeAdapter();

export default defineConfig((env) => ({
    db: new LibSQLAdapter({
        url: env.LIBSQL_URL,
        authToken: env.LIBSQL_AUTH_TOKEN,
    }),
    // ...other config
}));

Configuration

The adapter accepts a configuration object with the following options:

| Property | Type | Description | |----------|------|-------------| | url * | string | The LibSQL database URL (e.g., libsql://your-database.turso.io) | | authToken | string | Authentication token for accessing the database |