@mysql/xdevapi
Version:
MySQL Connector/Node.js - A Node.js driver for MySQL using the X Protocol and X DevAPI.
188 lines (163 loc) • 6.8 kB
JavaScript
/*
* Copyright (c) 2020, 2022, Oracle and/or its affiliates.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2.0, as
* published by the Free Software Foundation.
*
* This program is also distributed with certain software (including
* but not limited to OpenSSL) that is licensed under separate terms,
* as designated in a particular file or component or in included license
* documentation. The authors of MySQL hereby grant you an
* additional permission to link the program and your derivative works
* with the separately licensed software that they have included with
* MySQL.
*
* Without limiting anything contained in the foregoing, this file,
* which is part of MySQL Connector/Node.js, is also subject to the
* Universal FOSS Exception, version 1.0, a copy of which can be found at
* http://oss.oracle.com/licenses/universal-foss-exception.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License, version 2.0, for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
;
/* eslint-env node, mocha */
const config = require('../../../config');
const errors = require('../../../../lib/constants/errors');
const expect = require('chai').expect;
const fixtures = require('../../../fixtures');
const mysqlx = require('../../../../');
describe('creating indices in collections using CRUD', () => {
const baseConfig = { schema: config.schema || 'mysql-connector-nodejs_test' };
let schema, session, collection;
beforeEach('create default schema', () => {
return fixtures.createSchema(baseConfig.schema);
});
beforeEach('create session using default schema', () => {
const defaultConfig = Object.assign({}, config, baseConfig);
return mysqlx.getSession(defaultConfig)
.then(s => {
session = s;
});
});
beforeEach('load default schema', () => {
schema = session.getDefaultSchema();
});
beforeEach('create collection', () => {
return schema.createCollection('test')
.then(c => {
collection = c;
});
});
afterEach('drop default schema', () => {
return session.dropSchema(schema.getName());
});
afterEach('close session', () => {
return session.close();
});
context('dropping indexes', () => {
it('does not fail to drop a non-existent index', () => {
return collection.dropIndex('foo')
.then(result => expect(result).to.be.false);
});
it('drops a valid index', () => {
return collection
.createIndex('age', {
fields: [{
field: '$.age',
type: 'TINYINT'
}]
})
.then(() => collection.dropIndex('age'))
.then(result => expect(result).to.be.true);
});
});
context('creating indexes', () => {
it('creates a regular index', () => {
const name = 'zip';
const expected = ['BTREE', 'YES', null];
const definition = {
fields: [{
field: '$.zip',
type: 'TEXT(10)',
required: false
}]
};
return collection.createIndex(name, definition)
.then(actual => expect(actual).to.be.true)
.then(() => fixtures.getTableIndex(session, schema.getName(), collection.getName(), name))
.then(actual => expect(actual).to.deep.equal(expected));
});
it('fails to create a duplicate index', () => {
const index = {
fields: [{
field: '$.zip',
type: 'TEXT(10)',
required: false
}]
};
return collection.createIndex('zip', index)
.then(() => {
return collection.createIndex('zip', index)
.then(() => expect.fail())
.catch(err => {
expect(err.info).to.include.keys('code');
expect(err.info.code).to.equal(errors.ER_DUP_KEYNAME);
});
});
});
it('creates a spatial index', () => {
const name = 'coords';
const expected = ['SPATIAL', 'YES', null];
const index = {
fields: [{
field: '$.coords',
type: 'GEOJSON',
required: true,
options: 2,
srid: 4326
}],
type: 'SPATIAL'
};
return collection.createIndex(name, index)
.then(actual => expect(actual).to.be.true)
.then(() => fixtures.getTableIndex(session, schema.getName(), collection.getName(), name))
.then(actual => expect(actual).to.deep.equal(expected));
});
it('creates a multi-value index', () => {
const field = '$.tags';
const name = 'zip';
const expected = ['BTREE', 'YES', `cast(json_extract(\`doc\`,_utf8mb4\\'${field}\\') as char(50) array)`];
const definition = {
fields: [{
field,
type: 'CHAR(50)',
array: true
}]
};
return collection.createIndex(name, definition)
.then(actual => expect(actual).to.be.true)
.then(() => fixtures.getTableIndex(session, schema.getName(), collection.getName(), name))
.then(actual => expect(actual).to.deep.equal(expected));
});
});
context('BUG#33740190 collection DATETIME index', () => {
it('works with a document field containing a JavaScript Date instance', () => {
const field = '$.createdAt';
const name = 'createdAt_idx';
const definition = { fields: [{ field, type: 'DATETIME' }] };
return collection.add({ name: 'foo', createdAt: new Date() })
.execute()
.then(() => {
return collection.createIndex(name, definition);
});
});
});
});