Class DatabaseAbstract

tableOptions

Readonlytype

AbstractidleConnections

• get idleConnections(): number

  Gets the total number of idle connections in the pool

  Returns number

AbstracttotalConnections

• get totalConnections(): number

  Gets the total number of connections in the pool

  Returns number

typeName

• get typeName(): string

  Returns string

Abstractclose

• close(): Promise<void>

  Closes the database connection

  Returns Promise<void>

createIndex

• createIndex(
      table: string,
      fields: string[],
      type?: IndexType,
      useTransaction?: boolean,
  ): Promise<void>

  Prepares and executes the creation of an index on the table specified

  Parameters

  • table: string
  • fields: string[]
  • type: IndexType = Database.Table.IndexType.NONE
  • useTransaction: boolean = true

  Returns Promise<void>

createTable

• createTable(
      name: string,
      fields: Column[],
      primaryKey?: string[],
      tableOptions?: string,
      useTransaction?: boolean,
  ): Promise<void>

  Prepares and executes the creation of a table including the relevant indexes and constraints

  Parameters

  • name: string
  • fields: Column[]
  • primaryKey: string[] = []
  • tableOptions: string = ...
  • useTransaction: boolean = true

  Returns Promise<void>

dropTable

• dropTable(tables: string | string[]): Promise<Database.Query.Result<any>[]>

  Drop the tables from the database

  Parameters

  • tables: string | string[]

  Returns Promise<Database.Query.Result<any>[]>

escape

• escape(value: string): string

  Escapes the value for SQL

  Parameters

  • value: string

  Returns string

escapeId

• escapeId(id: string): string

  Escapes the ID for sql

  Parameters

  • id: string

  Returns string

AbstractlistTables

• listTables(database?: string): Promise<string[]>

  Parameters

  • Optionaldatabase: string

  Returns Promise<string[]>

multiInsert

• multiInsert(
      table: string,
      columns?: string[],
      values: any[][],
      useTransaction?: boolean,
  ): Promise<Database.Query.Result<any>>

  Prepares and performs a query that performs a multi-insert statement which is far faster than a bunch of individual insert statements

  Parameters

  • table: string
  • columns: string[] = []
  • values: any[][]
  • useTransaction: boolean = true

  Returns Promise<Database.Query.Result<any>>

multiUpdate

• multiUpdate(
      table: string,
      primaryKey: string[],
      columns: string[],
      values: any[][],
      useTransaction?: boolean,
  ): Promise<Database.Query.Result<any>>

  Prepares and executes a query to that performs a multi-update statement which is based upon a multi-insert statement that performs an UPSERT which is a lot faster than a bunch of update statements

  Parameters

  • table: string
  • primaryKey: string[]
  • columns: string[]
  • values: any[][]
  • useTransaction: boolean = true

  Returns Promise<Database.Query.Result<any>>

prepareCreateIndex

• prepareCreateIndex(
      table: string,
      fields: string[],
      type?: IndexType,
  ): Database.Query[]

  Prepares the creation of an index on the specified table

  Parameters

  • table: string
  • fields: string[]
  • type: IndexType = Database.Table.IndexType.NONE

  Returns Database.Query[]

prepareCreateTable

• prepareCreateTable(
      name: string,
      fields: Column[],
      primaryKey?: string[],
      tableOptions?: string,
  ): Database.Query[]

  Prepares the creation of a table including the relevant indexes and constraints

  Parameters

  • name: string
  • fields: Column[]
  • primaryKey: string[] = []
  • tableOptions: string = ...

  Returns Database.Query[]

prepareMultiInsert

• prepareMultiInsert(
      table: string,
      columns?: string[],
      values: any[][],
  ): Database.Query[]

  Prepares a query to perform a multi-insert statement which is far faster than a bunch of individual insert statements

  Parameters

  • table: string
  • columns: string[] = []
  • values: any[][]

  Returns Database.Query[]

prepareMultiUpdate

• prepareMultiUpdate(
      table: string,
      primaryKey: string[],
      columns: string[],
      values: any[][],
  ): Database.Query[]

  Prepares a query to perform a multi-update statement which is based upon a multi-insert statement that performs an UPSERT and this is a lot faster than a bunch of individual update statements

  Parameters

  • table: string
  • primaryKey: string[]
  • columns: string[]
  • values: any[][]

  Returns Database.Query[]

Abstractquery

• query<RecordType>(
      query: string | Database.Query,
      ...values: any[],
  ): Promise<Database.Query.Result<RecordType>>

  Type Parameters

  • RecordType

  Parameters

  • query: string | Database.Query
  • ...values: any[]

  Returns Promise<Database.Query.Result<RecordType>>

Abstracttransaction

• transaction<RecordType = any>(
      queries: Database.Query[],
  ): Promise<Database.Query.Result<RecordType>[]>

  Performs a database transaction with the specified queries

  Type Parameters

  • RecordType = any

  Parameters

  • queries: Database.Query[]

  Returns Promise<Database.Query.Result<RecordType>[]>

truncate

• truncate(table: string | string[], useTransaction?: boolean): Promise<boolean>

  Truncates the specified table(s)

  Parameters

  • table: string | string[]
  • useTransaction: boolean = true

  Returns Promise<boolean>

Abstractuse

• use(database: string): Promise<Database>

  Switches the database connection to the specified database

  Parameters

  • database: string

  Returns Promise<Database>