data-table-sqlite

SQLite adapter for remix/data-table. Use this package when you want data-table APIs backed by better-sqlite3.

Features

• Native better-sqlite3 Integration: Works well for local and embedded deployments
• Full data-table API Support: Queries, relations, writes, and transactions
• Adapter-Owned Compiler: SQL compilation lives in this adapter, with optional shared pure helpers from data-table
• Migration DDL Support: Compiles and executes DataMigrationOperation operations for remix/data-table/migrations
• SQLite Capabilities Enabled By Default:
  • returning: true
  • savepoints: true
  • upsert: true
  • transactionalDdl: true
  • migrationLock: false

Installation

npm i remix better-sqlite3

Usage

import Database from 'better-sqlite3'
import { createDatabase } from 'remix/data-table'
import { createSqliteDatabaseAdapter } from 'remix/data-table-sqlite'

let sqlite = new Database('app.db')
let db = createDatabase(createSqliteDatabaseAdapter(sqlite))

This is a good fit for local development, embedded deployments, and single-node services. Import any driver-specific types you need directly from better-sqlite3.

Adapter Capabilities

data-table-sqlite reports this capability set by default:

• returning: true
• savepoints: true
• upsert: true
• transactionalDdl: true
• migrationLock: false

Advanced Usage

In-Memory Database For Tests

import Database from 'better-sqlite3'
import { createDatabase } from 'remix/data-table'
import { createSqliteDatabaseAdapter } from 'remix/data-table-sqlite'

let sqlite = new Database(':memory:')
let db = createDatabase(createSqliteDatabaseAdapter(sqlite))

Capability Overrides For Fallback Testing

import { createSqliteDatabaseAdapter } from 'remix/data-table-sqlite'

let adapter = createSqliteDatabaseAdapter(sqlite, {
  capabilities: {
    returning: false,
  },
})

Related Packages

• data-table - Core query/relations API
• data-schema - Schema parsing and validation
• data-table-postgres - PostgreSQL adapter
• data-table-mysql - MySQL adapter

License

See LICENSE