dal-lite v0.1.1

dal-lite

Modules

dals/sqlite3

• dals/sqlite3
  • ~SqliteDal ⇐ Dal
    • .type
    • .connect()
    • .tableExists()
    • .createTable()
    • .dropTable()
    • .exec()
    • .query()
    • .quoteIdentifier()
    • .quoteValue()
    • .insert()
    • .update()
    • .select()
    • .delete()
    • .close()

dals/sqlite3~SqliteDal ⇐ Dal

DAL that connects to sqlite3 databases

Kind: inner class of dals/sqlite3
Extends: Dal
See: module:index~Dal

• ~SqliteDal ⇐ Dal
  • .type
  • .connect()
  • .tableExists()
  • .createTable()
  • .dropTable()
  • .exec()
  • .query()
  • .quoteIdentifier()
  • .quoteValue()
  • .insert()
  • .update()
  • .select()
  • .delete()
  • .close()

sqliteDal.type

Kind: instance property of SqliteDal
See: module:index.Dal#type

sqliteDal.connect()

Kind: instance method of SqliteDal
See: Dal.connect

sqliteDal.tableExists()

Kind: instance method of SqliteDal
See: Dal.tableExists

sqliteDal.createTable()

Kind: instance method of SqliteDal
See: Dal.createTable

sqliteDal.dropTable()

Kind: instance method of SqliteDal
See: Dal.dropTable

sqliteDal.exec()

Kind: instance method of SqliteDal
See: Dal.exec

sqliteDal.query()

Kind: instance method of SqliteDal
See: Dal.query

sqliteDal.quoteIdentifier()

Kind: instance method of SqliteDal
See: Dal.quoteIdentifier

sqliteDal.quoteValue()

Kind: instance method of SqliteDal
See: Dal.quoteValue

sqliteDal.insert()

Kind: instance method of SqliteDal
See: Dal.insert

sqliteDal.update()

Kind: instance method of SqliteDal
See: Dal.update

sqliteDal.select()

Kind: instance method of SqliteDal
See: Dal.select

sqliteDal.delete()

Kind: instance method of SqliteDal
See: Dal.delete

sqliteDal.close()

Kind: instance method of SqliteDal
See: Dal.close

index

• index
  • ~Dal
    • new Dal(uri, [_options])
    • instance
      • .type ⇒ string
      • .connect([_options]) ⇒ Promise
      • .tableExists(table, [_options]) ⇒ Promise
      • .createTable(table, tableDef, [_options]) ⇒ Promise
      • .alterTable(table, defChanges, [_options]) ⇒ Promise
      • .dropTable(table, [_options]) ⇒ Promise
      • .quoteIdentifier(name, [_options]) ⇒ string
      • .quoteValue(value, type, [_options]) ⇒ string
      • .exec(sql, [_options]) ⇒ Promise
      • .query(sql, [_options]) ⇒ Promise
      • .insert(into, values, [_options]) ⇒ Promise
      • .update(table, changes, [_options]) ⇒ Promise
      • .select(columns, from, [_options]) ⇒ Promise
      • .delete(from, [_options]) ⇒ Promise
      • .applyDataDefinition(def, [_options]) ⇒ Promise
      • .close() ⇒ Promise
    • static
      • .getDal(uri, [_options]) ⇒ Dal
  • ~TableSpec : string | object | Array.<string>
  • ~ColumnDef : object
  • ~PrimaryKeyDef : string | Array.<string>
  • ~ForeignKeyDef : object
  • ~TableDef : object
  • ~IndexDef : object
  • ~ViewDef : object
  • ~DataDef : object
  • ~ChangeDef : object

index~Dal

Abstract class that selects a DAL for a given connection string (URI) via @function getDal

Kind: inner class of index

• ~Dal
  • new Dal(uri, [_options])
  • instance
    • .type ⇒ string
    • .connect([_options]) ⇒ Promise
    • .tableExists(table, [_options]) ⇒ Promise
    • .createTable(table, tableDef, [_options]) ⇒ Promise
    • .alterTable(table, defChanges, [_options]) ⇒ Promise
    • .dropTable(table, [_options]) ⇒ Promise
    • .quoteIdentifier(name, [_options]) ⇒ string
    • .quoteValue(value, type, [_options]) ⇒ string
    • .exec(sql, [_options]) ⇒ Promise
    • .query(sql, [_options]) ⇒ Promise
    • .insert(into, values, [_options]) ⇒ Promise
    • .update(table, changes, [_options]) ⇒ Promise
    • .select(columns, from, [_options]) ⇒ Promise
    • .delete(from, [_options]) ⇒ Promise
    • .applyDataDefinition(def, [_options]) ⇒ Promise
    • .close() ⇒ Promise
  • static
    • .getDal(uri, [_options]) ⇒ Dal

