Class SqlDataSourceAdapter<T>

Data source defining how to connect to an manipulate data from a sqlite file

Type parameters

T

Hierarchy

SqlDataSourceAdapter

Implements

DataAdapter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SqlDataSourceAdapter(store: Store<ModelState>, filename: string): SqlDataSourceAdapter
new SqlDataSourceAdapter(store: Store<T>, filename: string, _selector: function): SqlDataSourceAdapter

- Defined in adapters/sql.ts:14
Instantiates a connection obejct, and adds a new data source to the store

Parameters
- store: Store<ModelState>
  
  The store to dispatch events to
- filename: string
  
  The database file to read
Returns SqlDataSourceAdapter
- Defined in adapters/sql.ts:21
Instantiates a connection obejct, and adds a new data source to the store

Parameters
- store: Store<T>
  
  The store to dispatch events to
- filename: string
  
  The database file to read
- _selector: function
  
  A selector function defining how to find the ModelState fragment of state T
  - - (s: T): ModelState
    - Parameters
      - s: T
      Returns ModelState
Returns SqlDataSourceAdapter

Properties

Private _conn

_conn: Knex

Private _selector

_selector: function

A selector function defining how to find the ModelState fragment of state T

Type declaration

- (s: T): ModelState
- Parameters
  - s: T
  Returns ModelState

id

id: DataSourceId

Private store

store: Store<T>

The store to dispatch events to

Methods

assertConnection

assertConnection(): void

- Defined in adapters/sql.ts:66
Asserts that the connection is present

Returns void

defaultFieldSelection

defaultFieldSelection(selectNumber?: number): Promise<void>

- Defined in adapters/sql.ts:46
Asynchronously fetches some number of fields and sets them as active inside the model Resolves when the action adding all the default fields has been dispatched

Parameters
- Default value selectNumber: number = 2
Returns Promise<void>

describeColumns

describeColumns(table: string): Promise<any>

- Defined in adapters/sql.ts:90
Returns a promise to a list of the columns in a given table in a sql db

Parameters
- table: string
Returns Promise<any>

describeTables

describeTables(): Promise<any>

- Defined in adapters/sql.ts:73
Returns a promise to a list of the tables in the sql db

Returns Promise<any>

remove

remove(): Promise<void>

Implementation of DataAdapter.remove
- Defined in adapters/sql.ts:136
Removes the data source associated with this adapter from the store and destroys the connection

Returns Promise<void>

updateCache

updateCache(): Promise<Array<any>>

Implementation of DataAdapter.updateCache
- Defined in adapters/sql.ts:109
Given the fields selected in the store, updates the cached data in the store fore those fields Resolves when the action updating the data in the store has been dispatched

Returns Promise<Array<any>>

Generated using TypeDoc