SQLDialect | The Extollo Framework

Abstract class defining a particular dialect of SQL that is used to render query builders to strings of SQL of that dialect for execution by Connection instances.

Hierarchy

AppClass
- SQLDialect
  - PostgreSQLDialect

Constructors

constructor

new SQLDialect(): SQLDialect

Inherited from AppClass.constructor

Returns SQLDialect

Accessors

Private appClassApplication

get appClassApplication(): Application

- Defined in src/lifecycle/AppClass.ts:31
The global application instance.

Returns Application

Methods

Protected app

app(): Application

Inherited from AppClass.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Protected container

container(): Container

Inherited from AppClass.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

Abstract escape

escape(value: EscapeValue): QuerySafeValue

- Defined in src/orm/dialect/SQLDialect.ts:53
Escape the given value and return the query-safe equivalent.

Parameters
- value: EscapeValue
Returns QuerySafeValue

getBoundMethod

getBoundMethod(methodName: string): (...args: any[]) => any

Inherited from AppClass.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55
Get the method with the given name from this class, bound to this class.

Parameters
- methodName: string
Returns (...args: any[]) => any

function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

Protected make

make<T>(target: any, ...parameters: any[]): T

Inherited from AppClass.make
- Defined in src/lifecycle/AppClass.ts:46
Call the make() method on the global container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

Abstract renderAlterTable

