Skip to content

Commit 7a25080

Browse files
sushantdhimansushantdhiman
authored
docs: update for v6 (#913)
1 parent 2682bf0 commit 7a25080

File tree

9 files changed

+78
-63
lines changed

9 files changed

+78
-63
lines changed

Diff for: ‎.travis.yml

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ jobs:
1414
- stage: test
1515
node_js: 10
1616
env: DIALECT=sqlite SEQUELIZE=latest
17+
- stage: test
18+
node_js: 10
19+
env: DIALECT=sqlite SEQUELIZE=5
20+
1721

1822
install:
1923
- npm install

Diff for: ‎README.md

+18-17
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,16 @@ The [Sequelize](https://sequelize.org) Command Line Interface (CLI)
44

55
## Table of Contents
66

7-
- [Installation](#installation)
8-
- [Contributing](#contributing)
9-
- [Documentation](#documentation)
7+
- [Installation](#installation)
8+
- [Contributing](#contributing)
9+
- [Documentation](#documentation)
1010

1111
## Installation
1212

1313
Make sure you have [Sequelize](https://sequelize.org) installed. Then install the Sequelize CLI to be used in your project with
1414

1515
```bash
16-
npm install --save-dev sequelize-cli // will install v5
17-
npm install --save-dev sequelize-cli@next // will install v6
16+
npm install --save-dev sequelize-cli
1817
```
1918

2019
And then you should be able to run the CLI with
@@ -25,10 +24,10 @@ npx sequelize --help
2524

2625
### Usage
2726

28-
```
29-
Sequelize CLI [Node: 10.15.0, CLI: 5.5.0, ORM: 5.11.0]
27+
```bash
28+
Sequelize CLI [Node: 10.21.0, CLI: 6.0.0, ORM: 6.1.0]
3029

31-
npx sequelize [command]
30+
sequelize <command>
3231

3332
Commands:
3433
sequelize db:migrate Run pending migrations
@@ -47,23 +46,25 @@ Commands:
4746
sequelize init:migrations Initializes migrations
4847
sequelize init:models Initializes models
4948
sequelize init:seeders Initializes seeders
50-
sequelize migration:generate Generates a new migration file [aliases: migration:create]
51-
sequelize model:generate Generates a model and its migration [aliases: model:create]
52-
sequelize seed:generate Generates a new seed file [aliases: seed:create]
49+
sequelize migration:generate Generates a new migration file [aliases: migration:create]
50+
sequelize model:generate Generates a model and its migration [aliases: model:create]
51+
sequelize seed:generate Generates a new seed file [aliases: seed:create]
5352

5453
Options:
55-
--version Show version number [boolean]
56-
--help Show help [boolean]
54+
--version Show version number [boolean]
55+
--help Show help [boolean]
56+
57+
Please specify a command
5758
```
5859

5960
## Contributing
6061

61-
Sequelize CLI is always looking for contributions. You can help us by fixing bugs, reporting bugs or improving documentation.
62+
You can help us by fixing bugs, reporting bugs or improving documentation.
6263

6364
Please read the [contributing guidelines](CONTRIBUTING.md).
6465

6566
## Documentation
6667

67-
- [Migrations Documentation](https://sequelize.org/master/manual/migrations.html)
68-
- [CLI Options](docs/README.md)
69-
- [Frequently Asked Questions](docs/FAQ.md)
68+
- [Migrations Documentation](https://sequelize.org/master/manual/migrations.html)
69+
- [CLI Options](docs/README.md)
70+
- [Frequently Asked Questions](docs/FAQ.md)

Diff for: ‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"pg": "latest",
3535
"pg-hstore": "latest",
3636
"prettier": "^2.0.5",
37-
"sequelize": "latest",
37+
"sequelize": "^6.1.0",
3838
"sqlite3": "latest",
3939
"through2": "^3.0.0"
4040
},

Diff for: ‎src/commands/database.js

+21-18
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ exports.handler = async function (args) {
4646
'template',
4747
]);
4848

49+
const queryInterface = sequelize.getQueryInterface();
50+
const queryGenerator =
51+
queryInterface.queryGenerator || queryInterface.QueryGenerator;
52+
4953
const query = getCreateDatabaseQuery(sequelize, config, options);
5054

5155
switch (command) {
@@ -62,9 +66,9 @@ exports.handler = async function (args) {
6266
case 'db:drop':
6367
await sequelize
6468
.query(
65-
`DROP DATABASE IF EXISTS ${sequelize
66-
.getQueryInterface()
67-
.quoteIdentifier(config.database)}`,
69+
`DROP DATABASE IF EXISTS ${queryGenerator.quoteIdentifier(
70+
config.database
71+
)}`,
6872
{
6973
type: sequelize.QueryTypes.RAW,
7074
}
@@ -80,41 +84,41 @@ exports.handler = async function (args) {
8084
};
8185

8286
function getCreateDatabaseQuery(sequelize, config, options) {
87+
const queryInterface = sequelize.getQueryInterface();
88+
const queryGenerator =
89+
queryInterface.queryGenerator || queryInterface.QueryGenerator;
90+
8391
switch (config.dialect) {
8492
case 'postgres':
8593
case 'postgres-native':
8694
return (
8795
'CREATE DATABASE ' +
88-
sequelize.getQueryInterface().quoteIdentifier(config.database) +
96+
queryGenerator.quoteIdentifier(config.database) +
8997
(options.encoding
90-
? ' ENCODING = ' +
91-
sequelize.getQueryInterface().quoteIdentifier(options.encoding)
98+
? ' ENCODING = ' + queryGenerator.quoteIdentifier(options.encoding)
9299
: '') +
93100
(options.collate
94-
? ' LC_COLLATE = ' +
95-
sequelize.getQueryInterface().quoteIdentifier(options.collate)
101+
? ' LC_COLLATE = ' + queryGenerator.quoteIdentifier(options.collate)
96102
: '') +
97103
(options.ctype
98-
? ' LC_CTYPE = ' +
99-
sequelize.getQueryInterface().quoteIdentifier(options.ctype)
104+
? ' LC_CTYPE = ' + queryGenerator.quoteIdentifier(options.ctype)
100105
: '') +
101106
(options.template
102-
? ' TEMPLATE = ' +
103-
sequelize.getQueryInterface().quoteIdentifier(options.template)
107+
? ' TEMPLATE = ' + queryGenerator.quoteIdentifier(options.template)
104108
: '')
105109
);
106110

107111
case 'mysql':
108112
return (
109113
'CREATE DATABASE IF NOT EXISTS ' +
110-
sequelize.getQueryInterface().quoteIdentifier(config.database) +
114+
queryGenerator.quoteIdentifier(config.database) +
111115
(options.charset
112116
? ' DEFAULT CHARACTER SET ' +
113-
sequelize.getQueryInterface().quoteIdentifier(options.charset)
117+
queryGenerator.quoteIdentifier(options.charset)
114118
: '') +
115119
(options.collate
116120
? ' DEFAULT COLLATE ' +
117-
sequelize.getQueryInterface().quoteIdentifier(options.collate)
121+
queryGenerator.quoteIdentifier(options.collate)
118122
: '')
119123
);
120124

@@ -125,7 +129,7 @@ function getCreateDatabaseQuery(sequelize, config, options) {
125129
"')" +
126130
' BEGIN' +
127131
' CREATE DATABASE ' +
128-
sequelize.getQueryInterface().quoteIdentifier(config.database) +
132+
queryGenerator.quoteIdentifier(config.database) +
129133
(options.collate ? ' COLLATE ' + options.collate : '') +
130134
' END;'
131135
);
@@ -135,8 +139,7 @@ function getCreateDatabaseQuery(sequelize, config, options) {
135139
`Dialect ${config.dialect} does not support db:create / db:drop commands`
136140
);
137141
return (
138-
'CREATE DATABASE ' +
139-
sequelize.getQueryInterface().quoteIdentifier(config.database)
142+
'CREATE DATABASE ' + queryGenerator.quoteIdentifier(config.database)
140143
);
141144
}
142145
}

Diff for: ‎src/core/migrator.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ export function addTimestampsToSchema(migrator) {
110110
return ensureCurrentMetaSchema(migrator)
111111
.then(() => queryInterface.renameTable(tableName, tableName + 'Backup'))
112112
.then(() => {
113-
const sql = queryInterface.QueryGenerator.selectQuery(
114-
tableName + 'Backup'
115-
);
113+
const queryGenerator =
114+
queryInterface.QueryGenerator || queryInterface.queryGenerator;
115+
const sql = queryGenerator.selectQuery(tableName + 'Backup');
116116
return helpers.generic.execQuery(sequelize, sql, {
117117
type: 'SELECT',
118118
raw: true,

Diff for: ‎test/db/db-create.test.js

+5
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ describe(Support.getTestDialectTeaser('db:create'), () => {
3636
}
3737
)
3838
.then((result) => {
39+
expect(result).to.have.length(1);
3940
expect(result[0].exists).to.eql(1);
4041
done();
4142
});
@@ -61,6 +62,7 @@ describe(Support.getTestDialectTeaser('db:create'), () => {
6162
}
6263
)
6364
.then((result) => {
65+
expect(result).to.have.length(1);
6466
expect(result[0].exists).to.eql(1);
6567
done();
6668
});
@@ -91,6 +93,7 @@ describe(Support.getTestDialectTeaser('db:create'), () => {
9193
}
9294
)
9395
.then((result) => {
96+
expect(result).to.have.length(1);
9497
expect(result[0].exists).to.eql(1);
9598
expect(result[0].encoding).to.eql('UTF8');
9699
expect(result[0].collate).to.eql('zh_TW.UTF-8');
@@ -124,6 +127,7 @@ describe(Support.getTestDialectTeaser('db:create'), () => {
124127
}
125128
)
126129
.then((result) => {
130+
expect(result).to.have.length(1);
127131
expect(result[0].exists).to.eql(1);
128132
expect(result[0].encoding).to.eql('UTF8');
129133
expect(result[0].collate).to.eql('zh_TW.UTF-8');
@@ -154,6 +158,7 @@ describe(Support.getTestDialectTeaser('db:create'), () => {
154158
}
155159
)
156160
.then((result) => {
161+
expect(result).to.have.length(1);
157162
expect(result[0].found).to.eql(1);
158163
done();
159164
});

Diff for: ‎test/db/migrate/schema/add_timestamps.test.js

+8-12
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ const gulp = require('gulp');
2020

2121
describe(Support.getTestDialectTeaser(flag), () => {
2222
beforeEach(function (done) {
23+
const queryInterface = this.sequelize.getQueryInterface();
24+
this.queryGenerator =
25+
queryInterface.queryGenerator || queryInterface.QueryGenerator;
26+
2327
prepare.call(this, null, () => {
2428
return gulp
2529
.src(Support.resolveSupportPath('tmp'))
@@ -43,9 +47,7 @@ const gulp = require('gulp');
4347
helpers
4448
.execQuery(
4549
this.sequelize,
46-
this.sequelize
47-
.getQueryInterface()
48-
.QueryGenerator.selectQuery('SequelizeMetaBackup'),
50+
this.queryGenerator.selectQuery('SequelizeMetaBackup'),
4951
{ raw: true }
5052
)
5153
.then((items) => {
@@ -87,9 +89,7 @@ const gulp = require('gulp');
8789
helpers
8890
.execQuery(
8991
this.sequelize,
90-
this.sequelize
91-
.getQueryInterface()
92-
.QueryGenerator.selectQuery('SequelizeMeta'),
92+
this.queryGenerator.selectQuery('SequelizeMeta'),
9393
{ raw: true, type: 'SELECT' }
9494
)
9595
.then((items) => {
@@ -100,19 +100,15 @@ const gulp = require('gulp');
100100
});
101101

102102
it('is possible to undo one of the already executed migrations', function (done) {
103-
const self = this;
104-
105103
gulp
106104
.src(Support.resolveSupportPath('tmp'))
107105
.pipe(helpers.runCli('db:migrate:undo'))
108106
.pipe(
109107
helpers.teardown(() => {
110108
helpers
111109
.execQuery(
112-
self.sequelize,
113-
self.sequelize
114-
.getQueryInterface()
115-
.QueryGenerator.selectQuery('SequelizeMeta'),
110+
this.sequelize,
111+
this.queryGenerator.selectQuery('SequelizeMeta'),
116112
{ raw: true, type: 'SELECT' }
117113
)
118114
.then((items) => {

Diff for: ‎test/support/helpers.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -207,11 +207,13 @@ module.exports = {
207207
},
208208

209209
countTable: function (sequelize, table, callback) {
210-
var QueryGenerator = sequelize.getQueryInterface().QueryGenerator;
210+
const queryInterface = sequelize.getQueryInterface();
211+
const queryGenerator =
212+
queryInterface.QueryGenerator || queryInterface.queryGenerator;
211213

212214
return sequelize
213215
.query(
214-
'SELECT count(*) as count FROM ' + QueryGenerator.quoteTable(table)
216+
'SELECT count(*) as count FROM ' + queryGenerator.quoteTable(table)
215217
)
216218
.then(function (result) {
217219
return callback(result.length === 2 ? result[0] : result);

Diff for: ‎test/support/index.js

+14-10
Original file line numberDiff line numberDiff line change
@@ -107,16 +107,20 @@ var Support = {
107107
sequelize.modelManager.models = [];
108108
}
109109

110-
return sequelize
111-
.getQueryInterface()
112-
.dropAllEnums()
113-
.then(callback)
114-
.catch(function (err) {
115-
console.log(
116-
'Error in support.clearDatabase() dropAllEnums() :: ',
117-
err
118-
);
119-
});
110+
if (sequelize.getQueryInterface().dropAllEnums) {
111+
return sequelize
112+
.getQueryInterface()
113+
.dropAllEnums()
114+
.then(callback)
115+
.catch(function (err) {
116+
console.log(
117+
'Error in support.clearDatabase() dropAllEnums() :: ',
118+
err
119+
);
120+
});
121+
} else {
122+
return Promise.resolve().then(callback);
123+
}
120124
})
121125
.catch(function (err) {
122126
console.log(

0 commit comments

Comments
 (0)