Class DatabaseAdapter

Hierarchy

Adapter
Adapter
- DatabaseAdapter

Index

Constructors

constructor

Properties

listeners

Accessors

Constructors

constructor

new DatabaseAdapter(options: any): DatabaseAdapter
new DatabaseAdapter(options: any): DatabaseAdapter

Overrides Adapter.constructor
- Defined in adapters/DatabaseAdapter.ts:3
Parameters
- options: any
Returns DatabaseAdapter
- Defined in adapters/DatabaseAdapter.d.ts:2
Parameters
- options: any
Returns DatabaseAdapter

Properties

listeners

listeners: EventListener[] = []

Accessors

maxListeners

get maxListeners(): number
set maxListeners(value: number): void

Inherited from EventEmitter.maxListeners

Overrides EventEmitter.maxListeners
- Defined in /home/travis/build/bdfoster/nomatic-data/node_modules/nomatic-events/src/EventEmitter.ts:18
Returns number
Inherited from EventEmitter.maxListeners

Overrides EventEmitter.maxListeners
- Defined in /home/travis/build/bdfoster/nomatic-data/node_modules/nomatic-events/src/EventEmitter.ts:22
Parameters
- value: number
Returns void

name

get name(): string
set name(name: string): void

Inherited from Adapter.name

Overrides Adapter.name
- Defined in adapters/Adapter.ts:17
Returns string
Inherited from Adapter.name

Overrides Adapter.name
- Defined in adapters/Adapter.ts:21
Parameters
- name: string
Returns void

Methods

Abstract createCollection

createCollection(name: string): Promise<boolean>

Inherited from Adapter.createCollection

Overrides Adapter.createCollection
- Defined in adapters/Adapter.ts:28
Create a collection to store records.

Parameters
- name: string
Returns Promise<boolean>

Abstract createDatabase

createDatabase(name?: string): Promise<boolean>
createDatabase(name?: string): Promise<boolean>

- Defined in adapters/DatabaseAdapter.ts:8
Parameters
- Optional name: string
Returns Promise<boolean>
- Defined in adapters/DatabaseAdapter.d.ts:4
Parameters
- Optional name: string
Returns Promise<boolean>

Abstract dropCollection

dropCollection(name: string): Promise<boolean>

Inherited from Adapter.dropCollection

Overrides Adapter.dropCollection
- Defined in adapters/Adapter.ts:39
Drop a collection.

Parameters
- name: string
Returns Promise<boolean>

Abstract dropDatabase

dropDatabase(name: string): any
dropDatabase(name: string): any

- Defined in adapters/DatabaseAdapter.ts:12
Parameters
- name: string
Returns any
- Defined in adapters/DatabaseAdapter.d.ts:6
Parameters
- name: string
Returns any

emit

emit(namespace: string, ...data: any[]): void

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/travis/build/bdfoster/nomatic-data/node_modules/nomatic-events/src/EventEmitter.ts:78
Parameters
- namespace: string
- Rest ...data: any[]
Returns void

Abstract ensureCollectionExists

ensureCollectionExists(name: string): Promise<boolean>

Inherited from Adapter.ensureCollectionExists

Overrides Adapter.ensureCollectionExists
- Defined in adapters/Adapter.ts:34
Ensure that a collection exists. This method must be guaranteed not to throw if the collection already exists.

Parameters
- name: string
Returns Promise<boolean>

Abstract ensureDatabaseExists

ensureDatabaseExists(name?: string): Promise<boolean>
ensureDatabaseExists(name?: string): Promise<boolean>

- Defined in adapters/DatabaseAdapter.ts:10
Parameters
- Optional name: string
Returns Promise<boolean>
- Defined in adapters/DatabaseAdapter.d.ts:5
Parameters
- Optional name: string
Returns Promise<boolean>

Abstract findAll

findAll(collection: string, query?: Query): Promise<RecordData[]>

Inherited from Adapter.findAll

Overrides Adapter.findAll
- Defined in adapters/Adapter.ts:48
Parameters
- collection: string
- Optional query: Query
Returns Promise<RecordData[]>

Abstract get

get(collection: string, id: string): Promise<RecordData>

Inherited from Adapter.get

Overrides Adapter.get
- Defined in adapters/Adapter.ts:41
Parameters
- collection: string
- id: string
Returns Promise<RecordData>

Abstract getCollectionNames

getCollectionNames(): Promise<string[]>

Inherited from Adapter.getCollectionNames

