@ones-op/node-database

We provide a set of interfaces related to the plugin database, allowing plugin developers to access and operate the plugin database.

Requirements

ONES
v3.6.0+

API

importSQL

Initialize the database

Params

Param	Description	Type	Required	Default
sqlFileName	sql file path	string	Y	-

Error

errcode	reason	level	statusCode
DB.SqlFileNameFormatInvalid	SQL filename format invaild.	error	400
DB.SqlFileFetchingFailed	SQL file fetching failed.	error	400
DB.CannotFindTable	Cannot find table content in SQL file.	error	400
DB.ImportSqlErr	An unknown error occurred while executing the import method, and the hardware error scenario gave the cause of the hardware error.	error	500

Example

0.6.0+
0.4.0+

import { importSQL, DBError } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function testImportSQL() {
  try {
    await importSQL('plugin.sql')
  } catch (error) {
    if (error instanceof DBError) {
      Logger.error('error:', error.errcode, error.statusCode, error.level, error.reason)
    }
  }
}

import { importSQL } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function testImportSQL() {
  try {
    await importSQL('plugin.sql')
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

select

Receives the sql statement related to the query and returns the query result, which will be throw error if the sql execution fails.

Params

Param	Description	Type	Required	Default
sql	SQL statement related to the query	string	Y	-
args	Filling in the variable parameters for the SQL statements contain placeholders `?`（supported in `ONES v6.8.0+/v6.1.96+，@ones-op/node-database@0.70.1+`）	any	N	-

Returns

Param	Description	Type
result	sql query result	`Record<string, any>[]`

Error

errcode	reason	level	statusCode
DB.QuerySqlErr	An unknown error occurred while executing the select method, and the specific error scenario gives the specific cause of the error.	error	500
DB.SqlSyntaxErr	The sql does not conform to the grammatical specification, and the specific error scene gives the specific error reason.	error	400
InvalidParameter	Invalid parameter.	error	400

Example

0.70.1+
0.6.0+
0.4.0+

import { select, DBError } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function select_database() {
  try {
    const result1 = await select('select * from email_id_map limit 10;')
    const result2 = await select('select * from email_id_map where id_number = ?;', '001'))
  } catch (error) {
    if (error instanceof DBError) {
      Logger.error('error:', error.errcode, error.statusCode, error.level, error.reason)
    }
  }
}

import { select, DBError } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function select_database() {
  try {
    const result = await select('select * from email_id_map limit 10;')
  } catch (error) {
    if (error instanceof DBError) {
      Logger.error('error:', error.errcode, error.statusCode, error.level, error.reason)
    }
  }
}

import { select } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function select_database() {
  try {
    const result = await select('select * from email_id_map limit 10;')
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

exec

Execute the relevant sql statement and no result is returned. If sql execution fails, it will throw error.

Params

Param	Description	Type	Required	Default
operate	operation type，'insert' 、'update' 、 'delete' 、'create' 、'alter' 、 'drop'	string	Y	-
sql	sql statement	string	Y	-
args	Filling in the variable parameters for the SQL statements contain placeholders `?`（supported in `ONES v6.2.19+/v6.1.86+，@ones-op/node-database@0.46.5+`）	any	N	-

Error

errcode	reason	level	statusCode
DB.ExecSqlErr	An unknown error occurred while executing the exec method, and the specific error scenario gives the specific cause of the error.	error	500
DB.SqlSyntaxErr	The sql does not conform to the grammatical specification, and the specific error scene gives the specific error reason.	error	400
InvalidParameter	Invalid parameter.	error	400

Example

0.46.5+
0.6.0+
0.4.0+

import { exec, DBError } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function exec_database() {
  try {
    await exec(
      'insert',
      `INSERT INTO email_id_map(email,id_number) VALUES ("plugin1@ones.com", "001");`,
    )
    await exec(
      'insert',
      `INSERT INTO email_id_map(email,id_number) VALUES (?,?);`,
      'plugin2@ones.com',
      '002',
    )
    const args = ['plugin3@ones.com', '003']
    await exec('insert', `INSERT INTO email_id_map(email,id_number) VALUES (?,?);`, ...args)
  } catch (error) {
    if (error instanceof DBError) {
      Logger.error('error:', error.errcode, error.statusCode, error.level, error.reason)
    }
  }
}

import { exec, DBError } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function exec_database() {
  try {
    await exec(
      'insert',
      `INSERT INTO email_id_map(email,id_number) VALUES ("plugin1@ones.com", "001");`,
    )
  } catch (error) {
    if (error instanceof DBError) {
      Logger.error('error:', error.errcode, error.statusCode, error.level, error.reason)
    }
  }
}

import { exec } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function exec_database() {
  try {
    await exec(
      'insert',
      `INSERT INTO email_id_map(email,id_number) VALUES ("plugin1@ones.com", "001");`,
    )
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

count

Count related sql interface. If the sql execution is a failure, it will throw error.

Params

Param	Description	Type	Required	Default
sql	SQL statement	string	Y	-
args	Filling in the variable parameters for the SQL statements contain placeholders `?`（supported in `ONES v6.8.0+/v6.1.96+，@ones-op/node-database@0.70.1+`）	any	N	-

Returns

Param	Description	Type
result	statistical results	number

Error

errcode	reason	level	statusCode
DB.QuerySqlErr	An unknown error occurred while executing the count method, and the specific error scenario gives the specific cause of the error.	error	500
DB.SqlSyntaxErr	The sql does not conform to the grammatical specification, and the specific error scene gives the specific error reason.	error	400
InvalidParameter	Invalid parameter.	error	400

Example

0.70.1+
0.6.0+
0.4.0+

import { count, DBError } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function count_database() {
  try {
    const cnt1 = await count('select count(*) from email_id_map;')
    const cnt2 = await count('select count(*) from email_id_map where id_number = ?;', '001'))
  } catch (error) {
    if (error instanceof DBError) {
      Logger.error('error:', error.errcode, error.statusCode, error.level, error.reason)
    }
  }
}

import { count, DBError } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function count_database() {
  try {
    const result = await count('select count(*) from email_id_map;')
  } catch (error) {
    if (error instanceof DBError) {
      Logger.error('error:', error.errcode, error.statusCode, error.level, error.reason)
    }
  }
}

import { count } from '@ones-op/node-database'
import { Logger } from '@ones-op/node-logger'

export async function count_database() {
  try {
    const result = await count('select count(*) from email_id_map;')
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

Type

DBError

Param	Description	Type
level	error level	`string`
reason	error reason	`string`
statusCode	http status code	`string`
errcode	error code	`string`

Requirements​

API​

importSQL​

Params​

Error​

Example​

select​

Params​

Returns​

Error​

Example​

exec​

Params​

Error​

Example​

count​

Params​

Returns​

Error​

Example​

Type​

DBError​

Requirements

API

importSQL

Params

Error

Example

select

Params

Returns

Error

Example

exec

Params

Error

Example

count

Params

Returns

Error

Example

Type

DBError