forked from typeorm/typeorm
/
PostgresConnectionOptions.ts
60 lines (48 loc) · 1.7 KB
/
PostgresConnectionOptions.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
import {BaseConnectionOptions} from "../../connection/BaseConnectionOptions";
import {PostgresConnectionCredentialsOptions} from "./PostgresConnectionCredentialsOptions";
/**
* Postgres-specific connection options.
*/
export interface PostgresConnectionOptions extends BaseConnectionOptions, PostgresConnectionCredentialsOptions {
/**
* Database type.
*/
readonly type: "postgres";
/**
* Schema name.
*/
readonly schema?: string;
/**
* Replication setup.
*/
readonly replication?: {
/**
* Master server used by orm to perform writes.
*/
readonly master: PostgresConnectionCredentialsOptions;
/**
* List of read-from severs (slaves).
*/
readonly slaves: PostgresConnectionCredentialsOptions[];
};
/**
* The milliseconds before a timeout occurs during the initial connection to the postgres
* server. If undefined, or set to 0, there is no timeout. Defaults to undefined.
*/
readonly connectTimeoutMS?: number;
/**
* The Postgres extension to use to generate UUID columns. Defaults to uuid-ossp.
* If pgcrypto is selected, TypeORM will use the gen_random_uuid() function from this extension.
* If uuid-ossp is selected, TypeORM will use the uuid_generate_v4() function from this extension.
*/
readonly uuidExtension?: "pgcrypto" | "uuid-ossp";
/*
* Function handling errors thrown by drivers pool.
* Defaults to logging error with `warn` level.
*/
readonly poolErrorHandler?: (err: any) => any;
/**
* Include notification messages from Postgres server in client logs
*/
readonly logNotifications?: boolean;
}