Class DBService

Database service.

Hierarchy

DBService

Index

Constructors

constructor

Properties

Constructors

constructor

new DBService(resourceService: ResourceService, userService: UserService, verifyService: VerifyService, passwordResetService: PasswordResetService): DBService

- Defined in src/services/db/db.service.ts:90
Parameters
- resourceService: ResourceService
- userService: UserService
- verifyService: VerifyService
- passwordResetService: PasswordResetService
Returns DBService

Properties

Private closed

closed: boolean = false

Private dbURL

dbURL: string = ...

Private logErrors

logErrors: boolean = true

Private pool

pool: Pool

Private sqlPath

sqlPath: string = ...

Private tables

tables: string[] = ...

Private testing

testing: boolean = !!parseInt(process.env.TESTING)

Methods

close

close(): Promise<void>

- Defined in src/services/db/db.service.ts:272
Close the connection to the database.

Returns Promise<void>

create

create<T>(tableName: string, fields: FieldMap): Promise<T>

- Defined in src/services/db/db.service.ts:417
Create a new record in the table.

Type parameters
- T
Parameters
- tableName: string
- fields: FieldMap
  
  Field values to create in the new record.
Returns Promise<T>

The new record.

deleteByFields

deleteByFields(tableName: string, fields: FieldMap): Promise<void>

- Defined in src/services/db/db.service.ts:648
Delete records matching provided query values.

Parameters
- tableName: string
- fields: FieldMap
  
  Fields to query by.
Returns Promise<void>

deleteByID

deleteByID(tableName: string, id: any): Promise<void>

- Defined in src/services/db/db.service.ts:636
Delete a record in the table by ID.

Parameters
- tableName: string
- id: any
  
  The record's ID.
Returns Promise<void>

deleteCustom

deleteCustom(tableName: string, whereClause: string, params?: any[]): Promise<void>

- Defined in src/services/db/db.service.ts:668
Delete records using a custom where clause.

Parameters
- tableName: string
- whereClause: string
  
  The where clause to use in the SQL query.
- params: any[] = []
  
  The query parameters.
Returns Promise<void>

execute

execute<T>(stmt: string, params?: any[]): Promise<T[]>

- Defined in src/services/db/db.service.ts:145
Execute a SQL query.

Type parameters
- T = void
Parameters
- stmt: string
  
  SQL statement.
- params: any[] = []
  
  Values to be inserted into the statement.
Returns Promise<T[]>

Query results.

executeAllFiles

executeAllFiles<T>(directory: string, ext?: string, sqlPath?: string): Promise<T[][]>

- Defined in src/services/db/db.service.ts:256
Execute all SQL files in a directory.

Type parameters
- T = void
Parameters
- directory: string
  
  The directory containing SQL files.
- ext: string = '.sql'
  
  The extension of the SQL files.
- sqlPath: string = null
  
  The SQL files path.
Returns Promise<T[][]>

Results of all queries.

executeFile

executeFile<T>(filename: string, params?: any[], sqlPath?: string): Promise<T[]>

- Defined in src/services/db/db.service.ts:206
Execute a SQL file.

Type parameters
- T = void
Parameters
- filename: string
  
  The SQL file to execute.
- params: any[] = []
  
  Values to be inserted into the statement.
- sqlPath: string = null
  
  The SQL files path.
Returns Promise<T[]>

Query results.

executeFiles

executeFiles<T>(filenames: string[], params?: any[][], sqlPath?: string): Promise<T[][]>

- Defined in src/services/db/db.service.ts:227
Execute multiple SQL files.

Type parameters
- T = void
Parameters
- filenames: string[]
  
  The SQL files to execute.
- params: any[][] = []
  
  Values to be inserted into the statement.
- sqlPath: string = null
  
  The SQL files path.
Returns Promise<T[][]>

Results of all queries.

executeMany

executeMany<T>(stmts: string[], params?: any[][]): Promise<T[][]>

- Defined in src/services/db/db.service.ts:173
Execute multiple SQL queries, each one right after the last

Type parameters
- T = void
Parameters
- stmts: string[]
  
  SQL statement.
- params: any[][] = []
  
  Values to be inserted into the statement.
Returns Promise<T[][]>

Results of all queries.

getByFields

getByFields<T>(tableName: string, fields: FieldMap): Promise<T>

- Defined in src/services/db/db.service.ts:452
Get a record by field values.

Type parameters
- T
Parameters
- tableName: string
- fields: FieldMap
  
  Fields to query by.
Returns Promise<T>

The first record matching the field values.

getByID

getByID<T>(tableName: string, id: any): Promise<T>

- Defined in src/services/db/db.service.ts:438
Get a record in the table by ID.

Type parameters
- T
Parameters
- tableName: string
- id: any
  
  The record's ID.
Returns Promise<T>

The record with the given ID.

getCustom

