Class PostgresReflector

Constructors

constructor

new PostgresReflector(
config: Client | PostgresReflectorConfig,
options?: PostgresReflectorOptions,
): PostgresReflector
Parameters
- config: Client | PostgresReflectorConfig
- options: PostgresReflectorOptions = {}
Returns PostgresReflector
- Defined in postgres-adapter/postgres-reflector.ts:392

Methods

connect

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

close

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

getClient

getClient(): Client
Returns Client
- Defined in postgres-adapter/postgres-reflector.ts:462

inspectSchema

inspectSchema(
options?: PostgresInspectorOptions,
): Promise<PostgresInspectedSchema>
Parameters
- options: PostgresInspectorOptions = {}
Returns Promise<PostgresInspectedSchema>
- Defined in postgres-adapter/postgres-reflector.ts:466

generateEntityClasses

generateEntityClasses(
options?: PostgresSchemaGenerationOptions,
): Promise<string>
Parameters
- options: PostgresSchemaGenerationOptions = {}
Returns Promise<string>
- Defined in postgres-adapter/postgres-reflector.ts:471

planReflect

planReflect(...entities: EntityClass[]): Promise<PostgresSchemaSyncPreview>
Parameters
- ...entities: EntityClass[]
Returns Promise<PostgresSchemaSyncPreview>
- Defined in postgres-adapter/postgres-reflector.ts:476

reflect

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

clearRegisteredStoreProcedures

clearRegisteredStoreProcedures(): number
Returns number
- Defined in postgres-adapter/postgres-reflector.ts:627

syncRegisteredStoreProcedures

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

createStoreProcedure

createStoreProcedure(procedure: StoreProcedureInput): Promise<void>
Parameters
- procedure: StoreProcedureInput
Returns Promise<void>
- Defined in postgres-adapter/postgres-reflector.ts:639

createStoreProcedures

createStoreProcedures(...procedures: StoreProcedureInput[]): Promise<void>
Parameters
- ...procedures: StoreProcedureInput[]
Returns Promise<void>
- Defined in postgres-adapter/postgres-reflector.ts:654

callStoreProcedure

callStoreProcedure<T extends QueryResultRow = QueryResultRow>(
    procedure: string | StoreProcedureInput,
    args?: unknown[],
    options?: PostgresCallStoreProcedureOptions,
): Promise<T[]>
Type Parameters
- T extends QueryResultRow = QueryResultRow
Parameters
- procedure: string | StoreProcedureInput
- args: unknown[] = []
- options: PostgresCallStoreProcedureOptions = {}
Returns Promise<T[]>
- Defined in postgres-adapter/postgres-reflector.ts:660

dropStoreProcedure

dropStoreProcedure(
procedure: string | StoreProcedureInput,
options?: PostgresDropStoreProcedureOptions,
): Promise<number>
Parameters
- procedure: string | StoreProcedureInput
- options: PostgresDropStoreProcedureOptions = {}
Returns Promise<number>
- Defined in postgres-adapter/postgres-reflector.ts:679

createTrigger

createTrigger(definition: PostgresTriggerDefinition): Promise<void>
Parameters
- definition: PostgresTriggerDefinition
Returns Promise<void>
- Defined in postgres-adapter/postgres-reflector.ts:737

dropTrigger

dropTrigger(
    name: string,
    table: string,
    options?: PostgresDropTriggerOptions,
): Promise<number>
Parameters
- name: string
- table: string
- options: PostgresDropTriggerOptions = {}
Returns Promise<number>
- Defined in postgres-adapter/postgres-reflector.ts:781

createView

createView(definition: PostgresViewDefinition): Promise<void>
Parameters
- definition: PostgresViewDefinition
Returns Promise<void>
- Defined in postgres-adapter/postgres-reflector.ts:813

dropView

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

getSchemaChangeHistory

getSchemaChangeHistory(
limit?: number,
): Promise<PostgresSchemaChangeHistoryEntry[]>
Parameters
- limit: number = 100
Returns Promise<PostgresSchemaChangeHistoryEntry[]>
- Defined in postgres-adapter/postgres-reflector.ts:859

clearSchemaChangeHistory

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

select

select(columns?: SelectColumns): PostgresQueryBuilder
Parameters
- columns: SelectColumns = "*"
Returns PostgresQueryBuilder
- Defined in postgres-adapter/postgres-reflector.ts:927

selectFromEntity

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

Select

Select(columns?: SelectColumns): PostgresQueryBuilder
Parameters
- columns: SelectColumns = "*"
Returns PostgresQueryBuilder
- Defined in postgres-adapter/postgres-reflector.ts:963

