The SQLite3 connector enables LoopBack applications to connect to SQLite3 data sources.Note: This page was generated from the loopback-connector-sqlite3/README.md.

loopback-connector-sqlite3

SQLite is a self-contained, high-reliability, embedded, full-featured, public-domain, SQL database engine. This is the official SQLite3 connector module for the LoopBack framework.

Installation

Enter the following in the top-level directory of your LoopBack application:

  1. $ npm install loopback-connector-sqlite3 --save

The —save option adds the dependency to the application’s package.json file.

Connector settings

Configure the connector with the following data source properties:

  • file: The path to the database file or :memory:
  • debug: Display debug information. Default is false.The SQLite3 connector uses node-sqlite3 as the driver.

Model definition for SQLite3

The model definition consists of the following properties:

  • name: Name of the model, by default, it’s the camel case of the table
  • properties: Property definitions, including default value mapping
  2.     {"name": "Inventory", "options": {
  3.       "idInjection": false,
  4.     }, "properties": {
  5.       "id": {
  6.         "type": "String",
  7.         "required": false,
  8.         "length": 64,
  9.         "precision": null,
  10.         "scale": null
  11.       },
  12.       "productId": {
  13.         "type": "String",
  14.         "required": false,
  15.         "length": 20,
  16.         "precision": null,
  17.         "scale": null,
  18.         "id": 1
  19.       },
  20.       "locationId": {
  21.         "type": "String",
  22.         "required": false,
  23.         "length": 20,
  24.         "precision": null,
  25.         "scale": null,
  26.         "id": 1
  27.       },
  28.       "available": {
  29.         "type": "Number",
  30.         "required": false,
  31.         "length": null,
  32.         "precision": 32,
  33.         "scale": 0
  34.       },
  35.       "total": {
  36.         "type": "Number",
  37.         "required": false,
  38.         "length": null,
  39.         "precision": 32,
  40.         "scale": 0
  41.       },
  42.       "createdOn": {
  43.        "type": "Date",
  44.         "required": false,
  45.         "sqlite3": {
  46.           "dbDefault": "now"
  47.         }
  48.       }
  49.     }}

Type Mapping

LoopBack typeMapped to SQLite3 type
NumberPrimary key stored as INTEGER, others as REAL
BooleanINTEGER 1 or 0
DateINTEGER (ms since Jan 01 1970 00:00:00 0000)
String?
Complex types: GeoPoint, Point, List, Array, Object, and sub-modelsTEXT in JSON format
JSONTEXT

SQLite3 does not enforce types. Any data can be stored in any column regardless of definiton.This connector attempts to check for invalid Date, Number and JSON types.

Unsupported features

Discovering Models

The SQLite3 connector does not currently support model discovery.

Auto Migrate / Auto Update

The SQLite3 connector does not currently support auto-migrate or auto-upgrade.

Running tests

The tests in this repository are mainly integration tests, meaning you will needto run them using our preconfigured test server.

  • Ask a core developer for instructions on how to set up test servercredentials on your machine
  • npm testTags: readme