Class MySqlReflector

Constructors

constructor

new MySqlReflector(
config: MySqlConnection | MySqlReflectorConfig,
_options?: MySqlReflectorOptions,
): MySqlReflector
Parameters
- config: MySqlConnection | MySqlReflectorConfig
- _options: MySqlReflectorOptions = {}
Returns MySqlReflector
- Defined in mysql-adapter/mysql-reflector.ts:346

Methods

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in mysql-adapter/mysql-reflector.ts:412

close

close(): Promise<void>
Returns Promise<void>
- Defined in mysql-adapter/mysql-reflector.ts:421

getClient

getClient(): MySqlConnection
Returns MySqlConnection
- Defined in mysql-adapter/mysql-reflector.ts:432

inspectSchema

inspectSchema(options?: MySqlInspectorOptions): Promise<MySqlInspectedSchema>
Parameters
- options: MySqlInspectorOptions = {}
Returns Promise<MySqlInspectedSchema>
- Defined in mysql-adapter/mysql-reflector.ts:436

generateEntityClasses

generateEntityClasses(options?: MySqlSchemaGenerationOptions): Promise<string>
Parameters
- options: MySqlSchemaGenerationOptions = {}
Returns Promise<string>
- Defined in mysql-adapter/mysql-reflector.ts:441

getSchemaChangeHistory

getSchemaChangeHistory(limit?: number): Promise<MySqlSchemaChangeHistoryEntry[]>
Parameters
- limit: number = 100
Returns Promise<MySqlSchemaChangeHistoryEntry[]>
- Defined in mysql-adapter/mysql-reflector.ts:446

clearSchemaChangeHistory

clearSchemaChangeHistory(): Promise<number>
Returns Promise<number>
- Defined in mysql-adapter/mysql-reflector.ts:501

planReflect

planReflect(...entities: EntityClass[]): Promise<MySqlSchemaSyncPreview>
Parameters
- ...entities: EntityClass[]
Returns Promise<MySqlSchemaSyncPreview>
- Defined in mysql-adapter/mysql-reflector.ts:517

reflect

reflect(...entities: EntityClass[]): Promise<void>
Parameters
- ...entities: EntityClass[]
Returns Promise<void>
- Defined in mysql-adapter/mysql-reflector.ts:536

select

select(columns?: SelectColumns): MySqlQueryBuilder
Parameters
- columns: SelectColumns = "*"
Returns MySqlQueryBuilder
- Defined in mysql-adapter/mysql-reflector.ts:622

selectFromEntity

selectFromEntity<TInstance extends object>(
    entityClass: EntityClass<TInstance>,
    columns?: "*" | Extract<keyof TInstance, string>[],
    alias?: string,
): MySqlQueryBuilder
Type Parameters
- TInstance extends object
Parameters
- entityClass: EntityClass<TInstance>
- columns: "*" | Extract<keyof TInstance, string>[] = "*"
- Optionalalias: string
Returns MySqlQueryBuilder
- Defined in mysql-adapter/mysql-reflector.ts:626

Select

Select(columns?: SelectColumns): MySqlQueryBuilder
Parameters
- columns: SelectColumns = "*"
Returns MySqlQueryBuilder
- Defined in mysql-adapter/mysql-reflector.ts:658

insertInto

insertInto(table: string): MySqlInsertBuilder
Parameters
- table: string
Returns MySqlInsertBuilder
- Defined in mysql-adapter/mysql-reflector.ts:662

insertEntity

insertEntity<TInstance extends object>(
entityClass: EntityClass<TInstance>,
): MySqlInsertBuilder
Type Parameters
- TInstance extends object
Parameters
- entityClass: EntityClass<TInstance>
Returns MySqlInsertBuilder
- Defined in mysql-adapter/mysql-reflector.ts:668

InsertInto

InsertInto(table: string): MySqlInsertBuilder
Parameters
- table: string
Returns MySqlInsertBuilder
- Defined in mysql-adapter/mysql-reflector.ts:677

update

update(table: string): MySqlUpdateBuilder
Parameters
- table: string
Returns MySqlUpdateBuilder
- Defined in mysql-adapter/mysql-reflector.ts:681

updateEntity

updateEntity<TInstance extends object>(
entityClass: EntityClass<TInstance>,
): MySqlUpdateBuilder
Type Parameters
- TInstance extends object
Parameters
- entityClass: EntityClass<TInstance>
Returns MySqlUpdateBuilder
- Defined in mysql-adapter/mysql-reflector.ts:687

Update

Update(table: string): MySqlUpdateBuilder
Parameters
- table: string
Returns MySqlUpdateBuilder
- Defined in mysql-adapter/mysql-reflector.ts:696

deleteFrom

deleteFrom(table: string): MySqlDeleteBuilder
Parameters
- table: string
Returns MySqlDeleteBuilder
- Defined in mysql-adapter/mysql-reflector.ts:700

deleteEntity

deleteEntity<TInstance extends object>(
entityClass: EntityClass<TInstance>,
): MySqlDeleteBuilder
Type Parameters
- TInstance extends object
Parameters
- entityClass: EntityClass<TInstance>
Returns MySqlDeleteBuilder
- Defined in mysql-adapter/mysql-reflector.ts:704

DeleteFrom

DeleteFrom(table: string): MySqlDeleteBuilder
Parameters
- table: string
Returns MySqlDeleteBuilder
- Defined in mysql-adapter/mysql-reflector.ts:708

query

