Class MsSqlQueryInterfaceInternal

The methods in this class are not part of the public API.

Hierarchy (View Summary)

AbstractQueryInterfaceInternal
- MsSqlQueryInterfaceInternal

Index

Constructors

constructor

new MsSqlQueryInterfaceInternal(
dialect: MsSqlDialect,
): MsSqlQueryInterfaceInternal
Parameters
- dialect: MsSqlDialect
Returns MsSqlQueryInterfaceInternal
Overrides AbstractQueryInterfaceInternal.constructor
- Defined in mssql/src/query-interface.internal.ts:7

Properties

`Readonly`dialect

dialect: MsSqlDialect

Methods

addUniqueIndex

addUniqueIndex(
    tableName: TableOrModel,
    columnName: string,
    options?: QueryRawOptions,
): Promise<void>
Adds a unique index on the column.
Parameters
- tableName: TableOrModel
  The table that contains the column
- columnName: string
  The name of the column, as it is in the database
- Optionaloptions: QueryRawOptions
  Query options
Returns Promise<void>
Inherited from AbstractQueryInterfaceInternal.addUniqueIndex
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:76

addUniqueKey

addUniqueKey(
    tableName: TableOrModel,
    columnName: string,
    options?: QueryRawOptions,
): Promise<void>
Adds a unique constraint on the column, or a unique index if the dialect cannot add constraints to existing tables.
Parameters
- tableName: TableOrModel
  The table that contains the column
- columnName: string
  The name of the column, as it is in the database
- Optionaloptions: QueryRawOptions
  Query options
Returns Promise<void>
Inherited from AbstractQueryInterfaceInternal.addUniqueKey
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:68

changeColumnAndAddUniqueKey

changeColumnAndAddUniqueKey(
    tableName: TableOrModel,
    columnName: string,
    changeColumnSql: string,
    options?: QueryRawOptions,
): Promise<unknown>
Schema changes are transactional in SQL Server, so the column change and the unique key are done in one transaction: if the unique key cannot be added (e.g. because of duplicate values), the column is not changed either.
Parameters
- tableName: TableOrModel
  The table that contains the column
- columnName: string
  The name of the column, as it is in the database
- changeColumnSql: string
  The query that changes the column
- Optionaloptions: QueryRawOptions
  Query options
Returns Promise<unknown>
Overrides AbstractQueryInterfaceInternal.changeColumnAndAddUniqueKey
- Defined in mssql/src/query-interface.internal.ts:20

describeTableRaw

describeTableRaw(
table: TableNameWithSchema,
options?: QueryRawOptions,
): Promise<ColumnsDescription>
Parameters
- table: TableNameWithSchema
- Optionaloptions: QueryRawOptions
Returns Promise<ColumnsDescription>
Inherited from AbstractQueryInterfaceInternal.describeTableRaw
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:23

executeQueriesSequentially

executeQueriesSequentially(
queries: string[],
options?: QueryRawOptions,
): Promise<unknown>
Parameters
- queries: string[]
- Optionaloptions: QueryRawOptions
Returns Promise<unknown>
Inherited from AbstractQueryInterfaceInternal.executeQueriesSequentially
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:77

fetchDatabaseVersionRaw

fetchDatabaseVersionRaw<T extends object>(
options?: FetchDatabaseVersionOptions,
): Promise<T>
Type Parameters
- T extends object
Parameters
- Optionaloptions: FetchDatabaseVersionOptions
Returns Promise<T>
Inherited from AbstractQueryInterfaceInternal.fetchDatabaseVersionRaw
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:13

hasUniqueKey

hasUniqueKey(
    tableName: TableOrModel,
    columnName: string,
    options?: QueryRawOptions,
): Promise<boolean>
Returns whether the table has a unique key (a unique constraint, a unique index, or the primary key) on exactly the given column.

