knex/src/index.js

74 lines
1.9 KiB
JavaScript
Raw Normal View History

import Raw from './raw';
import Client from './client';
2016-03-02 17:07:05 +01:00
import makeKnex from './util/make-knex';
import parseConnection from './util/parse-connection';
2016-03-02 17:07:05 +01:00
import { assign } from 'lodash';
2016-03-02 17:07:05 +01:00
// The client names we'll allow in the `{name: lib}` pairing.
const aliases = {
pg: 'postgres',
postgresql: 'postgres',
sqlite: 'sqlite3',
};
export default function Knex(config) {
2016-03-02 17:07:05 +01:00
if (typeof config === 'string') {
return new Knex(assign(parseConnection(config), arguments[2]));
2016-03-02 17:07:05 +01:00
}
let Dialect;
2016-03-02 17:07:05 +01:00
if (arguments.length === 0 || (!config.client && !config.dialect)) {
Dialect = Client;
} else if (
typeof config.client === 'function' &&
config.client.prototype instanceof Client
) {
Dialect = config.client;
2016-03-02 17:07:05 +01:00
} else {
const clientName = config.client || config.dialect;
Dialect = require(`./dialects/${aliases[clientName] ||
clientName}/index.js`);
2016-03-02 17:07:05 +01:00
}
if (typeof config.connection === 'string') {
config = assign({}, config, {
connection: parseConnection(config.connection).connection,
});
2016-03-02 17:07:05 +01:00
}
return makeKnex(new Dialect(config));
2016-03-02 17:07:05 +01:00
}
// Expose Client on the main Knex namespace.
Knex.Client = Client;
2016-03-02 17:07:05 +01:00
/* eslint no-console:0 */
2016-09-13 08:19:47 -04:00
Object.defineProperties(Knex, {
VERSION: {
get() {
console.warn(
2016-09-13 08:19:47 -04:00
'Knex.VERSION is deprecated, you can get the module version' +
"by running require('knex/package').version"
);
return '0.12.6';
},
2016-09-13 08:19:47 -04:00
},
Promise: {
get() {
console.warn(
`Knex.Promise is deprecated, either require bluebird or use the global Promise`
);
return require('bluebird');
},
},
});
2016-03-02 17:07:05 +01:00
// Run a "raw" query, though we can't do anything with it other than put
// it in a query statement.
Knex.raw = (sql, bindings) => {
console.warn(
'global Knex.raw is deprecated, use knex.raw (chain off an initialized knex object)'
);
return new Raw().set(sql, bindings);
};