query<TRow extends Record<string, unknown> = Record<string, unknown>>(
sql: string,
params?: unknown[],
): Promise<TRow[]>
Type Parameters
- TRow extends Record<string, unknown> = Record<string, unknown>
Parameters
- sql: string
- params: unknown[] = []
Returns Promise<TRow[]>
- Defined in mysql-adapter/mysql-reflector.ts:712

execute

execute(sql: string, params?: unknown[]): Promise<{ rowCount: number }>
Parameters
- sql: string
- params: unknown[] = []
Returns Promise<{ rowCount: number }>
- Defined in mysql-adapter/mysql-reflector.ts:721

transactionAsync

transactionAsync<T>(
handler: (db: MySqlReflector) => T | Promise<T>,
options?: MySqlTransactionOptions,
): Promise<T>
Type Parameters
- T
Parameters
- handler: (db: MySqlReflector) => T | Promise<T>
- options: MySqlTransactionOptions = {}
Returns Promise<T>
- Defined in mysql-adapter/mysql-reflector.ts:729

clearRegisteredStoreProcedures

clearRegisteredStoreProcedures(): number
Returns number
- Defined in mysql-adapter/mysql-reflector.ts:797

syncRegisteredStoreProcedures

syncRegisteredStoreProcedures(): Promise<void>
Returns Promise<void>
- Defined in mysql-adapter/mysql-reflector.ts:803

createStoreProcedure

createStoreProcedure(procedure: MySqlStoreProcedureInput): Promise<void>
Parameters
- procedure: MySqlStoreProcedureInput
Returns Promise<void>
- Defined in mysql-adapter/mysql-reflector.ts:809

createStoreProcedures

createStoreProcedures(...procedures: MySqlStoreProcedureInput[]): Promise<void>
Parameters
- ...procedures: MySqlStoreProcedureInput[]
Returns Promise<void>
- Defined in mysql-adapter/mysql-reflector.ts:830

callStoreProcedure

callStoreProcedure<
    TRow extends Record<string, unknown> = Record<string, unknown>,
>(
    procedure: string | MySqlStoreProcedureInput,
    args?: unknown[],
    options?: MySqlCallStoreProcedureOptions,
): Promise<TRow[]>
Type Parameters
- TRow extends Record<string, unknown> = Record<string, unknown>
Parameters
- procedure: string | MySqlStoreProcedureInput
- args: unknown[] = []
- options: MySqlCallStoreProcedureOptions = {}
Returns Promise<TRow[]>
- Defined in mysql-adapter/mysql-reflector.ts:836

dropStoreProcedure

dropStoreProcedure(
procedure: string | MySqlStoreProcedureInput,
options?: MySqlDropStoreProcedureOptions,
): Promise<number>
Parameters
- procedure: string | MySqlStoreProcedureInput
- options: MySqlDropStoreProcedureOptions = {}
Returns Promise<number>
- Defined in mysql-adapter/mysql-reflector.ts:853

createTrigger

createTrigger(definition: MySqlTriggerDefinition): Promise<void>
Parameters
- definition: MySqlTriggerDefinition
Returns Promise<void>
- Defined in mysql-adapter/mysql-reflector.ts:895

dropTrigger

dropTrigger(
    name: string,
    table?: string,
    options?: MySqlDropTriggerOptions,
): Promise<number>
Parameters
- name: string
- Optionaltable: string
- options: MySqlDropTriggerOptions = {}
Returns Promise<number>
- Defined in mysql-adapter/mysql-reflector.ts:925

createView

createView(definition: MySqlViewDefinition): Promise<void>
Parameters
- definition: MySqlViewDefinition
Returns Promise<void>
- Defined in mysql-adapter/mysql-reflector.ts:959

dropView

dropView(name: string, options?: MySqlDropViewOptions): Promise<number>
Parameters
- name: string
- options: MySqlDropViewOptions = {}
Returns Promise<number>
- Defined in mysql-adapter/mysql-reflector.ts:994

Class MySqlReflector

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MySqlReflector

Methods

connect

Returns Promise<void>

close

Returns Promise<void>

getClient

Returns MySqlConnection

inspectSchema

Parameters

Returns Promise<MySqlInspectedSchema>

generateEntityClasses

Parameters

Returns Promise<string>

getSchemaChangeHistory

Parameters

Returns Promise<MySqlSchemaChangeHistoryEntry[]>

clearSchemaChangeHistory

Returns Promise<number>

planReflect

Parameters

Returns Promise<MySqlSchemaSyncPreview>

reflect

Parameters

Returns Promise<void>

select

Parameters

Returns MySqlQueryBuilder

selectFromEntity

Type Parameters

Parameters

Returns MySqlQueryBuilder

Select

Parameters

Returns MySqlQueryBuilder

insertInto

Parameters

Returns MySqlInsertBuilder

insertEntity

Type Parameters

Parameters

Returns MySqlInsertBuilder

InsertInto

Parameters

Returns MySqlInsertBuilder

update

Parameters

Returns MySqlUpdateBuilder

updateEntity

Type Parameters

Parameters

Returns MySqlUpdateBuilder

Update

Parameters

Returns MySqlUpdateBuilder

deleteFrom

Parameters

Returns MySqlDeleteBuilder

deleteEntity

Type Parameters

Parameters

Returns MySqlDeleteBuilder

DeleteFrom

Parameters

Returns MySqlDeleteBuilder

query

Type Parameters

Parameters

Returns Promise<TRow[]>

execute

Parameters

Returns Promise<{ rowCount: number }>

transactionAsync