5.0.2 • Published 5 months ago

fastify-sqlite-typed v5.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

Fastify SQLite Typed Plugin

Beta npm version js-standard-style License

SQLite integration plugin for Fastify

Effortlessly incorporate SQLite databases into your Fastify applications using fastify-sqlite-typed. This plugin leverages node-sqlite3 and node-sqlite for effective database operations.

For Fastify V 4.X.X click here

Additional Resources

Features

  • Seamless integration with Fastify applications
  • Configurable SQLite driver
  • Multiple database modes supported
  • Debugging capabilities with query tracing
  • Support for both in-memory and disk-based databases

Installation

npm install fastify-sqlite-typed
# or
yarn add fastify-sqlite-typed

Usage

Import and register the plugin with your Fastify instance, and execute a sample query:

import fastify from "fastify";
// With fastify-plugin
import { fpSqlitePlugin } from "fastify-sqlite-typed"; 
// Without fastify-plugin
// import { sqlitePlugin } from "fastify-sqlite-typed";

const app = fastify();

app.register(fpSqlitePlugin, {
  dbFilename: "./myDB.db",
  // additional options
});

// Example query
app.get("/users", async (request, reply) => {
  const users = await app.db.all("SELECT * FROM users");
  reply.send(users);
});

fastify.listen({ port: 3000 }, (err, address) => {
  if (err) throw err
})

Options

OptionDescriptionTypeDefault
dbFilenamePath to the database file (:memory: for in-memory, "" for disk-based).StringNone
modeDatabase mode, combining Dbmode values.DbmodeREADWRITE \| CREATE \| FULLMUTEX
driverSettingsSettings for the SQLite driver (see DriverSettings below).ObjectDefault settings

DriverSettings

OptionDescriptionTypeDefault
verboseEnables verbose mode for detailed stack traces.Booleanfalse
cachedEnables database object caching.Booleanfalse
traceFunction to run on each query execution.FunctionNone

License

Licensed under MIT.

5.0.2

5 months ago

5.0.1

5 months ago

5.0.0

5 months ago

0.1.1

1 year ago

0.1.0

1 year ago