/node_modules/knex/src/dialects/postgres/index.js
JavaScript | 197 lines | 182 code | 13 blank | 2 comment | 4 complexity | b4f12c582c509800338beaea33adacae MD5 | raw file
- // PostgreSQL
- // -------
- var _ = require('lodash')
- var inherits = require('inherits')
- var Client = require('../../client')
- var Promise = require('../../promise')
- var utils = require('./utils')
- var assign = require('lodash/object/assign')
- var QueryCompiler = require('./query/compiler')
- var ColumnCompiler = require('./schema/columncompiler')
- var TableCompiler = require('./schema/tablecompiler')
- var SchemaCompiler = require('./schema/compiler')
- var PGQueryStream;
- function Client_PG(config) {
- Client.apply(this, arguments)
- if (config.returning) {
- this.defaultReturning = config.returning;
- }
- if (config.searchPath) {
- this.searchPath = config.searchPath;
- }
- }
- inherits(Client_PG, Client)
- assign(Client_PG.prototype, {
- QueryCompiler: QueryCompiler,
- ColumnCompiler: ColumnCompiler,
- SchemaCompiler: SchemaCompiler,
- TableCompiler: TableCompiler,
- dialect: 'postgresql',
- driverName: 'pg',
- _driver: function() {
- return require('pg')
- },
- wrapIdentifier: function(value) {
- if (value === '*') return value;
- var matched = value.match(/(.*?)(\[[0-9]\])/);
- if (matched) return this.wrapIdentifier(matched[1]) + matched[2];
- return '"' + value.replace(/"/g, '""') + '"';
- },
- // Prep the bindings as needed by PostgreSQL.
- prepBindings: function(bindings, tz) {
- return _.map(bindings, function(binding) {
- return utils.prepareValue(binding, tz, this.valueForUndefined)
- }, this);
- },
- // Get a raw connection, called by the `pool` whenever a new
- // connection needs to be added to the pool.
- acquireRawConnection: function() {
- var client = this;
- return new Promise(function(resolver, rejecter) {
- var connection = new client.driver.Client(client.connectionSettings);
- connection.connect(function(err, connection) {
- if (err) return rejecter(err);
- connection.on('error', client.__endConnection.bind(client, connection));
- connection.on('end', client.__endConnection.bind(client, connection));
- if (!client.version) {
- return client.checkVersion(connection).then(function(version) {
- client.version = version;
- resolver(connection);
- });
- }
- resolver(connection);
- });
- }).tap(function setSearchPath(connection) {
- return client.setSchemaSearchPath(connection);
- });
- },
- // Used to explicitly close a connection, called internally by the pool
- // when a connection times out or the pool is shutdown.
- destroyRawConnection: function(connection, cb) {
- connection.end()
- cb()
- },
- // In PostgreSQL, we need to do a version check to do some feature
- // checking on the database.
- checkVersion: function(connection) {
- return new Promise(function(resolver, rejecter) {
- connection.query('select version();', function(err, resp) {
- if (err) return rejecter(err);
- resolver(/^PostgreSQL (.*?) /.exec(resp.rows[0].version)[1]);
- });
- });
- },
- // Position the bindings for the query. The escape sequence for question mark
- // is \? (e.g. knex.raw("\\?") since javascript requires '\' to be escaped too...)
- positionBindings: function(sql) {
- var questionCount = 0;
- return sql.replace(/(\\*)(\?)/g, function (match, escapes) {
- if (escapes.length % 2) {
- return '?';
- } else {
- questionCount++;
- return '$' + questionCount;
- }
- });
- },
- setSchemaSearchPath: function(connection, searchPath) {
- var path = (searchPath || this.searchPath);
- if (!path) return Promise.resolve(true);
- return new Promise(function(resolver, rejecter) {
- connection.query('set search_path to ' + path, function(err) {
- if (err) return rejecter(err);
- resolver(true);
- });
- });
- },
- _stream: function(connection, obj, stream, options) {
- PGQueryStream = process.browser ? undefined : require('pg-query-stream');
- var sql = obj.sql = this.positionBindings(obj.sql)
- return new Promise(function(resolver, rejecter) {
- var queryStream = connection.query(new PGQueryStream(sql, obj.bindings, options));
- queryStream.on('error', rejecter);
- // 'error' is not propagated by .pipe, but it breaks the pipe
- stream.on('error', rejecter);
- // 'end' IS propagated by .pipe, by default
- stream.on('end', resolver);
- queryStream.pipe(stream);
- });
- },
- // Runs the query on the specified connection, providing the bindings
- // and any other necessary prep work.
- _query: function(connection, obj) {
- var sql = obj.sql = this.positionBindings(obj.sql)
- if (obj.options) sql = _.extend({text: sql}, obj.options);
- return new Promise(function(resolver, rejecter) {
- connection.query(sql, obj.bindings, function(err, response) {
- if (err) return rejecter(err);
- obj.response = response;
- resolver(obj);
- });
- });
- },
- // Ensures the response is returned in the same format as other clients.
- processResponse: function(obj, runner) {
- var resp = obj.response;
- if (obj.output) return obj.output.call(runner, resp);
- if (obj.method === 'raw') return resp;
- var returning = obj.returning;
- if (resp.command === 'SELECT') {
- if (obj.method === 'first') return resp.rows[0];
- if (obj.method === 'pluck') return _.pluck(resp.rows, obj.pluck);
- return resp.rows;
- }
- if (returning) {
- var returns = [];
- for (var i = 0, l = resp.rows.length; i < l; i++) {
- var row = resp.rows[i];
- if (returning === '*' || Array.isArray(returning)) {
- returns[i] = row;
- } else {
- returns[i] = row[returning];
- }
- }
- return returns;
- }
- if (resp.command === 'UPDATE' || resp.command === 'DELETE') {
- return resp.rowCount;
- }
- return resp;
- },
- __endConnection: function(connection) {
- if (!connection || connection.__knex__disposed) return;
- if (this.pool) {
- connection.__knex__disposed = true;
- this.pool.destroy(connection);
- }
- },
- })
- module.exports = Client_PG