UNPKG

node-pg-migrate-custom

Version:

Postgresql database migration management tool for node.js

github.com/tonkonogov/node-pg-migrate

tonkonogov/node-pg-migrate

64 lines (42 loc) • 2.5 kB
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
# Table Operations ### `pgm.createTable( tablename, columns, options )` > Create a new table - [postgres docs](http://www.postgresql.org/docs/current/static/sql-createtable.html) **Arguments:** - `tablename` _[[Name](migrations.md#type)]_ - name for the new table - `columns` _[object]_ - column names / options -- see [column definitions section](columns.md#column-definitions) - `options` _[object]_ - table options (optional) - `temporary` _[bool]_ - default false - `ifNotExists` _[bool]_ - default false - `inherits` _[[Name](migrations.md#type)]_ - table(s) to inherit from - `constraints` _[object]_ - table constraints see `expression` of [add constraint](constraints.md#pgmaddconstraint-tablename-constraint_name-expression-) - `like` either: - _[[Name](migrations.md#type)]_ - table(s) to inherit from - or _[object]_ - `table` _[[Name](migrations.md#type)]_ - table(s) to inherit from - `options` _[object]_ - like options (optional) - `including` _[string or array of strings]_ - 'COMMENTS', 'CONSTRAINTS', 'DEFAULTS', 'IDENTITY', 'INDEXES', 'STATISTICS', 'STORAGE', 'ALL' - `excluding` _[string or array of strings]_ - 'COMMENTS', 'CONSTRAINTS', 'DEFAULTS', 'IDENTITY', 'INDEXES', 'STATISTICS', 'STORAGE', 'ALL' - `comment` _[string]_ - adds comment on table **Reverse Operation:** `dropTable` --- ### `pgm.dropTable( tablename, options )` > Drop existing table - [postgres docs](http://www.postgresql.org/docs/current/static/sql-droptable.html) **Arguments:** - `tablename` _[[Name](migrations.md#type)]_ - name of the table to drop - `options` _[object]_ - options: - `ifExists` _[boolean]_ - drops table only if it exists - `cascade` _[boolean]_ - drops also dependent objects --- ### `pgm.renameTable( tablename, new_tablename )` > Rename a table - [postgres docs](http://www.postgresql.org/docs/current/static/sql-altertable.html) **Arguments:** - `tablename` _[[Name](migrations.md#type)]_ - name of the table to rename - `new_table` _[[Name](migrations.md#type)]_ - new name of the table **Reverse Operation:** same operation in opposite direction --- ### `pgm.alterTable( tablename, options )` > Alter existing table - [postgres docs](http://www.postgresql.org/docs/current/static/sql-altertable.html) **Arguments:** - `tablename` _[[Name](migrations.md#type)]_ - name of the table to alter - `options` _[object]_ - options: - `levelSecurity` _[string]_ - `DISABLE`, `ENABLE`, `FORCE`, or `NO FORCE`