Skip to content
This repository has been archived by the owner on Apr 19, 2020. It is now read-only.
/ database-sqlite Public archive

Synor Database Engine - SQLite

License

Notifications You must be signed in to change notification settings

Synor/database-sqlite

Repository files navigation

Synor Database Version Test Coverage License

Synor Database SQLite

Synor Database Engine - SQLite

Installation

# using yarn:
yarn add @synor/database-sqlite

# using npm:
npm install --save @synor/database-sqlite

URI

Format: sqlite://[.]/path[?param=value&...]

Params:

Name Description Default Value
schema SQLite Schema name main
synor_migration_record_table Name for Migration Record Table synor_migration_record
file_must_exist Error will be thrown if the database file does not exist false
memory Open an in-memory database, rather than a disk-bound one false
readonly Open the database connection in readonly mode false
timeout Number of milliseconds to wait before throwing a SQLITE_BUSY error 5000

Examples:

  • sqlite:///path/to/sqlite.db (Absolute path)
  • sqlite://./path/to/sqlite.db (Relative path)
  • sqlite://?memory=true (Open an in-memory database)

License

Licensed under the MIT License. Check the LICENSE file for details.