Registry / database / clay-driver-sqlite

clay-driver-sqlite

library6.3.25jsnpmunverified

A SQLite driver for the ClayDB ecosystem (v6.3.25). It provides a SqliteDriver class that extends SequelizeDriver, enabling persistent storage in SQLite databases. The package is part of the ClayDB framework, offering a simple API for creating database connections via constructor or factory function. It supports logging and benchmarking options. Suitable for Node.js >=7.6. Released under Apache-2.0. Maintained but with low activity; last release was recent.

database

npm install clay-driver-sqlite

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · CLAY-DRIVER-SQLITE

clay-driver-sqlite

databasejavascriptv6.3.25

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SqliteDriver

✓ const { SqliteDriver } = require('clay-driver-sqlite')

✗ const SqliteDriver = require('clay-driver-sqlite')

Named export, not default. Also works with ES modules via import { SqliteDriver } from 'clay-driver-sqlite'.

create

✓ const { create } = require('clay-driver-sqlite')

✗ const create = require('clay-driver-sqlite').create

Factory function for creating a SqliteDriver instance.

default import

✓ import { SqliteDriver } from 'clay-driver-sqlite'

✗ import SqliteDriver from 'clay-driver-sqlite'

ESM named import; there is no default export.

Creates a SqliteDriver instance and a clayLump, then stores and retrieves a record.

const { SqliteDriver } = require('clay-driver-sqlite'); const clayLump = require('clay-lump'); const driver = new SqliteDriver('var/lump/app.db', { logging: false, benchmark: false }); const lump = clayLump({ driver }); // Use the lump to store/retrieve data const data = { id: 1, message: 'Hello' }; lump.set(data).then(() => { return lump.get(1); }).then(result => { console.log(result); // { id: 1, message: 'Hello' } }).catch(err => { console.error(err); });

Debug

Known issues

gotchaRequires clay-lump to be installed separately — SqliteDriver alone does not create a database connection without a lump.

fix

Install clay-lump alongside: npm install clay-lump

affects: >=1.0.0

deprecatedThe create() function is still available but may be deprecated in future releases; use new SqliteDriver() instead.

fix

Use new SqliteDriver(filename, options) directly.

affects: >=6.0.0

gotchaSequelize must be installed as a peer dependency — missing sequelize will cause runtime errors.

fix

Install sequelize: npm install sequelize

affects: >=6.0.0

gotchaFilename path is relative to the working directory — not relative to the script file.

fix

Use absolute path or path.join(__dirname, 'var/lump/app.db') for predictable behavior.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'clay-driver-sqlite'

Package not installed or missing dependency.

fix

Run 'npm install clay-driver-sqlite --save'

TypeError: SqliteDriver is not a constructor

Incorrect import style: using default import instead of destructured.

fix

Use 'const { SqliteDriver } = require('clay-driver-sqlite')'

Error: Cannot find module 'sequelize'

Sequelize is a peer dependency not installed.

fix

Run 'npm install sequelize'

TypeError: clayLump is not a function

Missing clay-lump import or incorrect import.

fix

Install clay-lump and import: 'const clayLump = require('clay-lump')'

Upgrade

Version history

6.3.25latest on npm

Audit

Dependencies

clay-lumpoptionalRequired for lump creation; SqliteDriver is used with clay-lump

sequelizeoptionalSequelizeDriver is the base class; must be installed separately

Agent activity

15 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/realglobe-Inc/clay-driver-sqlite ↗

packageclay-driver-sqlite ↗

homepagehttps://github.com/realglobe-Inc/clay-driver-sqlite#readme ↗