Interface DatabaseOptions

Database connection options.

interface DatabaseOptions {
    url?: string;
    file?: string;
    postgres?: PostgresAdapterOptions;
    mobile?: CapacitorAdapterOptions;
    type?:
        | "memory"
        | "sqlite"
        | "postgres"
        | "browser"
        | "mobile";
    priority?: AdapterKind[];
}

Properties

url? file? postgres? mobile? type? priority?

Properties

Optionalurl

url?: string

Database URL (e.g., postgresql://user:pass@host/db). If provided, PostgreSQL will be used.

Optionalfile

file?: string

File path for SQLite database. Used for local/offline storage.

Optionalpostgres

postgres?: PostgresAdapterOptions

PostgreSQL-specific configuration. Automatically uses PostgreSQL when provided.

Optionalmobile

mobile?: CapacitorAdapterOptions

Mobile (Capacitor) configuration. Automatically detected on mobile platforms.

Optionaltype

type?:
    | "memory"
    | "sqlite"
    | "postgres"
    | "browser"
    | "mobile"

Force a specific database type. Leave empty to auto-detect.

Optionalpriority

priority?: AdapterKind[]

Custom priority order for adapter selection. Advanced: Only use if you need fine-grained control.

Settings

Member Visibility

On This Page

Properties