neo4j-driver-core
Version:
Internals of neo4j-driver
153 lines (152 loc) • 6.04 kB
JavaScript
;
/**
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [https://neo4j.com]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* eslint-disable @typescript-eslint/promise-function-async */
Object.defineProperty(exports, "__esModule", { value: true });
exports.Releasable = void 0;
/**
* Interface define a releasable resource shape
*
* @private
* @interface
*/
var Releasable = /** @class */ (function () {
function Releasable() {
}
/**
* @returns {Promise<void>}
*/
Releasable.prototype.release = function () {
throw new Error('Not implemented');
};
return Releasable;
}());
exports.Releasable = Releasable;
/**
* Interface define a common way to acquire a connection
*
* @private
*/
var ConnectionProvider = /** @class */ (function () {
function ConnectionProvider() {
}
/**
* This method acquires a connection against the specified database.
*
* Access mode and Bookmarks only applies to routing driver. Access mode only
* differentiates the target server for the connection, where WRITE selects a
* WRITER server, whereas READ selects a READ server. Bookmarks, when specified,
* is only passed to the routing discovery procedure, for the system database to
* synchronize on creation of databases and is never used in direct drivers.
*
* @param {object} param - object parameter
* @property {string} param.accessMode - the access mode for the to-be-acquired connection
* @property {string} param.database - the target database for the to-be-acquired connection
* @property {Bookmarks} param.bookmarks - the bookmarks to send to routing discovery
* @property {string} param.impersonatedUser - the impersonated user
* @property {function (databaseName:string?)} param.onDatabaseNameResolved - Callback called when the database name get resolved
* @returns {Promise<Connection>}
*/
ConnectionProvider.prototype.acquireConnection = function (param) {
throw Error('Not implemented');
};
/**
* This method checks whether the backend database supports multi database functionality
* by checking protocol handshake result.
*
* @returns {Promise<boolean>}
*/
ConnectionProvider.prototype.supportsMultiDb = function () {
throw Error('Not implemented');
};
/**
* This method checks whether the backend database supports transaction config functionality
* by checking protocol handshake result.
*
* @returns {Promise<boolean>}
*/
ConnectionProvider.prototype.supportsTransactionConfig = function () {
throw Error('Not implemented');
};
/**
* This method checks whether the backend database supports transaction config functionality
* by checking protocol handshake result.
*
* @returns {Promise<boolean>}
*/
ConnectionProvider.prototype.supportsUserImpersonation = function () {
throw Error('Not implemented');
};
/**
* This method checks whether the driver session re-auth functionality
* by checking protocol handshake result
*
* @returns {Promise<boolean>}
*/
ConnectionProvider.prototype.supportsSessionAuth = function () {
throw Error('Not implemented');
};
/**
* This method verifies the connectivity of the database by trying to acquire a connection
* for each server available in the cluster.
*
* @param {object} param - object parameter
* @property {string} param.database - the target database for the to-be-acquired connection
* @property {string} param.accessMode - the access mode for the to-be-acquired connection
*
* @returns {Promise<ServerInfo>} promise resolved with server info or rejected with error.
*/
ConnectionProvider.prototype.verifyConnectivityAndGetServerInfo = function (param) {
throw Error('Not implemented');
};
/**
* This method verifies the authorization credentials work by trying to acquire a connection
* to one of the servers with the given credentials.
*
* @param {object} param - object parameter
* @property {AuthToken} param.auth - the target auth for the to-be-acquired connection
* @property {string} param.database - the target database for the to-be-acquired connection
* @property {string} param.accessMode - the access mode for the to-be-acquired connection
*
* @returns {Promise<boolean>} promise resolved with true if succeed, false if failed with
* authentication issue and rejected with error if non-authentication error happens.
*/
ConnectionProvider.prototype.verifyAuthentication = function (param) {
throw Error('Not implemented');
};
/**
* Returns the protocol version negotiated via handshake.
*
* Note that this function call _always_ causes a round-trip to the server.
*
* @returns {Promise<number>} the protocol version negotiated via handshake.
* @throws {Error} When protocol negotiation fails
*/
ConnectionProvider.prototype.getNegotiatedProtocolVersion = function () {
throw Error('Not Implemented');
};
/**
* Closes this connection provider along with its internals (connections, pools, etc.)
*
* @returns {Promise<void>}
*/
ConnectionProvider.prototype.close = function () {
throw Error('Not implemented');
};
return ConnectionProvider;
}());
exports.default = ConnectionProvider;