mirror of https://gitee.com/bigwinds/arangodb
558 lines
18 KiB
JavaScript
558 lines
18 KiB
JavaScript
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief querying and managing indexes
|
|
///
|
|
/// @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 Achim Brandt
|
|
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
var actions = require("actions");
|
|
var API = "_api/index";
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup AvocadoAPI
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup AvocadoAPI
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns all indexes of an collection
|
|
///
|
|
/// @REST{GET /_api/index?collection=@FA{collection-identifier}}
|
|
///
|
|
/// Returns an object with an attribute @LIT{indexes} containing a list of all
|
|
/// index descriptions for the given collection. The same information is also
|
|
/// available in the @LIT{identifiers} as hash map with the index handle as
|
|
/// keys.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Return information about all indexes:
|
|
///
|
|
/// @verbinclude api-index-all-indexes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function GET_api_indexes (req, res) {
|
|
var name = req.parameters.collection;
|
|
var id = parseInt(name) || name;
|
|
var collection = internal.db._collection(id);
|
|
|
|
if (collection == null) {
|
|
actions.collectionNotFound(req, res, name);
|
|
return;
|
|
}
|
|
|
|
var list = [];
|
|
var ids = {};
|
|
var indexes = collection.getIndexes();
|
|
|
|
for (var i = 0; i < indexes.length; ++i) {
|
|
var index = indexes[i];
|
|
|
|
list.push(index);
|
|
ids[index.id] = index;
|
|
}
|
|
|
|
var result = { indexes : list, identifiers : ids };
|
|
|
|
actions.resultOk(req, res, actions.HTTP_OK, result);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns an index
|
|
///
|
|
/// @REST{GET /_api/index/@FA{index-handle}}
|
|
///
|
|
/// The result is an objects describing the index. It has at least the following
|
|
/// attributes:
|
|
///
|
|
/// - @LIT{id}: The identifier of the collection.
|
|
///
|
|
/// - @LIT{type}: The type of the collection.
|
|
///
|
|
/// All other attributes are type-dependent.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// @verbinclude api-index-primary-index
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function GET_api_index (req, res) {
|
|
|
|
// .............................................................................
|
|
// /_api/indexes?collection=<collection-identifier>
|
|
// .............................................................................
|
|
|
|
if (req.suffix.length == 0) {
|
|
GET_api_indexes(req, res);
|
|
}
|
|
|
|
// .............................................................................
|
|
// /_api/indexes/<collection-identifier>/<index-identifier>
|
|
// .............................................................................
|
|
|
|
else if (req.suffix.length == 2) {
|
|
var name = decodeURIComponent(req.suffix[0]);
|
|
var id = parseInt(name) || name;
|
|
var collection = internal.db._collection(id);
|
|
|
|
if (collection == null) {
|
|
actions.collectionNotFound(req, res, name);
|
|
return;
|
|
}
|
|
|
|
var iid = decodeURIComponent(req.suffix[1]);
|
|
var index = collection.index(collection._id + "/" + iid);
|
|
|
|
if (index == null) {
|
|
actions.indexNotFound(req, res, collection, iid);
|
|
return;
|
|
}
|
|
|
|
actions.resultOk(req, res, actions.HTTP_OK, index);
|
|
}
|
|
else {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"expect GET /" + API + "/<index-handle>");
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a cap constraint
|
|
///
|
|
/// @REST{POST /_api/index?collection=@FA{collection-identifier}}
|
|
///
|
|
/// Creates a cap constraint for the collection @FA{collection-identifier}, if
|
|
/// it does not already exist. Expects an object containing the index details.
|
|
///
|
|
/// - @LIT{type}: must be equal to @LIT{"cap"}.
|
|
///
|
|
/// - @LIT{size}: The maximal size of documents.
|
|
///
|
|
/// If the index does not already exists and could be created, then a @LIT{HTTP
|
|
/// 201} is returned. If the index already exists, then a @LIT{HTTP 200} is
|
|
/// returned.
|
|
///
|
|
/// If the @FA{collection-identifier} is unknown, then a @LIT{HTTP 404} is
|
|
/// returned. It is possible to specify a name instead of an identifier.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating a cap collection
|
|
///
|
|
/// @verbinclude api-index-create-new-cap-constraint
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function POST_api_index_cap (req, res, collection, body) {
|
|
if (! body.hasOwnProperty("size")) {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"expecting a size");
|
|
}
|
|
|
|
try {
|
|
var size = body.size;
|
|
var index = collection.ensureCapConstraint(size);
|
|
|
|
if (index.isNewlyCreated) {
|
|
actions.resultOk(req, res, actions.HTTP_CREATED, index);
|
|
}
|
|
else {
|
|
actions.resultOk(req, res, actions.HTTP_OK, index);
|
|
}
|
|
}
|
|
catch (err) {
|
|
actions.resultException(req, res, err);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a geo index
|
|
///
|
|
/// @REST{POST /_api/index?collection=@FA{collection-identifier}}
|
|
///
|
|
/// Creates a geo-spatial index in the collection @FA{collection-identifier}, if
|
|
/// it does not already exist. Expects an object containing the index details.
|
|
///
|
|
/// - @LIT{type}: must be equal to @LIT{"geo"}.
|
|
///
|
|
/// - @LIT{fields}: A list with one or two attribute paths. <br>
|
|
/// <br>
|
|
/// If it is a list with one attribute path @FA{location}, then a geo-spatial
|
|
/// index on all documents is created using @FA{location} as path to the
|
|
/// coordinates. The value of the attribute must be a list with at least two
|
|
/// double values. The list must contain the latitude (first value) and the
|
|
/// longitude (second value). All documents, which do not have the attribute
|
|
/// path or with value that are not suitable, are ignored.<br>
|
|
/// <br>
|
|
/// If it is a list with two attribute paths @FA{latitude} and @FA{longitude},
|
|
/// then a geo-spatial index on all documents is created using @FA{latitude}
|
|
/// and @FA{longitude} as paths the latitude and the longitude. The value of
|
|
/// the attribute @FA{latitude} and of the attribute @FA{longitude} must a
|
|
/// double. All documents, which do not have the attribute paths or which
|
|
/// values are not suitable, are ignored.
|
|
///
|
|
/// - @LIT{geoJson}: If a geo-spatial index on a @FA{location} is constructed
|
|
/// and @LIT{geoJson} is @LIT{true}, then the order within the list is longitude
|
|
/// followed by latitude. This corresponds to the format described in <br>
|
|
/// <br>
|
|
/// http://geojson.org/geojson-spec.html#positions
|
|
///
|
|
/// - @LIT{constraint}: If @LIT{constraint} is @LIT{true}, then a geo-spatial
|
|
/// constraint instead of an index is created.
|
|
///
|
|
/// - @LIT{ignoreNull}: If a geo-spatial constraint is created and
|
|
/// @FA{ignoreNull} is true, then documents with a null in @FA{location} or at
|
|
/// least one null in @FA{latitude} or @FA{longitude} are ignored.
|
|
///
|
|
/// If the index does not already exists and could be created, then a @LIT{HTTP
|
|
/// 201} is returned. If the index already exists, then a @LIT{HTTP 200} is
|
|
/// returned.
|
|
///
|
|
/// If the @FA{collection-identifier} is unknown, then a @LIT{HTTP 404} is
|
|
/// returned. It is possible to specify a name instead of an identifier.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating a geo index with a location attribute:
|
|
///
|
|
/// @verbinclude api-index-create-geo-location
|
|
///
|
|
/// Creating a geo index with latitude and longitude attributes:
|
|
///
|
|
/// @verbinclude api-index-create-geo-latitude-longitude
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function POST_api_index_geo (req, res, collection, body) {
|
|
var fields = body.fields;
|
|
|
|
if (! (fields instanceof Array)) {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"fields must be a list of attribute paths: " + fields);
|
|
}
|
|
|
|
try {
|
|
var index;
|
|
|
|
if (fields.length == 1) {
|
|
|
|
// attribute list and geoJson
|
|
if (body.hasOwnProperty("geoJson")) {
|
|
if (body.hasOwnProperty("constraint") && body.constraint) {
|
|
if (body.hasOwnProperty("ignoreNull")) {
|
|
index = collection.ensureGeoConstraint(fields[0], body.geoJson, body.ignoreNull);
|
|
}
|
|
else {
|
|
index = collection.ensureGeoConstraint(fields[0], body.geoJson, false);
|
|
}
|
|
}
|
|
else {
|
|
index = collection.ensureGeoIndex(fields[0], body.geoJson);
|
|
}
|
|
}
|
|
|
|
// attribute list
|
|
else {
|
|
if (body.hasOwnProperty("constraint") && body.constraint) {
|
|
if (body.hasOwnProperty("ignoreNull")) {
|
|
index = collection.ensureGeoConstraint(fields[0], body.ignoreNull);
|
|
}
|
|
else {
|
|
index = collection.ensureGeoConstraint(fields[0], false);
|
|
}
|
|
}
|
|
else {
|
|
index = collection.ensureGeoIndex(fields[0]);
|
|
}
|
|
}
|
|
}
|
|
|
|
// attributes
|
|
else if (fields.length == 2) {
|
|
if (body.hasOwnProperty("constraint") && body.constraint) {
|
|
if (body.hasOwnProperty("ignoreNull")) {
|
|
index = collection.ensureGeoConstraint(fields[0], fields[1], body.ignoreNull);
|
|
}
|
|
else {
|
|
index = collection.ensureGeoConstraint(fields[0], fields[1], false);
|
|
}
|
|
}
|
|
else {
|
|
index = collection.ensureGeoIndex(fields[0], fields[1]);
|
|
}
|
|
}
|
|
|
|
// something is wrong
|
|
else {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"fields must be a list of attribute paths of length 1 or 2: " + fields);
|
|
return;
|
|
}
|
|
|
|
if (index.isNewlyCreated) {
|
|
actions.resultOk(req, res, actions.HTTP_CREATED, index);
|
|
}
|
|
else {
|
|
actions.resultOk(req, res, actions.HTTP_OK, index);
|
|
}
|
|
}
|
|
catch (err) {
|
|
actions.resultException(req, res, err);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a hash index
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function POST_api_index_hash (req, res, collection, body) {
|
|
var fields = body.fields;
|
|
|
|
if (! (fields instanceof Array)) {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"fields must be a list of attribute paths: " + fields);
|
|
}
|
|
|
|
try {
|
|
var index;
|
|
|
|
if (body.unique) {
|
|
index = collection.ensureUniqueConstraint.apply(collection, fields);
|
|
}
|
|
else {
|
|
index = collection.ensureHashIndex.apply(collection, fields);
|
|
}
|
|
|
|
if (index.isNewlyCreated) {
|
|
actions.resultOk(req, res, actions.HTTP_CREATED, index);
|
|
}
|
|
else {
|
|
actions.resultOk(req, res, actions.HTTP_OK, index);
|
|
}
|
|
}
|
|
catch (err) {
|
|
actions.resultException(req, res, err);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a skip-list
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function POST_api_index_skiplist (req, res, collection, body) {
|
|
var fields = body.fields;
|
|
|
|
if (! (fields instanceof Array)) {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"fields must be a list of attribute paths: " + fields);
|
|
}
|
|
|
|
try {
|
|
var index;
|
|
|
|
if (body.unique) {
|
|
index = collection.ensureUniqueSkiplist.apply(collection, fields);
|
|
}
|
|
else {
|
|
index = collection.ensureSkiplist.apply(collection, fields);
|
|
}
|
|
|
|
if (index.isNewlyCreated) {
|
|
actions.resultOk(req, res, actions.HTTP_CREATED, index);
|
|
}
|
|
else {
|
|
actions.resultOk(req, res, actions.HTTP_OK, index);
|
|
}
|
|
}
|
|
catch (err) {
|
|
actions.resultException(req, res, err);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates an index
|
|
///
|
|
/// @REST{POST /_api/index?collection=@FA{collection-identifier}}
|
|
///
|
|
/// Creates a new index in the collection @FA{collection-identifier}. Expects
|
|
/// an object containing the index details.
|
|
///
|
|
/// See @ref IndexGeo, @ref IndexHash, and @ref IndexSkiplist for details.
|
|
///
|
|
/// If the index does not already exists and could be created, then a @LIT{HTTP
|
|
/// 201} is returned. If the index already exists, then a @LIT{HTTP 200} is
|
|
/// returned.
|
|
///
|
|
/// If the @FA{collection-identifier} is unknown, then a @LIT{HTTP 404} is
|
|
/// returned. It is possible to specify a name instead of an identifier.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating an unique constraint:
|
|
///
|
|
/// @verbinclude api-index-create-new-unique-constraint
|
|
///
|
|
/// Creating a hash index:
|
|
///
|
|
/// @verbinclude api-index-create-new-hash-index
|
|
///
|
|
/// Creating a skip-list:
|
|
///
|
|
/// @verbinclude api-index-create-new-skiplist
|
|
///
|
|
/// Creating a unique skip-list:
|
|
///
|
|
/// @verbinclude api-index-create-new-unique-skiplist
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function POST_api_index (req, res) {
|
|
if (req.suffix.length != 0) {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"expect POST /" + API + "?collection=<collection-identifer>");
|
|
return;
|
|
}
|
|
|
|
var name = req.parameters.collection;
|
|
var id = parseInt(name) || name;
|
|
var collection = internal.db._collection(id);
|
|
|
|
if (collection == null) {
|
|
actions.collectionNotFound(req, res, name);
|
|
return;
|
|
}
|
|
|
|
var body = actions.getJsonBody(req, res);
|
|
|
|
if (body === undefined) {
|
|
return;
|
|
}
|
|
|
|
if (body.type == "cap") {
|
|
POST_api_index_cap(req, res, collection, body);
|
|
}
|
|
else if (body.type == "geo") {
|
|
POST_api_index_geo(req, res, collection, body);
|
|
}
|
|
else if (body.type == "hash") {
|
|
POST_api_index_hash(req, res, collection, body);
|
|
}
|
|
else if (body.type == "skiplist") {
|
|
POST_api_index_skiplist(req, res, collection, body);
|
|
}
|
|
else {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"unknown index type '" + body.type + "'");
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates an index
|
|
///
|
|
/// @REST{DELETE /_api/index/@FA{index-handle}}
|
|
///
|
|
/// Deletes an index with @FA{index-handle}.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// @verbinclude api-index-delete-unique-skiplist
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function DELETE_api_index (req, res) {
|
|
if (req.suffix.length != 2) {
|
|
actions.resultBad(req, res, actions.ERROR_HTTP_BAD_PARAMETER,
|
|
"expect DELETE /" + API + "/<index-handle>");
|
|
return;
|
|
}
|
|
|
|
var name = decodeURIComponent(req.suffix[0]);
|
|
var id = parseInt(name) || name;
|
|
var collection = internal.db._collection(id);
|
|
|
|
if (collection == null) {
|
|
actions.collectionNotFound(req, res, name);
|
|
return;
|
|
}
|
|
|
|
try {
|
|
var iid = parseInt(decodeURIComponent(req.suffix[1]));
|
|
var droped = collection.dropIndex(collection._id + "/" + iid);
|
|
|
|
if (droped) {
|
|
actions.resultOk(req, res, actions.HTTP_OK, { id : collection._id + "/" + iid });
|
|
}
|
|
else {
|
|
actions.indexNotFound(req, res, collection, collection._id + "/" + iid);
|
|
}
|
|
}
|
|
catch (err) {
|
|
actions.resultException(req, res, err);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief reads or creates a collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
actions.defineHttp({
|
|
url : API,
|
|
context : "api",
|
|
|
|
callback : function (req, res) {
|
|
if (req.requestType == actions.GET) {
|
|
GET_api_index(req, res);
|
|
}
|
|
else if (req.requestType == actions.DELETE) {
|
|
DELETE_api_index(req, res);
|
|
}
|
|
else if (req.requestType == actions.POST) {
|
|
POST_api_index(req, res);
|
|
}
|
|
else {
|
|
actions.resultUnsupported(req, res);
|
|
}
|
|
}
|
|
});
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @}\\)"
|
|
// End:
|