1
0
Fork 0
arangodb/js/server/modules/@arangodb/simple-query.js

363 lines
11 KiB
JavaScript

/* jshint strict: false */
// //////////////////////////////////////////////////////////////////////////////
// / @brief Arango Simple Query Language
// /
// / @file
// /
// / DISCLAIMER
// /
// / Copyright 2012 triagens GmbH, Cologne, Germany
// /
// / 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.
// /
// / Copyright holder is triAGENS GmbH, Cologne, Germany
// /
// / @author Dr. Frank Celler
// / @author Copyright 2012, triAGENS GmbH, Cologne, Germany
// //////////////////////////////////////////////////////////////////////////////
var internal = require('internal');
var ArangoError = require('@arangodb').ArangoError;
var sq = require('@arangodb/simple-query-common');
var GeneralArrayCursor = sq.GeneralArrayCursor;
var SimpleQueryAll = sq.SimpleQueryAll;
var SimpleQueryArray = sq.SimpleQueryArray;
var SimpleQueryByExample = sq.SimpleQueryByExample;
var SimpleQueryFulltext = sq.SimpleQueryFulltext;
var SimpleQueryGeo = sq.SimpleQueryGeo;
var SimpleQueryNear = sq.SimpleQueryNear;
var SimpleQueryRange = sq.SimpleQueryRange;
var SimpleQueryWithin = sq.SimpleQueryWithin;
var SimpleQueryWithinRectangle = sq.SimpleQueryWithinRectangle;
// //////////////////////////////////////////////////////////////////////////////
// / @brief rewrites an index id by stripping the collection name from it
// //////////////////////////////////////////////////////////////////////////////
var rewriteIndex = function (id) {
if (id === null || id === undefined) {
return;
}
if (typeof id === 'string') {
return id.replace(/^[a-zA-Z0-9_\-]+\//, '');
}
if (typeof id === 'object' && id.hasOwnProperty('id')) {
return id.id.replace(/^[a-zA-Z0-9_\-]+\//, '');
}
return id;
};
// //////////////////////////////////////////////////////////////////////////////
// / @brief build a limit string
// //////////////////////////////////////////////////////////////////////////////
var limitString = function (skip, limit) {
if (skip > 0 || limit > 0) {
if (limit <= 0) {
limit = 99999999999;
}
return 'LIMIT ' + parseInt(skip, 10) + ', ' + parseInt(limit, 10) + ' ';
}
return '';
};
// //////////////////////////////////////////////////////////////////////////////
// / @brief executes an all query
// //////////////////////////////////////////////////////////////////////////////
SimpleQueryAll.prototype.execute = function () {
if (this._execution !== null) {
return;
}
if (this._skip === null) {
this._skip = 0;
}
var bindVars = { '@collection': this._collection.name() };
var query = 'FOR doc IN @@collection ' + limitString(this._skip, this._limit) + ' RETURN doc';
var documents = require('internal').db._query({ query, bindVars}).toArray();
this._execution = new GeneralArrayCursor(documents);
this._countQuery = documents.length;
this._countTotal = documents.length;
};
// //////////////////////////////////////////////////////////////////////////////
// / @brief executes a query-by-example
// //////////////////////////////////////////////////////////////////////////////
SimpleQueryByExample.prototype.execute = function () {
if (this._execution !== null) {
return;
}
if (this._skip === null || this._skip <= 0) {
this._skip = 0;
}
if (this._example === null ||
typeof this._example !== 'object' ||
Array.isArray(this._example)) {
// invalid datatype for example
var err = new ArangoError();
err.errorNum = internal.errors.ERROR_ARANGO_DOCUMENT_TYPE_INVALID.code;
err.errorMessage = "invalid document type '" + (typeof this._example) + "'";
throw err;
}
var bindVars = { '@collection': this._collection.name() };
var filters = [];
var self = this;
Object.keys(this._example).forEach(function (key) {
var value = self._example[key];
filters.push('FILTER doc.`' + key.replace(/\`/g, '').split('.').join('`.`') + '` == ' + JSON.stringify(value));
});
var query = 'FOR doc IN @@collection ' + filters.join(' ') + ' ' +
limitString(this._skip, this._limit) + ' RETURN doc';
var documents = require('internal').db._query({ query, bindVars}).toArray();
this._execution = new GeneralArrayCursor(documents);
this._countQuery = documents.length;
this._countTotal = documents.length;
};
// //////////////////////////////////////////////////////////////////////////////
// / @brief executes a range query
// //////////////////////////////////////////////////////////////////////////////
SimpleQueryRange.prototype.execute = function () {
if (this._execution !== null) {
return;
}
var query = 'FOR doc IN @@collection ';
var bindVars = {
'@collection': this._collection.name(),
attribute: this._attribute,
left: this._left,
right: this._right
};
if (this._type === 0) {
query += 'FILTER doc.@attribute >= @left && doc.@attribute < @right ';
} else if (this._type === 1) {
query += 'FILTER doc.@attribute >= @left && doc.@attribute <= @right ';
} else {
throw 'unknown type';
}
query += limitString(this._skip, this._limit) + ' RETURN doc';
var documents = require('internal').db._query({ query, bindVars}).toArray();
this._execution = new GeneralArrayCursor(documents);
this._countQuery = documents.length - this._skip;
this._countTotal = documents.length;
};
// //////////////////////////////////////////////////////////////////////////////
// / @brief executes a near query
// //////////////////////////////////////////////////////////////////////////////
SimpleQueryNear.prototype.execute = function () {
if (this._execution !== null) {
return;
}
if (this._skip === null) {
this._skip = 0;
}
if (this._skip < 0) {
var err = new ArangoError();
err.errorNum = internal.errors.ERROR_BAD_PARAMETER.code;
err.errorMessage = 'skip must be non-negative';
throw err;
}
if (this._limit <= 0) {
this._limit = 100;
}
let cluster = require('@arangodb/cluster');
if (cluster.isCoordinator()) {
if (this._distance === null || this._distance === undefined) {
this._distance = '$distance';
}
}
var bindVars = {
'@collection': this._collection.name(),
latitude: this._latitude,
longitude: this._longitude,
limit: parseInt((this._skip || 0) + (this._limit || 99999999999), 10)
};
var query;
if (typeof this._distance === 'string') {
query = 'FOR doc IN NEAR(@@collection, @latitude, @longitude, @limit, @distance) ';
bindVars.distance = this._distance;
} else {
query = 'FOR doc IN NEAR(@@collection, @latitude, @longitude, @limit) ';
}
if (cluster.isCoordinator()) {
query += 'SORT doc.@distance ';
}
query += limitString(this._skip, this._limit) + ' RETURN doc';
let documents = require('internal').db._query({ query, bindVars }).toArray();
this._execution = new GeneralArrayCursor(documents);
this._countQuery = documents.length - this._skip;
this._countTotal = documents.length;
};
// //////////////////////////////////////////////////////////////////////////////
// / @brief executes a within query
// //////////////////////////////////////////////////////////////////////////////
SimpleQueryWithin.prototype.execute = function () {
if (this._execution !== null) {
return;
}
if (this._skip === null) {
this._skip = 0;
}
if (this._skip < 0) {
var err = new ArangoError();
err.errorNum = internal.errors.ERROR_BAD_PARAMETER.code;
err.errorMessage = 'skip must be non-negative';
throw err;
}
let cluster = require('@arangodb/cluster');
if (cluster.isCoordinator()) {
if (this._distance === null || this._distance === undefined) {
this._distance = '$distance';
}
}
var bindVars = {
'@collection': this._collection.name(),
latitude: this._latitude,
longitude: this._longitude,
radius: this._radius
};
var query;
if (typeof this._distance === 'string') {
query = 'FOR doc IN WITHIN(@@collection, @latitude, @longitude, @radius, @distance) ';
bindVars.distance = this._distance;
} else {
query = 'FOR doc IN WITHIN(@@collection, @latitude, @longitude, @radius) ';
}
if (cluster.isCoordinator()) {
query += 'SORT doc.@distance ';
}
query += limitString(this._skip, this._limit) + ' RETURN doc';
let documents = require('internal').db._query({ query, bindVars }).toArray();
this._execution = new GeneralArrayCursor(documents);
this._countQuery = documents.length - this._skip;
this._countTotal = documents.length;
};
// //////////////////////////////////////////////////////////////////////////////
// / @brief executes a fulltext query
// //////////////////////////////////////////////////////////////////////////////
SimpleQueryFulltext.prototype.execute = function () {
if (this._execution !== null) {
return;
}
let bindVars = {
'@collection': this._collection.name(),
attribute: this._attribute,
query: this._query
};
let query = 'FOR doc IN FULLTEXT(@@collection, @attribute, @query) ' +
limitString(this._skip, this._limit) + ' RETURN doc';
let documents = require('internal').db._query({ query, bindVars}).toArray();
this._execution = new GeneralArrayCursor(documents);
this._countQuery = documents.length - this._skip;
this._countTotal = documents.length;
};
// //////////////////////////////////////////////////////////////////////////////
// / @brief executes a within-rectangle query
// //////////////////////////////////////////////////////////////////////////////
SimpleQueryWithinRectangle.prototype.execute = function () {
if (this._execution !== null) {
return;
}
if (this._skip === null) {
this._skip = 0;
}
if (this._skip < 0) {
var err = new ArangoError();
err.errorNum = internal.errors.ERROR_BAD_PARAMETER.code;
err.errorMessage = 'skip must be non-negative';
throw err;
}
var bindVars = {
'@collection': this._collection.name(),
latitude1: this._latitude1,
longitude1: this._longitude1,
latitude2: this._latitude2,
longitude2: this._longitude2
};
let query = 'FOR doc IN WITHIN_RECTANGLE(@@collection, @latitude1, @longitude1, @latitude2, @longitude2) ';
query += limitString(this._skip, this._limit) + ' RETURN doc';
let documents = require('internal').db._query({ query, bindVars }).toArray();
this._execution = new GeneralArrayCursor(documents);
this._countQuery = documents.length - this._skip;
this._countTotal = documents.length;
};
exports.GeneralArrayCursor = GeneralArrayCursor;
exports.SimpleQueryAll = SimpleQueryAll;
exports.SimpleQueryArray = SimpleQueryArray;
exports.SimpleQueryByExample = SimpleQueryByExample;
exports.SimpleQueryFulltext = SimpleQueryFulltext;
exports.SimpleQueryGeo = SimpleQueryGeo;
exports.SimpleQueryNear = SimpleQueryNear;
exports.SimpleQueryRange = SimpleQueryRange;
exports.SimpleQueryWithin = SimpleQueryWithin;
exports.SimpleQueryWithinRectangle = SimpleQueryWithinRectangle;