Class OINODbPostgresql

Implementation of Postgresql-database.

Hierarchy

OINODb
- OINODbPostgresql

Index

Constructors

Methods

bindCellValue connect disconnect getNativeDataType getSchemaFields getSchemaTables parseValueAsCell printCellAsValue printColumnName printParameterName printStringValue printTableName runStatement sqlExec sqlSelect validate

Constructors

constructor

new OINODbPostgresql(params: OINODbParams): OINODbPostgresql
Constructor of OINODbPostgresql
Parameters
- params: OINODbParams
  database paraneters
Returns OINODbPostgresql
Overrides OINODb.constructor
- Defined in db-postgresql/src/OINODbPostgresql.ts:105

Methods

bindCellValue

bindCellValue(cellValue: OINODataCell, nativeType: string): OINODataCell
Coerce a data value into a Postgres bind-parameter value. The pg driver binds numbers, strings, booleans, Date and Buffer to their native Postgres types directly.
Parameters
- cellValue: OINODataCell
  data value to bind
- nativeType: string
  native type name for the table column
Returns OINODataCell
- Defined in db-postgresql/src/OINODbPostgresql.ts:213

connect

connect(): Promise<OINOResult>
Connect to database.

Returns Promise<OINOResult>
Overrides OINODb.connect
- Defined in db-postgresql/src/OINODbPostgresql.ts:301

disconnect

disconnect(): Promise<void>
Disconnect from database.

Returns Promise<void>
- Defined in db-postgresql/src/OINODbPostgresql.ts:358

getNativeDataType

getNativeDataType(schema: OINODataFieldSchema): string
Resolve the optimal native (SQL) type for a serialized field schema.
Parameters
- schema: OINODataFieldSchema
  serialized field schema
Returns string
- Defined in db-postgresql/src/OINODbPostgresql.ts:535

getSchemaFields

getSchemaFields(tableName: string): Promise<OINODataField[]>
Get the schema fields of a table as OINODataFields (without any API-level field filtering).
Parameters
- tableName: string
  name of the table
Returns Promise<OINODataField[]>
- Defined in db-postgresql/src/OINODbPostgresql.ts:472

getSchemaTables

getSchemaTables(): Promise<string[]>
Get the names of all user (base) tables in the database schema, excluding system tables and views.

Returns Promise<string[]>
- Defined in db-postgresql/src/OINODbPostgresql.ts:514

parseValueAsCell

parseValueAsCell(sqlValue: OINODataCell, nativeType: string): OINODataCell
Parse a single SQL result value for serialization using the context of the native data type.
Parameters
- sqlValue: OINODataCell
  data from serialization
- nativeType: string
  native type name for table column
Returns OINODataCell
- Defined in db-postgresql/src/OINODbPostgresql.ts:281

printCellAsValue

printCellAsValue(cellValue: OINODataCell, nativeType: string): string
Print a single data value from serialization using the context of the native data type with the correct SQL escaping.
Parameters
- cellValue: OINODataCell
  data from sql results
- nativeType: string
  native type name for table column
Returns string
- Defined in db-postgresql/src/OINODbPostgresql.ts:228

printColumnName

printColumnName(sqlColumn: string): string
Print a column name with correct SQL escaping.
Parameters
- sqlColumn: string
  name of the column
Returns string
- Defined in db-postgresql/src/OINODbPostgresql.ts:191

printParameterName

printParameterName(index: number): string
Print a bind-parameter placeholder for the given zero-based parameter index (Postgres $n).
Parameters
- index: number
  zero-based parameter index
Returns string
- Defined in db-postgresql/src/OINODbPostgresql.ts:201

printStringValue

printStringValue(sqlString: string): string
Print a single string value as valid sql literal
Parameters
- sqlString: string
  string value
Returns string
- Defined in db-postgresql/src/OINODbPostgresql.ts:268

printTableName

printTableName(sqlTable: string): string
Print a table name using database specific SQL escaping.
Parameters
- sqlTable: string
  name of the table
Returns string
- Defined in db-postgresql/src/OINODbPostgresql.ts:181

runStatement

runStatement(statement: OINODbSqlStatement): Promise<OINODataSet>
Execute a parameterized statement, binding its values as $n parameters.
Parameters
- statement: OINODbSqlStatement
  statement (SQL text + ordered bind values) to execute
Returns Promise<OINODataSet>
- Defined in db-postgresql/src/OINODbPostgresql.ts:407

sqlExec

sqlExec(sql: string): Promise<OINODataSet>
Execute other sql operations.
Parameters
- sql: string
  SQL statement.
Returns Promise<OINODataSet>
Overrides OINODb.sqlExec
- Defined in db-postgresql/src/OINODbPostgresql.ts:391

sqlSelect

sqlSelect(sql: string): Promise<OINODataSet>
Execute a select operation.
Parameters
- sql: string
  SQL statement.
Returns Promise<OINODataSet>
Overrides OINODb.sqlSelect
- Defined in db-postgresql/src/OINODbPostgresql.ts:375

validate

validate(): Promise<OINOResult>
Validate connection to database is working.

Returns Promise<OINOResult>
Overrides OINODb.validate
- Defined in db-postgresql/src/OINODbPostgresql.ts:328