Overrides Adapter.getCollectionNames
- Defined in adapters/Adapter.ts:46
Get the name of each collection already defined.

Returns Promise<string[]>

Abstract getDatabaseNames

getDatabaseNames(): Promise<string[]>
getDatabaseNames(): Promise<string[]>

- Defined in adapters/DatabaseAdapter.ts:14
Returns Promise<string[]>
- Defined in adapters/DatabaseAdapter.d.ts:7
Returns Promise<string[]>

Abstract insert

insert(collection: string, data: RecordData): Promise<RecordData>

Inherited from Adapter.insert

Overrides Adapter.insert
- Defined in adapters/Adapter.ts:50
Parameters
- collection: string
- data: RecordData
Returns Promise<RecordData>

Abstract insertAll

insertAll(collection: string, data: RecordData[]): Promise<RecordData[]>

Inherited from Adapter.insertAll

Overrides Adapter.insertAll
- Defined in adapters/Adapter.ts:52
Parameters
- collection: string
- data: RecordData[]
Returns Promise<RecordData[]>

load

load(): Promise<boolean>

Inherited from Adapter.load

Overrides Adapter.load
- Defined in adapters/Adapter.ts:57
Establish a connection and/or do anything needed in order to accept queries.

Returns Promise<boolean>

on

on(namespace: string | RegExp, callback: Function, once?: boolean): EventListener

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/travis/build/bdfoster/nomatic-data/node_modules/nomatic-events/src/EventEmitter.ts:39
Subscribe a callable function to a namespace.

Parameters
- namespace: string | RegExp
- callback: Function
- Default value once: boolean = false
Returns EventListener

Used to manage the subscription status via open and close methods.

once

once(namespace: string | RegExp, callback: Function): EventListener

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/travis/build/bdfoster/nomatic-data/node_modules/nomatic-events/src/EventEmitter.ts:52
Subscribe a callable function to a namespace, for exactly one execution.

Parameters
- namespace: string | RegExp
- callback: Function
Returns EventListener

Used to manage the subscription status via open and close methods.

pop

pop(listener: EventListener): boolean

Inherited from EventEmitter.pop

Overrides EventEmitter.pop
- Defined in /home/travis/build/bdfoster/nomatic-data/node_modules/nomatic-events/src/EventEmitter.ts:69
Remove a Listener instance from the EventNamespace instance. Called with unsubscribe method.

Parameters
- listener: EventListener
Returns boolean

A true value indicates a successful pop.

push

push(listener: EventListener): void

Inherited from EventEmitter.push

Overrides EventEmitter.push
- Defined in /home/travis/build/bdfoster/nomatic-data/node_modules/nomatic-events/src/EventEmitter.ts:60
Add a Listener instance to the EventNamespace instance. Called with subscribe method.

Parameters
- listener: EventListener
Returns void

Abstract remove

remove(collection: string, id: string): Promise<RecordData>

Inherited from Adapter.remove

Overrides Adapter.remove
- Defined in adapters/Adapter.ts:61
Parameters
- collection: string
- id: string
Returns Promise<RecordData>

Abstract replace

replace(collection: string, id: string, data: RecordData, rev?: string): Promise<RecordData>

Inherited from Adapter.replace

Overrides Adapter.replace
- Defined in adapters/Adapter.ts:63
Parameters
- collection: string
- id: string
- data: RecordData
- Optional rev: string
Returns Promise<RecordData>

Abstract truncateCollection

truncateCollection(name: string): Promise<boolean>

Inherited from Adapter.truncateCollection

Overrides Adapter.truncateCollection
- Defined in adapters/Adapter.ts:69
Remove all records from the collection, but keep the collection itself and all related settings.

Parameters
- name: string
Returns Promise<boolean>

Abstract truncateDatabase

truncateDatabase(name?: string): Promise<boolean>
truncateDatabase(name?: string): Promise<boolean>

- Defined in adapters/DatabaseAdapter.ts:16
Parameters
- Optional name: string
Returns Promise<boolean>
- Defined in adapters/DatabaseAdapter.d.ts:8
Parameters
- Optional name: string
Returns Promise<boolean>

Abstract update

update(collection: string, id: string, data: RecordData): Promise<RecordData>

Inherited from Adapter.update

Overrides Adapter.update
- Defined in adapters/Adapter.ts:71
Parameters
- collection: string
- id: string
- data: RecordData
Returns Promise<RecordData>