Both the unique constraints and the indexes of the table are checked, because depending on the dialect, a unique key can be a unique index without a unique constraint. Snowflake does not report which columns its unique constraints are on, so they are never found there.
Parameters
- tableName: TableOrModel
  The table that contains the column
- columnName: string
  The name of the column, as it is in the database
- Optionaloptions: QueryRawOptions
  Query options
Returns Promise<boolean>
Inherited from AbstractQueryInterfaceInternal.hasUniqueKey
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:47

needsUniqueKey

needsUniqueKey(
    tableName: TableOrModel,
    columnName: string,
    unique:
        | AllowArray<string | boolean | { msg?: string; name: string }>
        | undefined,
    options?: QueryRawOptions,
): Promise<boolean>
Returns whether AbstractQueryInterface#changeColumn needs to add a unique key to the column, as requested by its "unique" option. This is only the case if the table does not have a unique key on exactly that column yet, so calling changeColumn again does not add another one.
Parameters
- tableName: TableOrModel
  The table that contains the column
- columnName: string
  The name of the column, as it is in the database
- unique: AllowArray<string | boolean | { msg?: string; name: string }> | undefined
  The value of the "unique" attribute option
- Optionaloptions: QueryRawOptions
  Query options
Returns Promise<boolean>
Inherited from AbstractQueryInterfaceInternal.needsUniqueKey
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:35

parseIsolationLevel

parseIsolationLevel(value?: IsolationLevel | null): number
Parses the isolation level and returns the corresponding value for tedious.
Parameters
- Optionalvalue: IsolationLevel | null
  The isolation level to parse.
Returns number

See
https://github.com/tediousjs/tedious/blob/master/src/transaction.ts
- Defined in mssql/src/query-interface.internal.ts:44

showConstraintsRaw

showConstraintsRaw(
tableName: TableOrModel,
options?: ShowConstraintsOptions,
): Promise<RawConstraintDescription[]>
Parameters
- tableName: TableOrModel
- Optionaloptions: ShowConstraintsOptions
Returns Promise<RawConstraintDescription[]>
Inherited from AbstractQueryInterfaceInternal.showConstraintsRaw
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:24

showIndexRaw

showIndexRaw(
tableName: TableOrModel,
options?: QueryRawOptions,
): Promise<unknown>
Parameters
- tableName: TableOrModel
- Optionaloptions: QueryRawOptions
Returns Promise<unknown>
Inherited from AbstractQueryInterfaceInternal.showIndexRaw
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:22

withReferencesSchema

withReferencesSchema(
attribute: NormalizedAttributeOptions,
schema: string,
): NormalizedAttributeOptions
Returns the attribute with its reference moved into schema, if that reference targets the dialect's default schema. References that target any other schema are returned untouched.
Parameters
- attribute: NormalizedAttributeOptions
- schema: string
Returns NormalizedAttributeOptions
Inherited from AbstractQueryInterfaceInternal.withReferencesSchema
- Defined in core/lib/abstract-dialect/query-interface-internal.d.ts:21

Class MsSqlQueryInterfaceInternal

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MsSqlQueryInterfaceInternal

Properties

Readonlydialect

Methods

addUniqueIndex

Parameters

Returns Promise<void>

addUniqueKey

Parameters

Returns Promise<void>

changeColumnAndAddUniqueKey

Parameters

Returns Promise<unknown>

describeTableRaw

Parameters

Returns Promise<ColumnsDescription>

executeQueriesSequentially

Parameters

Returns Promise<unknown>

fetchDatabaseVersionRaw

Type Parameters

Parameters

Returns Promise<T>

hasUniqueKey

Parameters

Returns Promise<boolean>

needsUniqueKey

Parameters

Returns Promise<boolean>

parseIsolationLevel

Parameters

Returns number

See

showConstraintsRaw

Parameters

Returns Promise<RawConstraintDescription[]>

showIndexRaw

Parameters

Returns Promise<unknown>

withReferencesSchema

Parameters

Returns NormalizedAttributeOptions

Settings

On This Page

`Readonly`dialect