getCustom<T>(tableName: string, whereClause: string, params?: any[]): Promise<T>

- Defined in src/services/db/db.service.ts:471
Get a record using a custom where clause.

Type parameters
- T
Parameters
- tableName: string
- whereClause: string
  
  The where clause to use in the SQL query.
- params: any[] = []
  
  The query parameters.
Returns Promise<T>

The first record from the resulting set.

getStaticTable

getStaticTable(tableName: string): Promise<any[]>

- Defined in src/services/db/db.service.ts:344
Get a static table's values.

Parameters
- tableName: string
  
  The table name.
Returns Promise<any[]>

The table values.

initDB

initDB(options?: InitDBOptions): Promise<void>

- Defined in src/services/db/db.service.ts:370
Initialize the database.

Parameters
- options: InitDBOptions = {}
Returns Promise<void>

list

list<T>(tableName: string, orderOptions?: OrderOptions): Promise<T[]>

- Defined in src/services/db/db.service.ts:488
List all records in the table.

Type parameters
- T
Parameters
- tableName: string
- Optional orderOptions: OrderOptions
  
  Options for ordering the results.
Returns Promise<T[]>

All records, ordered if applicable.

listByFields

listByFields<T>(tableName: string, fields: FieldMap, orderOptions?: OrderOptions): Promise<T[]>

- Defined in src/services/db/db.service.ts:508
List all records matching provided query values.

Type parameters
- T
Parameters
- tableName: string
- fields: FieldMap
  
  Fields to query by.
- Optional orderOptions: OrderOptions
  
  Options for ordering the results.
Returns Promise<T[]>

All records matching the provided query values, ordered if applicable.

listCustom

listCustom<T>(tableName: string, whereClause: string, orderOptions?: OrderOptions, params?: any[]): Promise<T[]>

- Defined in src/services/db/db.service.ts:536
List all records using a custom where clause.

Type parameters
- T
Parameters
- tableName: string
- whereClause: string
  
  The where clause to use in the SQL query.
- Optional orderOptions: OrderOptions
  
  Options for ordering the results.
- params: any[] = []
  
  The query parameters.
Returns Promise<T[]>

All records from the resulting set.

Private logError

logError(stmt: string, params: any[], res: any, err: Error): void

- Defined in src/services/db/db.service.ts:119
Provides information on an error.

Parameters
- stmt: string
  
  The SQL statement.
- params: any[]
  
  The query parameters.
- res: any
  
  The query response.
- err: Error
  
  The error thrown.
Returns void

Private populateStaticTable

populateStaticTable(tableName: string): Promise<void>

- Defined in src/services/db/db.service.ts:314
Populates a static database table from a CSV file.

Parameters
- tableName: string
  
  The table to populate.
Returns Promise<void>

Private populateTable

populateTable<T>(tableName: string, values: T[]): Promise<void>

- Defined in src/services/db/db.service.ts:285
Populates a database table.

Type parameters
- T
Parameters
- tableName: string
  
  The table to populate.
- values: T[]
  
  Values to be inserted into the table.
Returns Promise<void>

Private pruneRecords

pruneRecords(): Promise<void>

- Defined in src/services/db/db.service.ts:361
Prune records from the database.

Returns Promise<void>

Private transformParams

transformParams(stmt: string): string

- Defined in src/services/db/db.service.ts:130
Transforms question mark query param indicators.

Parameters
- stmt: string
  
  The SQL statement.
Returns string

The query with transformed parameters.

updateByFields

updateByFields<T>(tableName: string, fields: FieldMap, fieldValues: FieldMap): Promise<T[]>

- Defined in src/services/db/db.service.ts:583
Update records matching provided query values.

Type parameters
- T
Parameters
- tableName: string
- fields: FieldMap
  
  Fields to query by.
- fieldValues: FieldMap
  
  The updated field values.
Returns Promise<T[]>

The updated records.

updateByID

updateByID<T>(tableName: string, id: any, fieldValues: FieldMap): Promise<T>

- Defined in src/services/db/db.service.ts:558
Update a record in the table by ID.

Type parameters
- T
Parameters
- tableName: string
- id: any
  
  The record's ID.
- fieldValues: FieldMap
  
  The updated field values.
Returns Promise<T>

The updated record.

updateCustom

updateCustom<T>(tableName: string, whereClause: string, fieldValues: FieldMap, params?: any[]): Promise<T[]>

- Defined in src/services/db/db.service.ts:612
Update records using a custom where clause.

Type parameters
- T
Parameters
- tableName: string
- whereClause: string
  
  The where clause to use in the SQL query.
- fieldValues: FieldMap
  
  The updated field values.
- params: any[] = []
  
  The query parameters.
Returns Promise<T[]>

The updated records.

wipeTestDB

wipeTestDB(): Promise<void>

- Defined in src/services/db/db.service.ts:395
Wipe the test database.

Returns Promise<void>

Generated using TypeDoc