-
Notifications
You must be signed in to change notification settings - Fork 36
/
index.js
219 lines (197 loc) · 7.03 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*
* Copyright (c) 2015, 2024, 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 designed to work 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 either included with
* the program or referenced in the documentation.
*
* 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
*/
'use strict';
const Expr = require('./lib/DevAPI/Expr');
const authenticationManager = require('./lib/Authentication/AuthenticationManager');
const client = require('./lib/DevAPI/Client');
const errors = require('./lib/constants/errors');
const locking = require('./lib/DevAPI/Locking');
const mysql41Auth = require('./lib/Authentication/MySQL41Auth');
const parseUri = require('./lib/DevAPI/Util/URIParser');
const plainAuth = require('./lib/Authentication/PlainAuth');
const query = require('./lib/DevAPI/Query');
const sha256MemoryAuth = require('./lib/Authentication/SHA256MemoryAuth');
const schema = require('./lib/DevAPI/Schema');
const connection = require('./lib/DevAPI/Connection');
/**
* @module mysqlx
*/
/**
* Register default authentication plugins.
*/
authenticationManager.registerPlugin(mysql41Auth);
authenticationManager.registerPlugin(plainAuth);
authenticationManager.registerPlugin(sha256MemoryAuth);
/**
* String validation options.
* @private
* @typedef {Object} StringValidation
* @prop {boolean} [enforceJSON=false]
* @prop {boolean} [allowUndefined=false]
*/
/**
* Parse a connection specification.
* @private
* @param {string|module:Connection~Properties} input - connection specification
* @param {StringValidation} [options] - string validation options
* @throws when the input is not a valid connection specification.
* @returns {Promise.<module:Session>}
*/
function parseConnectionSpec (input, options) {
options = Object.assign({ enforceJSON: false }, options);
const isPlainObject = typeof input === 'object' && !Array.isArray(input);
const isString = typeof input === 'string';
if (!isPlainObject && !isString) {
throw new Error(errors.MESSAGES.ER_DEVAPI_BAD_CONNECTION_DEFINITION);
}
if (isPlainObject) {
return input;
}
try {
return JSON.parse(input);
} catch (err) {
if (err.name === 'SyntaxError' && !options.enforceJSON) {
return parseUri(input);
}
throw err;
}
}
/**
* Create an X DevAPI session using a standalone connection.
* @param {string|module:Connection~Properties} connection - a connection string (URI) or a set of connection properties
* @example
* mysqlx.getSession({ user: 'root' })
* .then(session => {
* console.log(session.inspect()); // { host: 'localhost', port: 33060, user: 'root', pooling: false, ... }
* })
* @returns {Promise.<module:Session>}
*/
exports.getSession = function (connection = {}) {
try {
const config = Object.assign({}, parseConnectionSpec(connection), { pooling: { enabled: false } });
client.validate(config);
// { host: _, port: _, pooling: { enabled: false }, ... }
return client(config).getSession();
} catch (err) {
return Promise.reject(err);
}
};
/**
* Create a new X DevAPI connection pool.
* @param {string|module:Connection~Properties} connection - a connection string (URI) or a set of connection properties
* @param {module:Client~Properties} [options] - extended client options
* @example
* const client = mysqlx.getClient({ user: 'root' }, { pooling: { enabled: true, maxSize: 3 } })
*
* client.getSession()
* .then(session => {
* console.log(session.inspect()); // { host: 'localhost', port: 33060, user: 'root', pooling: true, ... }
* })
* @returns {module:Client}
*/
exports.getClient = function (connection = {}, options = {}) {
const config = Object.assign({}, parseConnectionSpec(connection), parseConnectionSpec(options, { enforceJSON: true, allowUndefined: true }));
client.validate(config);
// { host: _, port: _, pooling: { enabled: _, maxSize: _ }, ... }
return client(config);
};
/**
* Additional options to configure the X DevAPI expression parser.
* @typedef {Object} ParserOptions
* @prop {module:mysqlx~DataModel} [mode] - Data model that determines specific parsing
* rules that apply to document fields or column identifiers.
*/
/**
* Parse an expression string into a Mysqlx.Expr.Expr.
* @param {string} value - expression string
* @param {module:mysqlx~ParserOptions} [options] - additional options
* @return {proto.Mysqlx.Expr.Expr} The protobuf object version.
*/
exports.expr = function (value, { mode = query.Type.DOCUMENT } = {}) {
return Expr({ dataModel: mode, value });
};
/**
* Retrieve the connector version number (from package.json).
* @return {string}
*/
exports.getVersion = function () {
return require('./package').version;
};
/**
* Enum that specifies the existing data model options.
* @readonly
* @name DataModel
* @enum {number}
* @example
* TABLE
* DOCUMENT
*/
/**
* Data model that determines if an X DevAPI expression identifier
* corresponds to table column name or a document field name.
* @const
* @type {DataModel}
* @example
* mysqlx.Mode.TABLE
* mysqlx.Mode.DOCUMENT
*/
exports.Mode = query.Type;
/**
* Locking modes.LockContention
* @const
* @type {Locking.LockContention}
* @example
* mysqlx.LockContention.DEFAULT
* mysqlx.LockContention.NOWAIT
* mysqlx.LockContention.SKIP_LOCKED
*/
exports.LockContention = locking.LockContention;
/**
* Schema validation.
* @const
* @property {module:Schema.ValidationLevel} ValidationLevel
* @example
* mysqlx.Schema.ValidationLevel.OFF
* mysqlx.Schema.ValidationLevel.STRICT
*/
exports.Schema = {
ValidationLevel: schema.ValidationLevel
};
/**
* Conversion mode for downstream integer values.
* @const
* @type {module:Connection~IntegerType}
* @example
* mysqlx.IntegerType.BIGINT
* mysqlx.IntegerType.STRING
* mysqlx.IntegerType.UNSAFE_BIGINT
* mysqlx.IntegerType.UNSAFE_STRING
*/
exports.IntegerType = connection.IntegerType;