Class OINODbFactory

Static factory class for easily creating things based on data

Index

Constructors

Methods

createApi createDb registerDb

Constructors

constructor

new OINODbFactory(): OINODbFactory
Returns OINODbFactory

Methods

`Static`createApi

createApi(db: OINODb, params: OINOApiParams): Promise<OINODbApi>
Create API from parameters and calls initDatamodel on the datamodel.
Parameters
- db: OINODb
  databased used in API
- params: OINOApiParams
  parameters of the API
Returns Promise<OINODbApi>
- Defined in db/src/OINODbFactory.ts:69

`Static`createDb

createDb(
    params: OINODbParams,
    connect?: boolean,
    validate?: boolean,
): Promise<OINODb>
Create database from parameters from the registered classes.
Parameters
- params: OINODbParams
  database connection parameters
- connect: boolean = true
  if true, connects to the database
- validate: boolean = true
  if true, validates the database connection
Returns Promise<OINODb>
- Defined in db/src/OINODbFactory.ts:39

`Static`registerDb

registerDb(dbName: string, dbTypeClass: OINODbConstructor): void
Register a supported database class. Used to enable those that are installed in the factory instead of forcing everyone to install all database libraries.
Parameters
- dbName: string
  name of the database implementation class
- dbTypeClass: OINODbConstructor
  constructor for creating a database of that type
Returns void
- Defined in db/src/OINODbFactory.ts:28