insertInto

insertInto(table: string): PostgresInsertBuilder
Parameters
- table: string
Returns PostgresInsertBuilder
- Defined in postgres-adapter/postgres-reflector.ts:967

insertEntity

insertEntity<TInstance extends object>(
entityClass: EntityClass<TInstance>,
): PostgresInsertBuilder
Type Parameters
- TInstance extends object
Parameters
- entityClass: EntityClass<TInstance>
Returns PostgresInsertBuilder
- Defined in postgres-adapter/postgres-reflector.ts:971

InsertInto

InsertInto(table: string): PostgresInsertBuilder
Parameters
- table: string
Returns PostgresInsertBuilder
- Defined in postgres-adapter/postgres-reflector.ts:975

update

update(table: string): PostgresUpdateBuilder
Parameters
- table: string
Returns PostgresUpdateBuilder
- Defined in postgres-adapter/postgres-reflector.ts:979

updateEntity

updateEntity<TInstance extends object>(
entityClass: EntityClass<TInstance>,
): PostgresUpdateBuilder
Type Parameters
- TInstance extends object
Parameters
- entityClass: EntityClass<TInstance>
Returns PostgresUpdateBuilder
- Defined in postgres-adapter/postgres-reflector.ts:983

Update

Update(table: string): PostgresUpdateBuilder
Parameters
- table: string
Returns PostgresUpdateBuilder
- Defined in postgres-adapter/postgres-reflector.ts:987

deleteFrom

deleteFrom(table: string): PostgresDeleteBuilder
Parameters
- table: string
Returns PostgresDeleteBuilder
- Defined in postgres-adapter/postgres-reflector.ts:991

deleteEntity

deleteEntity<TInstance extends object>(
entityClass: EntityClass<TInstance>,
): PostgresDeleteBuilder
Type Parameters
- TInstance extends object
Parameters
- entityClass: EntityClass<TInstance>
Returns PostgresDeleteBuilder
- Defined in postgres-adapter/postgres-reflector.ts:995

DeleteFrom

DeleteFrom(table: string): PostgresDeleteBuilder
Parameters
- table: string
Returns PostgresDeleteBuilder
- Defined in postgres-adapter/postgres-reflector.ts:999

query

query<T extends QueryResultRow = QueryResultRow>(
sql: string,
params?: unknown[],
): Promise<T[]>
Type Parameters
- T extends QueryResultRow = QueryResultRow
Parameters
- sql: string
- params: unknown[] = []
Returns Promise<T[]>
- Defined in postgres-adapter/postgres-reflector.ts:1003

execute

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

transactionAsync

transactionAsync<T>(
handler: (db: PostgresReflector) => T | Promise<T>,
options?: PostgresTransactionOptions,
): Promise<T>
Type Parameters
- T
Parameters
- handler: (db: PostgresReflector) => T | Promise<T>
- options: PostgresTransactionOptions = {}
Returns Promise<T>
- Defined in postgres-adapter/postgres-reflector.ts:1017

Class PostgresReflector

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PostgresReflector

Methods

connect

Returns Promise<void>

close

Returns Promise<void>

getClient

Returns Client

inspectSchema

Parameters

Returns Promise<PostgresInspectedSchema>

generateEntityClasses

Parameters

Returns Promise<string>

planReflect

Parameters

Returns Promise<PostgresSchemaSyncPreview>

reflect

Parameters

Returns Promise<void>

registerStoreProcedure

Parameters

Returns PostgresRegisteredStoreProcedure

registerStoreProcedures

Parameters

Returns PostgresRegisteredStoreProcedure[]

getRegisteredStoreProcedures

Returns PostgresRegisteredStoreProcedure[]

clearRegisteredStoreProcedures

Returns number

syncRegisteredStoreProcedures

Returns Promise<void>

createStoreProcedure

Parameters

Returns Promise<void>

createStoreProcedures

Parameters

Returns Promise<void>

callStoreProcedure

Type Parameters

Parameters

Returns Promise<T[]>

dropStoreProcedure

Parameters

Returns Promise<number>

createTrigger

Parameters

Returns Promise<void>

dropTrigger

Parameters

Returns Promise<number>

createView

Parameters

Returns Promise<void>

dropView

Parameters

Returns Promise<number>

getSchemaChangeHistory

Parameters

Returns Promise<PostgresSchemaChangeHistoryEntry[]>

clearSchemaChangeHistory

Returns Promise<number>

select

Parameters

Returns PostgresQueryBuilder

selectFromEntity

Type Parameters

Parameters

Returns PostgresQueryBuilder

Select

Parameters

Returns PostgresQueryBuilder

insertInto