renderAlterTable(builder: TableBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:183
Given a table schema-builder, render an ALTER TABLE... query.

Parameters
- builder: TableBuilder
Returns string

renderCommitSchemaTransaction

renderCommitSchemaTransaction(builder: TableBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:258
Given a table schema-builder, render a series of queries as a transaction that apply the given schema to database.

todo

handle constraints better - ConstraintBuilder

Parameters
- builder: TableBuilder
Returns string

Abstract renderConstraints

renderConstraints(constraints: Constraint[]): string

Given an array of Constraint objects, render them as WHERE-clause SQL in this dialect.

This function should escape the values before they are included in the query string.

example

dialect.renderConstraints([
 {
     field: 'id',
     operator: '<',
     operand: 44,
     preop: 'AND',
 },
 {
     field: 'id',
     operator: '>',
     operand: 30,
     preop: 'AND',
 },
])  // => 'id < 44 AND id > 30'

Parameters

constraints: Constraint[]

Returns string

Abstract renderCount

renderCount(query: string): string

- Defined in src/orm/dialect/SQLDialect.ts:119
Wrap the given query string as a "SELECT ..." query that returns the number of rows matched by the original query string.

The resultant query should return the extollo_render_count field with the number of rows that the original query would return.

Parameters
- query: string
Returns string

Abstract renderCreateIndex

renderCreateIndex(builder: IndexBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:209
Given an index schema-builder, render a CREATE INDEX... query.

Parameters
- builder: IndexBuilder
Returns string

Abstract renderCreateTable

renderCreateTable(builder: TableBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:177
Given a table schema-builder, render a CREATE TABLE... query.

Parameters
- builder: TableBuilder
Returns string

Abstract renderDelete

renderDelete(builder: AbstractBuilder<any>): string

- Defined in src/orm/dialect/SQLDialect.ts:79
Render the given query builder as a "DELETE ..." query string.

This function should escape the values before they are included in the query string.

Parameters
- builder: AbstractBuilder<any>
Returns string

Abstract renderDropColumn

renderDropColumn(builder: ColumnBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:215
Given a column schema-builder, render an ALTER TABLE... DROP COLUMN... query.

Parameters
- builder: ColumnBuilder
Returns string

Abstract renderDropIndex

renderDropIndex(builder: IndexBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:221
Given an index schema-builder, render a DROP INDEX... query.

Parameters
- builder: IndexBuilder
Returns string

Abstract renderDropTable

renderDropTable(builder: TableBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:189
Given a table schema-builder, render a DROP TABLE... query.

Parameters
- builder: TableBuilder
Returns string

Abstract renderExistential

renderExistential(builder: AbstractBuilder<any>): string

- Defined in src/orm/dialect/SQLDialect.ts:97
Render the given query builder as a query that can be used to test if at least 1 row exists for the given builder.

The resultant query should return at least 1 row if that condition is met, and should return NO rows otherwise.

This function should escape the values before they are included in the query string.

example

The PostgreSQL dialect achieves this by removing the user-specified fields, select-ing TRUE, and applying LIMIT 1 to the query. This returns a single row if the constraints have results, and nothing otherwise.

Parameters
- builder: AbstractBuilder<any>
Returns string

Abstract renderInsert

renderInsert(builder: AbstractBuilder<any>, data: {} | {}[]): string

- Defined in src/orm/dialect/SQLDialect.ts:108
Render the given query as an "INSERT ..." query string, inserting rows for the given data object(s).

This function should escape the values before they are included in the query string.

Parameters
- builder: AbstractBuilder<any>
- data: {} | {}[]
Returns string

Abstract renderRangedSelect

renderRangedSelect(query: string, start: number, end: number): string

- Defined in src/orm/dialect/SQLDialect.ts:129
Given a rendered "SELECT ..." query string, wrap it such that the query will only return the rows ranging from the start to end indices.

Parameters
- query: string
- start: number
- end: number
Returns string

Abstract renderRecreateIndex

renderRecreateIndex(builder: IndexBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:234
Given an index schema-builder, render either an ALTER INDEX... query, or a DROP INDEX...; CREATE INDEX... query.

Parameters
- builder: IndexBuilder
Returns string

Abstract renderRenameIndex

renderRenameIndex(builder: IndexBuilder): string

- Defined in src/orm/dialect/SQLDialect.ts:227
Given an index schema-builder, render an ALTER INDEX... RENAME... query.

Parameters
- builder: IndexBuilder
Returns string

Abstract renderSelect

renderSelect(builder: AbstractBuilder<any>): string

- Defined in src/orm/dialect/SQLDialect.ts:61
Render the given query builder as a "SELECT ..." query string.

This function should escape the values before they are included in the query string.

Parameters
- builder: AbstractBuilder<any>
Returns string

Abstract renderTableColumns

renderTableColumns(builder: TableBuilder): string[]

- Defined in src/orm/dialect/SQLDialect.ts:203
Render the table-column definitions for the table defined by the given schema-builder.
example
```
dialect.renderTableColumns(builder)
// => ['col1 varchar(100) NULL', 'col2 serial NOT NULL']
```
Parameters
- builder: TableBuilder
Returns string[]

Abstract renderTransaction

renderTransaction(queries: string[]): string

Given a series of fully-formed queries, render them as a single transaction.

example

const queries = [
 'SELECT * FROM a',
 'UPDATE b SET col = 123',
]

dialect.renderTransaction(queries)
// => 'BEGIN; SELECT * FROM a; UPDATE b SET col = 123; COMMIT;'

Parameters

queries: string[]

Returns string

Abstract renderUpdate

renderUpdate(builder: AbstractBuilder<any>, data: {}): string

- Defined in src/orm/dialect/SQLDialect.ts:71
Render the given query builder as an "UPDATE ..." query string, setting the column values from the given data object.

This function should escape the values before they are included in the query string.

Parameters
- builder: AbstractBuilder<any>
- data: {}
  - [key: string]: EscapeValue
Returns string

Abstract renderUpdateSet

renderUpdateSet(data: {}): string

- Defined in src/orm/dialect/SQLDialect.ts:171
Render the "SET ... [field = value ...]" portion of the update query.

This function should escape the values before they are included in the query string.
example
```
dialect.renderUpdateSet({field1: 'value', field2: 45})
// => "SET field1 = 'value', field2 = 45"
```
Parameters
- data: {}
  - [key: string]: EscapeValue
Returns string

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns SQLDialect

Accessors

Private appClassApplication

Returns Application

Methods

Protected app

Returns Application

Protected container

Returns Container

Abstract escape

Parameters

value: EscapeValue

Returns QuerySafeValue

getBoundMethod

Parameters

methodName: string

Returns (...args: any[]) => any

Parameters

Rest ...args: any[]

Returns any

Protected make

Type parameters

T

Parameters

target: any

Rest ...parameters: any[]

Returns T

Abstract renderAlterTable

Parameters

builder: TableBuilder

Returns string

renderCommitSchemaTransaction

Parameters

builder: TableBuilder

Returns string

Abstract renderConstraints

Parameters

constraints: Constraint[]

Returns string

Abstract renderCount

Parameters

query: string

Returns string

Abstract renderCreateIndex

Parameters

builder: IndexBuilder

Returns string

Abstract renderCreateTable

Parameters

builder: TableBuilder

Returns string

Abstract renderDelete

Parameters

builder: AbstractBuilder<any>

Returns string

Abstract renderDropColumn

Parameters

builder: ColumnBuilder

Returns string

Abstract renderDropIndex

Parameters

builder: IndexBuilder

Returns string

Abstract renderDropTable

Parameters

builder: TableBuilder

Returns string

Abstract renderExistential

Parameters

builder: AbstractBuilder<any>

Returns string

Abstract renderInsert

Parameters