new Dal(uri, _options)

dal.type ⇒ string

Gets the underlying DAL type of this DAL

Kind: instance abstract property of Dal
Returns: string - The underlying DAL type

dal.connect(_options) ⇒ Promise

Connects the specified database. This is only necessary if you specified connect=false in the options to getDal

Kind: instance abstract method of Dal

dal.tableExists(table, _options) ⇒ Promise

Checks if a table exists

Kind: instance abstract method of Dal

dal.createTable(table, tableDef, _options) ⇒ Promise

Creates a table from a given table definition

Kind: instance abstract method of Dal

dal.alterTable(table, defChanges, _options) ⇒ Promise

Alters an existing table to match a given table definition

Kind: instance abstract method of Dal
Returns: Promise - Promise that resolves when table is altered or rejects for errors

dal.dropTable(table, _options) ⇒ Promise

Kind: instance abstract method of Dal
Returns: Promise - Promise that resolves for successful table drop or rejects for errors

dal.quoteIdentifier(name, _options) ⇒ string

Quotes a given identifier (e.g. table, column name)

Kind: instance abstract method of Dal
Returns: string - Quoted name

dal.quoteValue(value, type, _options) ⇒ string

Quotes a given value according to a specified type

Kind: instance abstract method of Dal
Returns: string - Quoted value

dal.exec(sql, _options) ⇒ Promise

Executes a given SQL query that does not return data

Kind: instance abstract method of Dal
Returns: Promise - Promise that will resolve with no data or reject

dal.query(sql, _options) ⇒ Promise

Run a query that returns data from the database.

Kind: instance abstract method of Dal
Returns: Promise - Promise that resolves with data or rejects

dal.insert(into, values, _options) ⇒ Promise

Insert data into the database.

Kind: instance abstract method of Dal
Returns: Promise - Promise that resolves for a successful insert or rejects

dal.update(table, changes, _options) ⇒ Promise

Update data within the database.

Kind: instance abstract method of Dal
Returns: Promise - Promise that resolves for a successful update or rejects

dal.select(columns, from, _options) ⇒ Promise

Select data from the database

Kind: instance abstract method of Dal
Returns: Promise - Promise that resolves with returned data or rejects

dal.delete(from, _options) ⇒ Promise

Delete data from the database.

Kind: instance abstract method of Dal
Returns: Promise - Promise that resolves with a successful delete or rejects

dal.applyDataDefinition(def, _options) ⇒ Promise

Uses a DataDef to specify a desired database schema state.

Kind: instance method of Dal
Returns: Promise - Promise that resolves for successful application or rejects

dal.close() ⇒ Promise

Closes the connection to the database. The instance should not be used after this.

Kind: instance abstract method of Dal
Returns: Promise - Promise that resolves when the connection is closed or rejects for errors

Dal.getDal(uri, _options) ⇒ Dal

Given a connection string (URI) chooses a matching subclass of Dal that implements that database dialect and instantiates it

Kind: static method of Dal
Returns: Dal - The subclass of Dal for the database type specified by the uri

index~TableSpec : string | object | Array.<string>

Table specifier. Can be a string, an array or an object. If a string, the simple (no schema) name of the table. If an array, it must have a length of 2; the first element is the schema, the second element is the table name. If an object, it must have a property tableName that is the name of the table and an optional property schema that is the name of the schema.

Kind: inner typedef of index
Properties

index~ColumnDef : object

Column definition.

Kind: inner typedef of index
Properties

index~PrimaryKeyDef : string | Array.<string>

Primary key definition. Can be a column name or an array of column names.

Kind: inner typedef of index

index~ForeignKeyDef : object

Foreign key definition.

Kind: inner typedef of index
Properties

index~TableDef : object

Table definition.

Kind: inner typedef of index
Properties

index~IndexDef : object

Index definition.

Kind: inner typedef of index

index~ViewDef : object

View definition.

Kind: inner typedef of index

index~DataDef : object

Database schema definition.

Kind: inner typedef of index
Properties

index~ChangeDef : object

Change to apply to a table's data

Kind: inner typedef of index
Properties