/
sequelize.d.ts
1486 lines (1320 loc) · 49.8 KB
/
sequelize.d.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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import * as DataTypes from './data-types';
import { HookReturn, Hooks, SequelizeHooks } from './hooks';
import { ValidationOptions } from './instance-validator';
import {
AndOperator,
BulkCreateOptions,
CreateOptions,
DestroyOptions,
DropOptions,
FindOptions,
InstanceDestroyOptions,
Logging,
Model,
ModelAttributeColumnOptions,
ModelAttributes,
ModelOptions,
OrOperator,
UpdateOptions,
WhereAttributeHash,
WhereOperators,
ModelCtor,
Hookable,
ModelType,
} from './model';
import { ModelManager } from './model-manager';
import { QueryInterface, QueryOptions, QueryOptionsWithModel, QueryOptionsWithType, ColumnsDescription } from './query-interface';
import QueryTypes = require('./query-types');
import { Transaction, TransactionOptions } from './transaction';
import { Cast, Col, DeepWriteable, Fn, Json, Literal, Where } from './utils';
import { ConnectionManager } from './connection-manager';
/**
* Additional options for table altering during sync
*/
export interface SyncAlterOptions {
/**
* Prevents any drop statements while altering a table when set to `false`
*/
drop?: boolean;
}
/**
* Sync Options
*/
export interface SyncOptions extends Logging, Hookable {
/**
* If force is true, each DAO will do DROP TABLE IF EXISTS ..., before it tries to create its own table
*/
force?: boolean;
/**
* If alter is true, each DAO will do ALTER TABLE ... CHANGE ...
* Alters tables to fit models. Provide an object for additional configuration. Not recommended for production use. If not further configured deletes data in columns that were removed or had their type changed in the model.
*/
alter?: boolean | SyncAlterOptions;
/**
* Match a regex against the database name before syncing, a safety check for cases where force: true is
* used in tests but not live code
*/
match?: RegExp;
/**
* The schema that the tables should be created in. This can be overridden for each table in sequelize.define
*/
schema?: string;
/**
* An optional parameter to specify the schema search_path (Postgres only)
*/
searchPath?: string;
}
export interface DefaultSetOptions { }
/**
* Connection Pool options
*/
export interface PoolOptions {
/**
* Maximum number of connections in pool. Default is 5
*/
max?: number;
/**
* Minimum number of connections in pool. Default is 0
*/
min?: number;
/**
* The maximum time, in milliseconds, that a connection can be idle before being released
*/
idle?: number;
/**
* The maximum time, in milliseconds, that pool will try to get connection before throwing error
*/
acquire?: number;
/**
* The time interval, in milliseconds, after which sequelize-pool will remove idle connections.
*/
evict?: number;
/**
* The number of times to use a connection before closing and replacing it. Default is Infinity
*/
maxUses?: number;
/**
* A function that validates a connection. Called with client. The default function checks that client is an
* object, and that its state is not disconnected
*/
validate?(client?: unknown): boolean;
}
export interface ConnectionOptions {
host?: string;
port?: string | number;
username?: string;
password?: string;
database?: string;
}
/**
* Interface for replication Options in the sequelize constructor
*/
export interface ReplicationOptions {
read: ConnectionOptions[];
write: ConnectionOptions;
}
/**
* Used to map operators to their Symbol representations
*/
export interface OperatorsAliases {
[K: string]: symbol;
}
/**
* Final config options generated by sequelize.
*/
export interface Config {
readonly database: string;
readonly dialectModule?: object;
readonly host?: string;
readonly port?: string;
readonly username: string;
readonly password: string | null;
readonly pool?: {
readonly acquire: number;
readonly idle: number;
readonly max: number;
readonly min: number;
};
readonly protocol: 'tcp';
readonly native: boolean;
readonly ssl: boolean;
readonly replication: boolean;
readonly dialectModulePath: null | string;
readonly keepDefaultTimezone?: boolean;
readonly dialectOptions?: {
readonly charset?: string;
readonly timeout?: number;
};
}
export type Dialect = 'mysql' | 'postgres' | 'sqlite' | 'mariadb' | 'mssql';
export interface RetryOptions {
match?: (RegExp | string | Function)[];
max?: number;
}
/**
* Options for the constructor of Sequelize main class
*/
export interface Options extends Logging {
/**
* The dialect of the database you are connecting to. One of mysql, postgres, sqlite, mariadb and mssql.
*
* @default 'mysql'
*/
dialect?: Dialect;
/**
* If specified, will use the provided module as the dialect.
*
* @example
* `dialectModule: require('@myorg/tedious'),`
*/
dialectModule?: object;
/**
* If specified, load the dialect library from this path. For example, if you want to use pg.js instead of
* pg when connecting to a pg database, you should specify 'pg.js' here
*/
dialectModulePath?: string;
/**
* An object of additional options, which are passed directly to the connection library
*/
dialectOptions?: object;
/**
* Only used by sqlite.
*
* @default ':memory:'
*/
storage?: string;
/**
* The name of the database
*/
database?: string;
/**
* The username which is used to authenticate against the database.
*/
username?: string;
/**
* The password which is used to authenticate against the database.
*/
password?: string;
/**
* The host of the relational database.
*
* @default 'localhost'
*/
host?: string;
/**
* The port of the relational database.
*/
port?: number;
/**
* A flag that defines if is used SSL.
*/
ssl?: boolean;
/**
* The protocol of the relational database.
*
* @default 'tcp'
*/
protocol?: string;
/**
* Default options for model definitions. See Model.init.
*/
define?: ModelOptions;
/**
* Default options for sequelize.query
*/
query?: QueryOptions;
/**
* Default options for sequelize.set
*/
set?: DefaultSetOptions;
/**
* Default options for sequelize.sync
*/
sync?: SyncOptions;
/**
* The timezone used when converting a date from the database into a JavaScript date. The timezone is also
* used to SET TIMEZONE when connecting to the server, to ensure that the result of NOW, CURRENT_TIMESTAMP
* and other time related functions have in the right timezone. For best cross platform performance use the
* format
* +/-HH:MM. Will also accept string versions of timezones used by moment.js (e.g. 'America/Los_Angeles');
* this is useful to capture daylight savings time changes.
*
* @default '+00:00'
*/
timezone?: string;
/**
* A flag that defines if null values should be passed to SQL queries or not.
*
* @default false
*/
omitNull?: boolean;
/**
* A flag that defines if native library shall be used or not. Currently only has an effect for postgres
*
* @default false
*/
native?: boolean;
/**
* Use read / write replication. To enable replication, pass an object, with two properties, read and write.
* Write should be an object (a single server for handling writes), and read an array of object (several
* servers to handle reads). Each read/write server can have the following properties: `host`, `port`,
* `username`, `password`, `database`
*
* @default false
*/
replication?: ReplicationOptions;
/**
* Connection pool options
*/
pool?: PoolOptions;
/**
* Set to `false` to make table names and attributes case-insensitive on Postgres and skip double quoting of
* them.
*
* @default true
*/
quoteIdentifiers?: boolean;
/**
* Set the default transaction isolation level. See `Sequelize.Transaction.ISOLATION_LEVELS` for possible
* options.
*
* @default 'REPEATABLE_READ'
*/
isolationLevel?: string;
/**
* Set the default transaction type. See Sequelize.Transaction.TYPES for possible options. Sqlite only.
*
* @default 'DEFERRED'
*/
transactionType?: Transaction.TYPES;
/**
* Run built in type validators on insert and update, e.g. validate that arguments passed to integer
* fields are integer-like.
*
* @default false
*/
typeValidation?: boolean;
/**
* Sets available operator aliases.
* See (https://sequelize.org/master/manual/querying.html#operators) for more information.
* WARNING: Setting this to boolean value was deprecated and is no-op.
*
* @default all aliases
*/
operatorsAliases?: OperatorsAliases;
/**
* The PostgreSQL `standard_conforming_strings` session parameter. Set to `false` to not set the option.
* WARNING: Setting this to false may expose vulnerabilities and is not recommended!
*
* @default true
*/
standardConformingStrings?: boolean;
/**
* The PostgreSQL `client_min_messages` session parameter.
* Set to `false` to not override the database's default.
*
* @default 'warning'
*/
clientMinMessages?: string | boolean;
/**
* Sets global permanent hooks.
*/
hooks?: Partial<SequelizeHooks<Model, any, any>>;
/**
* Set to `true` to automatically minify aliases generated by sequelize.
* Mostly useful to circumvent the POSTGRES alias limit of 64 characters.
*
* @default false
*/
minifyAliases?: boolean;
/**
* Set to `true` to show bind parameters in log.
*
* @default false
*/
logQueryParameters?: boolean;
retry?: RetryOptions;
}
export interface QueryOptionsTransactionRequired { }
/**
* This is the main class, the entry point to sequelize. To use it, you just need to
* import sequelize:
*
* ```js
* const Sequelize = require('sequelize');
* ```
*
* In addition to sequelize, the connection library for the dialect you want to use
* should also be installed in your project. You don't need to import it however, as
* sequelize will take care of that.
*/
export class Sequelize extends Hooks {
// -------------------- Utilities ------------------------------------------------------------------------
/**
* Creates a object representing a database function. This can be used in search queries, both in where and
* order parts, and as default values in column definitions. If you want to refer to columns in your
* function, you should use `sequelize.col`, so that the columns are properly interpreted as columns and
* not a strings.
*
* Convert a user's username to upper case
* ```js
* instance.update({
* username: self.sequelize.fn('upper', self.sequelize.col('username'))
* })
* ```
* @param fn The function you want to call
* @param args All further arguments will be passed as arguments to the function
*/
public static fn: typeof fn;
public fn: typeof fn;
/**
* Creates a object representing a column in the DB. This is often useful in conjunction with
* `sequelize.fn`, since raw string arguments to fn will be escaped.
*
* @param col The name of the column
*/
public static col: typeof col;
public col: typeof col;
/**
* Creates a object representing a call to the cast function.
*
* @param val The value to cast
* @param type The type to cast it to
*/
public static cast: typeof cast;
public cast: typeof cast;
/**
* Creates a object representing a literal, i.e. something that will not be escaped.
*
* @param val
*/
public static literal: typeof literal;
public literal: typeof literal;
/**
* An AND query
*
* @param args Each argument will be joined by AND
*/
public static and: typeof and;
public and: typeof and;
/**
* An OR query
*
* @param args Each argument will be joined by OR
*/
public static or: typeof or;
public or: typeof or;
/**
* Creates an object representing nested where conditions for postgres's json data-type.
*
* @param conditionsOrPath A hash containing strings/numbers or other nested hash, a string using dot
* notation or a string using postgres json syntax.
* @param value An optional value to compare against. Produces a string of the form "<json path> =
* '<value>'".
*/
public static json: typeof json;
public json: typeof json;
/**
* A way of specifying attr = condition.
*
* The attr can either be an object taken from `Model.rawAttributes` (for example `Model.rawAttributes.id`
* or
* `Model.rawAttributes.name`). The attribute should be defined in your model definition. The attribute can
* also be an object from one of the sequelize utility functions (`sequelize.fn`, `sequelize.col` etc.)
*
* For string attributes, use the regular `{ where: { attr: something }}` syntax. If you don't want your
* string to be escaped, use `sequelize.literal`.
*
* @param attr The attribute, which can be either an attribute object from `Model.rawAttributes` or a
* sequelize object, for example an instance of `sequelize.fn`. For simple string attributes, use the
* POJO syntax
* @param comparator Comparator
* @param logic The condition. Can be both a simply type, or a further condition (`.or`, `.and`, `.literal`
* etc.)
*/
public static where: typeof where;
public where: typeof where;
/**
* A hook that is run before validation
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public static beforeValidate(name: string, fn: (instance: Model, options: ValidationOptions) => void): void;
public static beforeValidate(fn: (instance: Model, options: ValidationOptions) => void): void;
/**
* A hook that is run after validation
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public static afterValidate(name: string, fn: (instance: Model, options: ValidationOptions) => void): void;
public static afterValidate(fn: (instance: Model, options: ValidationOptions) => void): void;
/**
* A hook that is run before creating a single instance
*
* @param name
* @param fn A callback function that is called with attributes, options
*/
public static beforeCreate(name: string, fn: (attributes: Model, options: CreateOptions<any>) => void): void;
public static beforeCreate(fn: (attributes: Model, options: CreateOptions<any>) => void): void;
/**
* A hook that is run after creating a single instance
*
* @param name
* @param fn A callback function that is called with attributes, options
*/
public static afterCreate(name: string, fn: (attributes: Model, options: CreateOptions<any>) => void): void;
public static afterCreate(fn: (attributes: Model, options: CreateOptions<any>) => void): void;
/**
* A hook that is run before destroying a single instance
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public static beforeDestroy(name: string, fn: (instance: Model, options: InstanceDestroyOptions) => void): void;
public static beforeDestroy(fn: (instance: Model, options: InstanceDestroyOptions) => void): void;
/**
* A hook that is run after destroying a single instance
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public static afterDestroy(name: string, fn: (instance: Model, options: InstanceDestroyOptions) => void): void;
public static afterDestroy(fn: (instance: Model, options: InstanceDestroyOptions) => void): void;
/**
* A hook that is run before updating a single instance
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public static beforeUpdate(name: string, fn: (instance: Model, options: UpdateOptions<any>) => void): void;
public static beforeUpdate(fn: (instance: Model, options: UpdateOptions<any>) => void): void;
/**
* A hook that is run after updating a single instance
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public static afterUpdate(name: string, fn: (instance: Model, options: UpdateOptions<any>) => void): void;
public static afterUpdate(fn: (instance: Model, options: UpdateOptions<any>) => void): void;
/**
* A hook that is run before creating or updating a single instance, It proxies `beforeCreate` and `beforeUpdate`
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public static beforeSave(
name: string,
fn: (instance: Model, options: UpdateOptions<any> | CreateOptions<any>) => void
): void;
public static beforeSave(fn: (instance: Model, options: UpdateOptions<any> | CreateOptions<any>) => void): void;
/**
* A hook that is run after creating or updating a single instance, It proxies `afterCreate` and `afterUpdate`
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public static afterSave(
name: string,
fn: (instance: Model, options: UpdateOptions<any> | CreateOptions<any>) => void
): void;
public static afterSave(
fn: (instance: Model, options: UpdateOptions<any> | CreateOptions<any>) => void
): void;
/**
* A hook that is run before creating instances in bulk
*
* @param name
* @param fn A callback function that is called with instances, options
*/
public static beforeBulkCreate(
name: string,
fn: (instances: Model[], options: BulkCreateOptions<any>) => void
): void;
public static beforeBulkCreate(fn: (instances: Model[], options: BulkCreateOptions<any>) => void): void;
/**
* A hook that is run after creating instances in bulk
*
* @param name
* @param fn A callback function that is called with instances, options
*/
public static afterBulkCreate(
name: string, fn: (instances: Model[], options: BulkCreateOptions<any>) => void
): void;
public static afterBulkCreate(fn: (instances: Model[], options: BulkCreateOptions<any>) => void): void;
/**
* A hook that is run before destroying instances in bulk
*
* @param name
* @param fn A callback function that is called with options
*/
public static beforeBulkDestroy(name: string, fn: (options: BulkCreateOptions<any>) => void): void;
public static beforeBulkDestroy(fn: (options: BulkCreateOptions<any>) => void): void;
/**
* A hook that is run after destroying instances in bulk
*
* @param name
* @param fn A callback function that is called with options
*/
public static afterBulkDestroy(name: string, fn: (options: DestroyOptions<any>) => void): void;
public static afterBulkDestroy(fn: (options: DestroyOptions<any>) => void): void;
/**
* A hook that is run after updating instances in bulk
*
* @param name
* @param fn A callback function that is called with options
*/
public static beforeBulkUpdate(name: string, fn: (options: UpdateOptions<any>) => void): void;
public static beforeBulkUpdate(fn: (options: UpdateOptions<any>) => void): void;
/**
* A hook that is run after updating instances in bulk
*
* @param name
* @param fn A callback function that is called with options
*/
public static afterBulkUpdate(name: string, fn: (options: UpdateOptions<any>) => void): void;
public static afterBulkUpdate(fn: (options: UpdateOptions<any>) => void): void;
/**
* A hook that is run before a find (select) query
*
* @param name
* @param fn A callback function that is called with options
*/
public static beforeFind(name: string, fn: (options: FindOptions<any>) => void): void;
public static beforeFind(fn: (options: FindOptions<any>) => void): void;
/**
* A hook that is run before a connection is established
*
* @param name
* @param fn A callback function that is called with options
*/
public static beforeConnect(name: string, fn: (options: DeepWriteable<Config>) => void): void;
public static beforeConnect(fn: (options: DeepWriteable<Config>) => void): void;
/**
* A hook that is run after a connection is established
*
* @param name
* @param fn A callback function that is called with options
*/
public static afterConnect(name: string, fn: (connection: unknown, options: Config) => void): void;
public static afterConnect(fn: (connection: unknown, options: Config) => void): void;
/**
* A hook that is run before a connection is released
*
* @param name
* @param fn A callback function that is called with options
*/
public static beforeDisconnect(name: string, fn: (connection: unknown) => void): void;
public static beforeDisconnect(fn: (connection: unknown) => void): void;
/**
* A hook that is run after a connection is released
*
* @param name
* @param fn A callback function that is called with options
*/
public static afterDisconnect(name: string, fn: (connection: unknown) => void): void;
public static afterDisconnect(fn: (connection: unknown) => void): void;
/**
* A hook that is run before a find (select) query, after any { include: {all: ...} } options are expanded
*
* @param name
* @param fn A callback function that is called with options
*/
public static beforeFindAfterExpandIncludeAll(name: string, fn: (options: FindOptions<any>) => void): void;
public static beforeFindAfterExpandIncludeAll(fn: (options: FindOptions<any>) => void): void;
/**
* A hook that is run before a find (select) query, after all option parsing is complete
*
* @param name
* @param fn A callback function that is called with options
*/
public static beforeFindAfterOptions(name: string, fn: (options: FindOptions<any>) => void): void;
public static beforeFindAfterOptions(fn: (options: FindOptions<any>) => void): void;
/**
* A hook that is run after a find (select) query
*
* @param name
* @param fn A callback function that is called with instance(s), options
*/
public static afterFind(
name: string,
fn: (instancesOrInstance: Model[] | Model | null, options: FindOptions<any>) => void
): void;
public static afterFind(
fn: (instancesOrInstance: Model[] | Model | null, options: FindOptions<any>) => void
): void;
/**
* A hook that is run before a define call
*
* @param name
* @param fn A callback function that is called with attributes, options
*/
public static beforeDefine<M extends Model>(
name: string,
fn: (attributes: ModelAttributes<M, M['_creationAttributes']>, options: ModelOptions<M>) => void
): void;
public static beforeDefine<M extends Model>(
fn: (attributes: ModelAttributes<M, M['_creationAttributes']>, options: ModelOptions<M>) => void
): void;
/**
* A hook that is run after a define call
*
* @param name
* @param fn A callback function that is called with factory
*/
public static afterDefine(name: string, fn: (model: ModelType) => void): void;
public static afterDefine(fn: (model: ModelType) => void): void;
/**
* A hook that is run before Sequelize() call
*
* @param name
* @param fn A callback function that is called with config, options
*/
public static beforeInit(name: string, fn: (config: Config, options: Options) => void): void;
public static beforeInit(fn: (config: Config, options: Options) => void): void;
/**
* A hook that is run after Sequelize() call
*
* @param name
* @param fn A callback function that is called with sequelize
*/
public static afterInit(name: string, fn: (sequelize: Sequelize) => void): void;
public static afterInit(fn: (sequelize: Sequelize) => void): void;
/**
* A hook that is run before sequelize.sync call
* @param fn A callback function that is called with options passed to sequelize.sync
*/
public static beforeBulkSync(dname: string, fn: (options: SyncOptions) => HookReturn): void;
public static beforeBulkSync(fn: (options: SyncOptions) => HookReturn): void;
/**
* A hook that is run after sequelize.sync call
* @param fn A callback function that is called with options passed to sequelize.sync
*/
public static afterBulkSync(name: string, fn: (options: SyncOptions) => HookReturn): void;
public static afterBulkSync(fn: (options: SyncOptions) => HookReturn): void;
/**
* A hook that is run before Model.sync call
* @param fn A callback function that is called with options passed to Model.sync
*/
public static beforeSync(name: string, fn: (options: SyncOptions) => HookReturn): void;
public static beforeSync(fn: (options: SyncOptions) => HookReturn): void;
/**
* A hook that is run after Model.sync call
* @param fn A callback function that is called with options passed to Model.sync
*/
public static afterSync(name: string, fn: (options: SyncOptions) => HookReturn): void;
public static afterSync(fn: (options: SyncOptions) => HookReturn): void;
/**
* Use CLS with Sequelize.
* CLS namespace provided is stored as `Sequelize._cls`
* and Promise is patched to use the namespace, using `cls-hooked` module.
*
* @param namespace
*/
public static useCLS(namespace: object): typeof Sequelize;
/**
* A reference to Sequelize constructor from sequelize. Useful for accessing DataTypes, Errors etc.
*/
public Sequelize: typeof Sequelize;
/**
* Final config that is used by sequelize.
*/
public readonly config: Config;
public readonly modelManager: ModelManager;
public readonly connectionManager: ConnectionManager;
/**
* Dictionary of all models linked with this instance.
*/
public readonly models: {
[key: string]: ModelCtor<Model>;
};
/**
* Instantiate sequelize with name of database, username and password
*
* #### Example usage
*
* ```javascript
* // without password and options
* const sequelize = new Sequelize('database', 'username')
*
* // without options
* const sequelize = new Sequelize('database', 'username', 'password')
*
* // without password / with blank password
* const sequelize = new Sequelize('database', 'username', null, {})
*
* // with password and options
* const sequelize = new Sequelize('my_database', 'john', 'doe', {})
*
* // with uri (see below)
* const sequelize = new Sequelize('mysql://localhost:3306/database', {})
* ```
*
* @param database The name of the database
* @param username The username which is used to authenticate against the
* database.
* @param password The password which is used to authenticate against the
* database.
* @param options An object with options.
*/
constructor(database: string, username: string, password?: string, options?: Options);
constructor(database: string, username: string, options?: Options);
constructor(options?: Options);
/**
* Instantiate sequelize with an URI
* @param uri A full database URI
* @param options See above for possible options
*/
constructor(uri: string, options?: Options);
/**
* A hook that is run before validation
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public beforeValidate(name: string, fn: (instance: Model, options: ValidationOptions) => void): void;
public beforeValidate(fn: (instance: Model, options: ValidationOptions) => void): void;
/**
* A hook that is run after validation
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public afterValidate(name: string, fn: (instance: Model, options: ValidationOptions) => void): void;
public afterValidate(fn: (instance: Model, options: ValidationOptions) => void): void;
/**
* A hook that is run before creating a single instance
*
* @param name
* @param fn A callback function that is called with attributes, options
*/
public beforeCreate(name: string, fn: (attributes: Model, options: CreateOptions<any>) => void): void;
public beforeCreate(fn: (attributes: Model, options: CreateOptions<any>) => void): void;
/**
* A hook that is run after creating a single instance
*
* @param name
* @param fn A callback function that is called with attributes, options
*/
public afterCreate(name: string, fn: (attributes: Model, options: CreateOptions<any>) => void): void;
public afterCreate(fn: (attributes: Model, options: CreateOptions<any>) => void): void;
/**
* A hook that is run before destroying a single instance
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public beforeDestroy(name: string, fn: (instance: Model, options: InstanceDestroyOptions) => void): void;
public beforeDestroy(fn: (instance: Model, options: InstanceDestroyOptions) => void): void;
/**
* A hook that is run after destroying a single instance
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public afterDestroy(name: string, fn: (instance: Model, options: InstanceDestroyOptions) => void): void;
public afterDestroy(fn: (instance: Model, options: InstanceDestroyOptions) => void): void;
/**
* A hook that is run before updating a single instance
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public beforeUpdate(name: string, fn: (instance: Model, options: UpdateOptions<any>) => void): void;
public beforeUpdate(fn: (instance: Model, options: UpdateOptions<any>) => void): void;
/**
* A hook that is run after updating a single instance
*
* @param name
* @param fn A callback function that is called with instance, options
*/
public afterUpdate(name: string, fn: (instance: Model, options: UpdateOptions<any>) => void): void;
public afterUpdate(fn: (instance: Model, options: UpdateOptions<any>) => void): void;
/**
* A hook that is run before creating instances in bulk
*
* @param name
* @param fn A callback function that is called with instances, options
*/
public beforeBulkCreate(name: string, fn: (instances: Model[], options: BulkCreateOptions<any>) => void): void;
public beforeBulkCreate(fn: (instances: Model[], options: BulkCreateOptions<any>) => void): void;
/**
* A hook that is run after creating instances in bulk
*
* @param name
* @param fn A callback function that is called with instances, options
*/
public afterBulkCreate(name: string, fn: (instances: Model[], options: BulkCreateOptions<any>) => void): void;
public afterBulkCreate(fn: (instances: Model[], options: BulkCreateOptions<any>) => void): void;
/**
* A hook that is run before destroying instances in bulk
*
* @param name
* @param fn A callback function that is called with options
*/
public beforeBulkDestroy(name: string, fn: (options: BulkCreateOptions<any>) => void): void;
public beforeBulkDestroy(fn: (options: BulkCreateOptions<any>) => void): void;
/**
* A hook that is run after destroying instances in bulk
*
* @param name
* @param fn A callback function that is called with options
*/
public afterBulkDestroy(name: string, fn: (options: DestroyOptions<any>) => void): void;
public afterBulkDestroy(fn: (options: DestroyOptions<any>) => void): void;
/**
* A hook that is run after updating instances in bulk
*
* @param name
* @param fn A callback function that is called with options
*/
public beforeBulkUpdate(name: string, fn: (options: UpdateOptions<any>) => void): void;
public beforeBulkUpdate(fn: (options: UpdateOptions<any>) => void): void;
/**
* A hook that is run after updating instances in bulk
*
* @param name
* @param fn A callback function that is called with options
*/