mirror of
https://github.com/knex/knex.git
synced 2025-08-13 11:10:55 +00:00
3c8d08a64b
When this eventually enabled on the client side, we can build this into the build script.
46 lines
1.4 KiB
JavaScript
46 lines
1.4 KiB
JavaScript
// ClientBase
|
|
// ----------
|
|
var Helpers = require('../lib/helpers').Helpers;
|
|
|
|
// The `ClientBase` is assumed as the object that all database `clients`
|
|
// inherit from, and is used in an `instanceof` check when initializing the
|
|
// library. If you wish to write or customize an adapter, just inherit from
|
|
// this base, with `ClientBase.extend`, and you're good to go.
|
|
var ClientBase = function() {};
|
|
|
|
// The methods assumed when building a client.
|
|
ClientBase.prototype = {
|
|
|
|
// Gets the raw connection for the current client.
|
|
getRawConnection: function() {},
|
|
|
|
// Execute a query on the specified `Builder` or `SchemaBuilder`
|
|
// interface. If a `connection` is specified, use it, otherwise
|
|
// acquire a connection, and then dispose of it when we're done.
|
|
query: function() {},
|
|
|
|
// Retrieves a connection from the connection pool,
|
|
// returning a promise.
|
|
getConnection: function() {},
|
|
|
|
// Releases a connection from the connection pool,
|
|
// returning a promise.
|
|
releaseConnection: function(conn) {},
|
|
|
|
// Begins a transaction statement on the instance,
|
|
// resolving with the connection of the current transaction.
|
|
startTransaction: function() {},
|
|
|
|
// Finishes a transaction, taking the `type`
|
|
finishTransaction: function(type, transaction, msg) {},
|
|
|
|
// The pool defaults.
|
|
poolDefaults: function() {}
|
|
|
|
};
|
|
|
|
// Grab the standard `Object.extend` as popularized by Backbone.js.
|
|
ClientBase.extend = Helpers.extend;
|
|
|
|
exports.ClientBase = ClientBase;
|