Class MariaDB

Readonlyconfig

Readonlypool

tableOptions

Readonlytype

typeName

• get typeName(): string

  Returns string

Statictype

• get type(): Database.Type

  Returns Database.Type

close

• close(): Promise<void>

  Closes all the pooled connections

  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

listTables

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

  Lists the tables in the specified database

  Parameters

  • database: undefined | 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>>

on

• on(event: "error", listener: (error: Error) => void): this

  Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

  server.on('connection', (stream) => {
    console.log('someone connected!');
  });
  Copy

  Returns a reference to the EventEmitter, so that calls can be chained.

  By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

  import { EventEmitter } from 'node:events';
  const myEE = new EventEmitter();
  myEE.on('foo', () => console.log('a'));
  myEE.prependListener('foo', () => console.log('b'));
  myEE.emit('foo');
  // Prints:
  //   b
  //   a
  Copy

  Parameters

  • event: "error"
  • listener: (error: Error) => void

    The callback function

  Returns this

  Since

  v0.1.101

• on(event: "acquire", listener: (connection: PoolConnection) => void): this

  Parameters

  • event: "acquire"
  • listener: (connection: PoolConnection) => void

  Returns this

• on(event: "connection", listener: (connection: PoolConnection) => void): this

  Parameters

  • event: "connection"
  • listener: (connection: PoolConnection) => void

  Returns this

• on(event: "enqueue", listener: () => void): this

  Parameters

  • event: "enqueue"
  • listener: () => void

  Returns this

• on(event: "release", listener: (connection: PoolConnection) => void): this

  Parameters

  • event: "release"
  • listener: (connection: PoolConnection) => void

  Returns this

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[]

query

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

  Performs an individual query and returns the result

  Type Parameters

  • RecordType = any

  Parameters

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

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

transaction

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

  Performs the specified queries in a transaction

  Type Parameters

  • RecordType = any

  Parameters

  • queries: Database.Query[]

  Returns Promise<MySQL.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>

use

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

  Switches the default database referenced by the connection

  Parameters

  • database: string

  Returns Promise<MySQL>