/
QueryRunner.ts
426 lines (348 loc) · 11.8 KB
/
QueryRunner.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
import {TableColumn} from "../schema-builder/table/TableColumn";
import {Table} from "../schema-builder/table/Table";
import {TableForeignKey} from "../schema-builder/table/TableForeignKey";
import {TableIndex} from "../schema-builder/table/TableIndex";
import {Connection} from "../connection/Connection";
import {ReadStream} from "../platform/PlatformTools";
import {EntityManager} from "../entity-manager/EntityManager";
import {ObjectLiteral} from "../common/ObjectLiteral";
import {SqlInMemory} from "../driver/SqlInMemory";
import {TableUnique} from "../schema-builder/table/TableUnique";
import {View} from "../schema-builder/view/View";
import {Broadcaster} from "../subscriber/Broadcaster";
import {TableCheck} from "../schema-builder/table/TableCheck";
import {IsolationLevel} from "../driver/types/IsolationLevel";
import {TableExclusion} from "../schema-builder/table/TableExclusion";
import {QueryResult} from "./QueryResult";
import {ReplicationMode} from "../driver/types/ReplicationMode";
/**
* Runs queries on a single database connection.
*/
export interface QueryRunner {
/**
* Connection used by this query runner.
*/
readonly connection: Connection;
/**
* Broadcaster used on this query runner to broadcast entity events.
*/
readonly broadcaster: Broadcaster;
/**
* Entity manager working only with this query runner.
*/
readonly manager: EntityManager;
/**
* Indicates if connection for this query runner is released.
* Once its released, query runner cannot run queries anymore.
*/
readonly isReleased: boolean;
/**
* Indicates if transaction is in progress.
*/
readonly isTransactionActive: boolean;
/**
* Stores temporarily user data.
* Useful for sharing data with subscribers.
*/
data: ObjectLiteral;
/**
* All synchronized tables in the database.
*
* @deprecated Call `getTables()`
*/
loadedTables: Table[];
/**
* All synchronized views in the database.
*
* @deprecated Call `getViews()`
*/
loadedViews: View[];
/**
* Creates/uses database connection from the connection pool to perform further operations.
* Returns obtained database connection.
*/
connect(): Promise<any>;
/**
* Releases used database connection.
* You cannot use query runner methods after connection is released.
*/
release(): Promise<void>;
/**
* Removes all tables from the currently connected database.
* Be careful with using this method and avoid using it in production or migrations
* (because it can clear all your database).
*/
clearDatabase(database?: string): Promise<void>;
/**
* Starts transaction.
*/
startTransaction(isolationLevel?: IsolationLevel): Promise<void>;
/**
* Commits transaction.
* Error will be thrown if transaction was not started.
*/
commitTransaction(): Promise<void>;
/**
* Rollbacks transaction.
* Error will be thrown if transaction was not started.
*/
rollbackTransaction(): Promise<void>;
/**
* Executes a given SQL query and returns raw database results.
*/
query(query: string, parameters: any[] | undefined, useStructuredResult: true): Promise<QueryResult>;
/**
* Executes a given SQL query and returns raw database results.
*/
query(query: string, parameters?: any[]): Promise<any>;
/**
* Returns raw data stream.
*/
stream(query: string, parameters?: any[], onEnd?: Function, onError?: Function): Promise<ReadStream>;
/**
* Returns all available database names including system databases.
*/
getDatabases(): Promise<string[]>;
/**
* Returns all available schema names including system schemas.
* If database parameter specified, returns schemas of that database.
* Useful for SQLServer and Postgres only.
*/
getSchemas(database?: string): Promise<string[]>;
/**
* Loads a table by a given name from the database.
*/
getTable(tablePath: string): Promise<Table|undefined>;
/**
* Loads all tables from the database and returns them.
*/
getTables(tablePaths?: string[]): Promise<Table[]>;
/**
* Loads a view by a given name from the database.
*/
getView(viewPath: string): Promise<View|undefined>;
/**
* Loads all views from the database and returns them.
*/
getViews(viewPaths?: string[]): Promise<View[]>;
/**
* Returns replication mode (ex: `master` or `slave`).
*/
getReplicationMode(): ReplicationMode;
/**
* Checks if a database with the given name exist.
*/
hasDatabase(database: string): Promise<boolean>;
/**
* Loads currently using database
*/
getCurrentDatabase(): Promise<string|undefined>;
/**
* Checks if a schema with the given name exist.
*/
hasSchema(schema: string): Promise<boolean>;
/**
* Loads currently using database schema
*/
getCurrentSchema(): Promise<string|undefined>;
/**
* Checks if a table with the given name exist.
*/
hasTable(table: Table|string): Promise<boolean>;
/**
* Checks if a column exist in the table.
*/
hasColumn(table: Table|string, columnName: string): Promise<boolean>;
/**
* Creates a new database.
*/
createDatabase(database: string, ifNotExist?: boolean): Promise<void>;
/**
* Drops database.
*/
dropDatabase(database: string, ifExist?: boolean): Promise<void>;
/**
* Creates a new table schema.
*/
createSchema(schemaPath: string, ifNotExist?: boolean): Promise<void>;
/**
* Drops table schema.
* For SqlServer can accept schema path (e.g. 'dbName.schemaName') as parameter.
* If schema path passed, it will drop schema in specified database.
*/
dropSchema(schemaPath: string, ifExist?: boolean, isCascade?: boolean): Promise<void>;
/**
* Creates a new table.
*/
createTable(table: Table, ifNotExist?: boolean, createForeignKeys?: boolean, createIndices?: boolean): Promise<void>;
/**
* Drops a table.
*/
dropTable(table: Table|string, ifExist?: boolean, dropForeignKeys?: boolean, dropIndices?: boolean): Promise<void>;
/**
* Creates a new view.
*/
createView(view: View, oldView?: View): Promise<void>;
/**
* Drops a view.
*/
dropView(view: View|string): Promise<void>;
/**
* Renames a table.
*/
renameTable(oldTableOrName: Table|string, newTableName: string): Promise<void>;
/**
* Adds a new column.
*/
addColumn(table: Table|string, column: TableColumn): Promise<void>;
/**
* Adds new columns.
*/
addColumns(table: Table|string, columns: TableColumn[]): Promise<void>;
/**
* Renames a column.
*/
renameColumn(table: Table|string, oldColumnOrName: TableColumn|string, newColumnOrName: TableColumn|string): Promise<void>;
/**
* Changes a column in the table.
*/
changeColumn(table: Table|string, oldColumn: TableColumn|string, newColumn: TableColumn): Promise<void>;
/**
* Changes columns in the table.
*/
changeColumns(table: Table|string, changedColumns: { oldColumn: TableColumn, newColumn: TableColumn }[]): Promise<void>;
/**
* Drops a column in the table.
*/
dropColumn(table: Table|string, column: TableColumn|string): Promise<void>;
/**
* Drops columns in the table.
*/
dropColumns(table: Table|string, columns: TableColumn[]|string[]): Promise<void>;
/**
* Creates a new primary key.
*/
createPrimaryKey(table: Table|string, columnNames: string[]): Promise<void>;
/**
* Updates composite primary keys.
*/
updatePrimaryKeys(table: Table|string, columns: TableColumn[]): Promise<void>;
/**
* Drops a primary key.
*/
dropPrimaryKey(table: Table|string): Promise<void>;
/**
* Creates a new unique constraint.
*/
createUniqueConstraint(table: Table|string, uniqueConstraint: TableUnique): Promise<void>;
/**
* Creates new unique constraints.
*/
createUniqueConstraints(table: Table|string, uniqueConstraints: TableUnique[]): Promise<void>;
/**
* Drops an unique constraint.
*/
dropUniqueConstraint(table: Table|string, uniqueOrName: TableUnique|string): Promise<void>;
/**
* Drops unique constraints.
*/
dropUniqueConstraints(table: Table|string, uniqueConstraints: TableUnique[]): Promise<void>;
/**
* Creates a new check constraint.
*/
createCheckConstraint(table: Table|string, checkConstraint: TableCheck): Promise<void>;
/**
* Creates new check constraints.
*/
createCheckConstraints(table: Table|string, checkConstraints: TableCheck[]): Promise<void>;
/**
* Drops a check constraint.
*/
dropCheckConstraint(table: Table|string, checkOrName: TableCheck|string): Promise<void>;
/**
* Drops check constraints.
*/
dropCheckConstraints(table: Table|string, checkConstraints: TableCheck[]): Promise<void>;
/**
* Creates a new exclusion constraint.
*/
createExclusionConstraint(table: Table|string, exclusionConstraint: TableExclusion): Promise<void>;
/**
* Creates new exclusion constraints.
*/
createExclusionConstraints(table: Table|string, exclusionConstraints: TableExclusion[]): Promise<void>;
/**
* Drops a exclusion constraint.
*/
dropExclusionConstraint(table: Table|string, exclusionOrName: TableExclusion|string): Promise<void>;
/**
* Drops exclusion constraints.
*/
dropExclusionConstraints(table: Table|string, exclusionConstraints: TableExclusion[]): Promise<void>;
/**
* Creates a new foreign key.
*/
createForeignKey(table: Table|string, foreignKey: TableForeignKey): Promise<void>;
/**
* Creates new foreign keys.
*/
createForeignKeys(table: Table|string, foreignKeys: TableForeignKey[]): Promise<void>;
/**
* Drops a foreign key.
*/
dropForeignKey(table: Table|string, foreignKeyOrName: TableForeignKey|string): Promise<void>;
/**
* Drops foreign keys.
*/
dropForeignKeys(table: Table|string, foreignKeys: TableForeignKey[]): Promise<void>;
/**
* Creates a new index.
*/
createIndex(table: Table|string, index: TableIndex): Promise<void>;
/**
* Creates new indices.
*/
createIndices(table: Table|string, indices: TableIndex[]): Promise<void>;
/**
* Drops an index.
*/
dropIndex(table: Table|string, index: TableIndex|string): Promise<void>;
/**
* Drops indices.
*/
dropIndices(table: Table|string, indices: TableIndex[]): Promise<void>;
/**
* Clears all table contents.
* Note: this operation uses SQL's TRUNCATE query which cannot be reverted in transactions.
*/
clearTable(tableName: string): Promise<void>;
/**
* Enables special query runner mode in which sql queries won't be executed,
* instead they will be memorized into a special variable inside query runner.
* You can get memorized sql using getMemorySql() method.
*/
enableSqlMemory(): void;
/**
* Disables special query runner mode in which sql queries won't be executed
* started by calling enableSqlMemory() method.
*
* Previously memorized sql will be flushed.
*/
disableSqlMemory(): void;
/**
* Flushes all memorized sqls.
*/
clearSqlMemory(): void;
/**
* Gets sql stored in the memory. Parameters in the sql are already replaced.
*/
getMemorySql(): SqlInMemory;
/**
* Executes up sql queries.
*/
executeMemoryUpSql(): Promise<void>;
/**
* Executes down sql queries.
*/
executeMemoryDownSql(): Promise<void>;
}