smartdata/dist/smartdata.classes.db.d.ts

32 lines
1.1 KiB
TypeScript
Raw Normal View History

2017-07-15 22:11:03 +00:00
import * as plugins from './smartdata.plugins';
import { Objectmap } from 'lik';
import { DbTable } from './smartdata.classes.dbcollection';
import { ConnectionOptions } from 'rethinkdb';
2017-07-15 22:11:03 +00:00
/**
* interface - indicates the connection status of the db
*/
export declare type TConnectionStatus = 'initial' | 'disconnected' | 'connected' | 'failed';
2017-07-15 22:11:03 +00:00
export declare class Db {
dbName: string;
connectionOptions: plugins.rethinkDb.ConnectionOptions;
2018-01-07 16:26:34 +00:00
dbConnection: plugins.rethinkDb.Connection;
2017-07-15 22:11:03 +00:00
status: TConnectionStatus;
dbTablesMap: Objectmap<DbTable<any>>;
constructor(connectionOptionsArg: ConnectionOptions);
2017-07-15 22:11:03 +00:00
/**
* connects to the database that was specified during instance creation
*/
connect(): Promise<any>;
/**
* closes the connection to the databse
*/
close(): Promise<any>;
/**
* Gets a table's name and returns smartdata's DbTable class
* @param nameArg
* @returns DbTable
2017-07-15 22:11:03 +00:00
*/
getDbTableByName<T>(nameArg: string): Promise<DbTable<T>>;
addTable(dbCollectionArg: DbTable<any>): void;
2017-07-15 22:11:03 +00:00
}