mirror of https://gitee.com/bigwinds/arangodb
868 lines
27 KiB
JavaScript
868 lines
27 KiB
JavaScript
/*jslint indent: 2, nomen: true, maxlen: 100, sloppy: true, vars: true, white: true, plusplus: true */
|
|
/*global require */
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @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 arangodb = require("org/arangodb");
|
|
var actions = require("org/arangodb/actions");
|
|
|
|
var API = "_api/index";
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup ArangoAPI
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns all indexes of a collection
|
|
///
|
|
/// @RESTHEADER{GET /_api/index,reads all indexes of a collection}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{collection,string,required}
|
|
/// The collection name.
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Returns an object with an attribute `indexes` containing a list of all
|
|
/// index descriptions for the given collection. The same information is also
|
|
/// available in the `identifiers` as hash map with the index handle as
|
|
/// keys.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Return information about all indexes:
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexAllIndexes}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
///
|
|
/// var response = logCurlRequest('GET', url);
|
|
///
|
|
/// assert(response.code === 200);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function get_api_indexes (req, res) {
|
|
var name = req.parameters.collection;
|
|
var collection = arangodb.db._collection(name);
|
|
|
|
if (collection === null) {
|
|
actions.collectionNotFound(req, res, name);
|
|
return;
|
|
}
|
|
|
|
var list = [], ids = {}, indexes = collection.getIndexes(), i;
|
|
|
|
for (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
|
|
///
|
|
/// @RESTHEADER{GET /_api/index/{index-handle},reads an index}
|
|
///
|
|
/// @RESTURLPARAMETERS
|
|
///
|
|
/// @RESTURLPARAM{index-handle,string,required}
|
|
/// The index-handle.
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// The result is an objects describing the index. It has at least the following
|
|
/// attributes:
|
|
///
|
|
/// - `id`: The identifier of the index.
|
|
///
|
|
/// All other attributes are type-dependent.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index exists, then a `HTTP 200` is
|
|
/// returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If the index does not exist, then a `HTTP 404`
|
|
/// is returned.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexPrimaryIndex}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn);
|
|
///
|
|
/// var url = "/_api/index/" + cn + "/0";
|
|
/// var response = logCurlRequest('GET', url);
|
|
///
|
|
/// assert(response.code === 200);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function get_api_index (req, res) {
|
|
|
|
// .............................................................................
|
|
// /_api/index?collection=<collection-name>
|
|
// .............................................................................
|
|
|
|
if (req.suffix.length === 0) {
|
|
get_api_indexes(req, res);
|
|
}
|
|
|
|
// .............................................................................
|
|
// /_api/index/<collection-name>/<index-identifier>
|
|
// .............................................................................
|
|
|
|
else if (req.suffix.length === 2) {
|
|
var name = decodeURIComponent(req.suffix[0]);
|
|
var collection = arangodb.db._collection(name);
|
|
|
|
if (collection === null) {
|
|
actions.collectionNotFound(req, res, name);
|
|
return;
|
|
}
|
|
|
|
var iid = decodeURIComponent(req.suffix[1]);
|
|
try {
|
|
var index = collection.index(name + "/" + iid);
|
|
if (index !== null) {
|
|
actions.resultOk(req, res, actions.HTTP_OK, index);
|
|
return;
|
|
}
|
|
}
|
|
catch (err) {
|
|
if (err.errorNum === arangodb.ERROR_ARANGO_INDEX_NOT_FOUND ||
|
|
err.errorNum === arangodb.ERROR_ARANGO_COLLECTION_NOT_FOUND) {
|
|
actions.indexNotFound(req, res, collection, iid);
|
|
return;
|
|
}
|
|
throw err;
|
|
}
|
|
}
|
|
else {
|
|
actions.resultBad(req, res, arangodb.ERROR_HTTP_BAD_PARAMETER,
|
|
"expect GET /" + API + "/<index-handle>");
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @fn JSF_post_api_index_cap
|
|
/// @brief creates a cap constraint
|
|
///
|
|
/// @RESTHEADER{POST /_api/index,creates a cap constraint}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{collection,string,required}
|
|
/// The collection name.
|
|
///
|
|
/// @RESTBODYPARAM{cap-constraint,json,required}
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Creates a cap constraint for the collection `collection-name`,
|
|
/// if it does not already exist. Expects an object containing the index details.
|
|
///
|
|
/// - `type`: must be equal to `"cap"`.
|
|
///
|
|
/// - `size`: The maximal number of documents for the collection. If specified,
|
|
/// the value must be greater than zero.
|
|
///
|
|
/// - `byteSize`: The maximal size of the active document data in the collection
|
|
/// (in bytes). If specified, the value must be at least 16384.
|
|
///
|
|
/// Note that the cap constraint does not index particular attributes of the
|
|
/// documents in a collection, but limits the number of documents in the
|
|
/// collection to a maximum value. The cap constraint thus does not support
|
|
/// attribute names specified in the `fields` attribute nor uniqueness of
|
|
/// any kind via the `unique` attribute.
|
|
///
|
|
/// It is allowed to specify either `size` or `byteSize`, or both at
|
|
/// the same time. If both are specified, then the automatic document removal
|
|
/// will be triggered by the first non-met constraint.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index already exists, then an `HTTP 200` is returned.
|
|
///
|
|
/// @RESTRETURNCODE{201}
|
|
/// If the index does not already exist and could be created, then an `HTTP 201`
|
|
/// is returned.
|
|
///
|
|
/// @RESTRETURNCODE{400}
|
|
/// If either `size` or `byteSize` contain invalid values, then an `HTTP 400`
|
|
/// is returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If the `collection-name` is unknown, then a `HTTP 404` is returned.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating a cap constraint
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexCreateNewCapConstraint}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
/// var body = {
|
|
/// type: "cap",
|
|
/// size : 10
|
|
/// };
|
|
///
|
|
/// var response = logCurlRequest('POST', url, JSON.stringify(body));
|
|
///
|
|
/// assert(response.code === 201);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @fn JSF_post_api_index_geo
|
|
/// @brief creates a geo index
|
|
///
|
|
/// @RESTHEADER{POST /_api/index,creates a geo-spatial index}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{collection,string,required}
|
|
/// The collection name.
|
|
///
|
|
/// @RESTBODYPARAM{index-details,json,required}
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Creates a geo-spatial index in the collection `collection-name`, if
|
|
/// it does not already exist. Expects an object containing the index details.
|
|
///
|
|
/// - `type`: must be equal to `"geo"`.
|
|
///
|
|
/// - `fields`: A list with one or two attribute paths.
|
|
///
|
|
/// If it is a list with one attribute path `location`, then a geo-spatial
|
|
/// index on all documents is created using `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.
|
|
///
|
|
/// If it is a list with two attribute paths `latitude` and `longitude`,
|
|
/// then a geo-spatial index on all documents is created using `latitude`
|
|
/// and `longitude` as paths the latitude and the longitude. The value of
|
|
/// the attribute `latitude` and of the attribute `longitude` must a
|
|
/// double. All documents, which do not have the attribute paths or which
|
|
/// values are not suitable, are ignored.
|
|
///
|
|
/// - `geoJson`: If a geo-spatial index on a `location` is constructed
|
|
/// and `geoJson` is `true`, then the order within the list is longitude
|
|
/// followed by latitude. This corresponds to the format described in
|
|
/// http://geojson.org/geojson-spec.html#positions
|
|
///
|
|
/// - `constraint`: If `constraint` is `true`, then a geo-spatial
|
|
/// constraint is created. The constraint is a non-unique variant of the index.
|
|
/// Note that it is also possible to set the `unique` attribute instead of
|
|
/// the `constraint` attribute.
|
|
///
|
|
/// - `ignoreNull`: If a geo-spatial constraint is created and
|
|
/// `ignoreNull` is true, then documents with a null in `location` or at
|
|
/// least one null in `latitude` or `longitude` are ignored.
|
|
///
|
|
/// Note: unique indexes on non-shard keys are not supported in a cluster.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index already exists, then a `HTTP 200` is
|
|
/// returned.
|
|
///
|
|
/// @RESTRETURNCODE{201}
|
|
/// If the index does not already exist and could be created, then a `HTTP 201`
|
|
/// is returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If the `collection-name` is unknown, then a `HTTP 404` is returned.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating a geo index with a location attribute:
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexCreateGeoLocation}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
/// var body = '{ "type": "geo", "fields" : [ "b" ] }';
|
|
///
|
|
/// var response = logCurlRequest('POST', url, body);
|
|
///
|
|
/// assert(response.code === 201);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
///
|
|
/// Creating a geo index with latitude and longitude attributes:
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexCreateGeoLatitudeLongitude}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
/// var body = '{ "type": "geo", "fields" : [ "e", "f" ] }';
|
|
///
|
|
/// var response = logCurlRequest('POST', url, body);
|
|
///
|
|
/// assert(response.code === 201);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @fn JSF_post_api_index_hash
|
|
/// @brief creates a hash index
|
|
///
|
|
/// @RESTHEADER{POST /_api/index,creates a hash index}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{collection-name,string,required}
|
|
/// The collection name.
|
|
///
|
|
/// @RESTBODYPARAM{index-details,json,required}
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Creates a hash index for the collection `collection-name`, if it
|
|
/// does not already exist. The call expects an object containing the index
|
|
/// details.
|
|
///
|
|
/// - `type`: must be equal to `"hash"`.
|
|
///
|
|
/// - `fields`: A list of attribute paths.
|
|
///
|
|
/// - `unique`: If `true`, then create a unique index.
|
|
///
|
|
/// Note: unique indexes on non-shard keys are not supported in a cluster.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index already exists, then a `HTTP 200` is
|
|
/// returned.
|
|
///
|
|
/// @RESTRETURNCODE{201}
|
|
/// If the index does not already exist and could be created, then a `HTTP 201`
|
|
/// is returned.
|
|
///
|
|
/// @RESTRETURNCODE{400}
|
|
/// If the collection already contains documents and you try to create a unique
|
|
/// hash index in such a way that there are documents violating the uniqueness,
|
|
/// then a `HTTP 400` is returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If the `collection-name` is unknown, then a `HTTP 404` is returned.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating an unique constraint:
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexCreateNewUniqueConstraint}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
/// var body = '{ "type": "hash", "unique" : true, "fields" : [ "a", "b" ] }';
|
|
///
|
|
/// var response = logCurlRequest('POST', url, body);
|
|
///
|
|
/// assert(response.code === 201);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
///
|
|
/// Creating a hash index:
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexCreateNewHashIndex}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
/// var body = '{ "type": "hash", "unique" : false, "fields" : [ "a", "b" ] }';
|
|
///
|
|
/// var response = logCurlRequest('POST', url, body);
|
|
///
|
|
/// assert(response.code === 201);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @fn JSF_post_api_index_skiplist
|
|
/// @brief creates a skip-list
|
|
///
|
|
/// @RESTHEADER{POST /_api/index,creates a skip list}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{collection-name,string,required}
|
|
/// The collection name.
|
|
///
|
|
/// @RESTBODYPARAM{index-details,json,required}
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Creates a skip-list index for the collection `collection-name`, if
|
|
/// it does not already exist. The call expects an object containing the index
|
|
/// details.
|
|
///
|
|
/// - `type`: must be equal to `"skiplist"`.
|
|
///
|
|
/// - `fields`: A list of attribute paths.
|
|
///
|
|
/// - `unique`: If `true`, then create a unique index.
|
|
///
|
|
/// Note: unique indexes on non-shard keys are not supported in a cluster.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index already exists, then a `HTTP 200` is
|
|
/// returned.
|
|
///
|
|
/// @RESTRETURNCODE{201}
|
|
/// If the index does not already exist and could be created, then a `HTTP 201`
|
|
/// is returned.
|
|
///
|
|
/// @RESTRETURNCODE{400}
|
|
/// If the collection already contains documents and you try to create a unique
|
|
/// skip-list index in such a way that there are documents violating the
|
|
/// uniqueness, then a `HTTP 400` is returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If the `collection-name` is unknown, then a `HTTP 404` is returned.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating a skiplist:
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexCreateNewSkiplist}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
/// var body = '{ "type": "skiplist", "unique" : false, "fields" : [ "a", "b" ] }';
|
|
///
|
|
/// var response = logCurlRequest('POST', url, body);
|
|
///
|
|
/// assert(response.code === 201);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @fn JSF_post_api_index_fulltext
|
|
/// @brief creates a fulltext index
|
|
///
|
|
/// @RESTHEADER{POST /_api/index,creates a fulltext index}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{collection-name,string,required}
|
|
/// The collection name.
|
|
///
|
|
/// @RESTBODYPARAM{index-details,json,required}
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Creates a fulltext index for the collection `collection-name`, if
|
|
/// it does not already exist. The call expects an object containing the index
|
|
/// details.
|
|
///
|
|
/// - `type`: must be equal to `"fulltext"`.
|
|
///
|
|
/// - `fields`: A list of attribute names. Currently, the list is limited
|
|
/// to exactly one attribute, so the value of `fields` should look like
|
|
/// this for example: `[ "text" ]`.
|
|
///
|
|
/// - `minLength`: Minimum character length of words to index. Will default
|
|
/// to a server-defined value if unspecified. It is thus recommended to set
|
|
/// this value explicitly when creating the index.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index already exists, then a `HTTP 200` is
|
|
/// returned.
|
|
///
|
|
/// @RESTRETURNCODE{201}
|
|
/// If the index does not already exist and could be created, then a `HTTP 201`
|
|
/// is returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If the `collection-name` is unknown, then a `HTTP 404` is returned.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating a fulltext index:
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexCreateNewFulltext}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
/// var body = '{ "type" : "fulltext", "fields" : [ "text" ] }';
|
|
///
|
|
/// var response = logCurlRequest('POST', url, body);
|
|
///
|
|
/// assert(response.code === 201);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @fn JSF_post_api_index_bitarray
|
|
/// @brief creates a bitarray
|
|
///
|
|
/// @RESTHEADER{POST /_api/index,creates a bitarray index}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{collection-name,string,required}
|
|
/// The collection name.
|
|
///
|
|
/// @RESTBODYPARAM{index-details,json,required}
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Creates a bitarray index for the collection `collection-name`, if
|
|
/// it does not already exist. The call expects an object containing the index
|
|
/// details.
|
|
///
|
|
/// - `type`: must be equal to `"bitarray"`.
|
|
///
|
|
/// - `fields`: A list of pairs. A pair consists of an attribute path followed by a list of values.
|
|
///
|
|
/// - `unique`: Must always be set to `false`.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index already exists, then a `HTTP 200` is
|
|
/// returned.
|
|
///
|
|
/// @RESTRETURNCODE{201}
|
|
/// If the index does not already exist and could be created, then a `HTTP 201`
|
|
/// is returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If the `collection-name` is unknown, then a `HTTP 404` is returned.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// Creating a bitarray index:
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexCreateNewBitarray}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index?collection=" + cn;
|
|
/// var body = '{ ' +
|
|
/// '"type" : "bitarray", ' +
|
|
/// '"unique" : false, ' +
|
|
/// '"fields" : [ "x", [0,1,[]], "y", ["a","b",[]] ] ' +
|
|
/// '}';
|
|
///
|
|
/// var response = logCurlRequest('POST', url, body);
|
|
///
|
|
/// assert(response.code === 201);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates an index
|
|
///
|
|
/// @RESTHEADER{POST /_api/index,creates an index}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{collection,string,required}
|
|
/// The collection name.
|
|
///
|
|
/// @RESTBODYPARAM{index-details,json,required}
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Creates a new index in the collection `collection`. Expects
|
|
/// an object containing the index details.
|
|
///
|
|
/// The type of the index to be created must specified in the `type`
|
|
/// attribute of the index details. Depending on the index type, additional
|
|
/// other attributes may need to specified in the request in order to create
|
|
/// the index.
|
|
///
|
|
/// See @ref HttpIndexCap, @ref HttpIndexGeo, @ref HttpIndexHash,
|
|
/// @ref HttpIndexFulltext, and @ref HttpIndexSkiplist for details.
|
|
///
|
|
/// Most indexes (a notable exception being the cap constraint) require the
|
|
/// list of attributes to be indexed in the `fields` attribute of the index
|
|
/// details. Depending on the index type, a single attribute or multiple
|
|
/// attributes may be indexed.
|
|
///
|
|
/// Indexing system attributes such as `_id`, `_key`, `_from`, and `_to`
|
|
/// is not supported by any index type. Manually creating an index that
|
|
/// relies on any of these attributes is unsupported.
|
|
///
|
|
/// Some indexes can be created as unique or non-unique variants. Uniqueness
|
|
/// can be controlled for most indexes by specifying the `unique` in the
|
|
/// index details. Setting it to `true` will create a unique index.
|
|
/// Setting it to `false` or omitting the `unique` attribute will
|
|
/// create a non-unique index.
|
|
///
|
|
/// Note that the following index types do not support uniqueness, and using
|
|
/// the `unique` attribute with these types may lead to an error:
|
|
/// - cap constraints
|
|
/// - fulltext indexes
|
|
/// - bitarray indexes
|
|
///
|
|
/// Note also that unique indexes on non-shard keys are not supported in a
|
|
/// cluster.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index already exists, then an `HTTP 200` is returned.
|
|
///
|
|
/// @RESTRETURNCODE{201}
|
|
/// If the index does not already exist and could be created, then an `HTTP 201`
|
|
/// is returned.
|
|
///
|
|
/// @RESTRETURNCODE{400}
|
|
/// If an invalid index description is posted or attributes are used that the
|
|
/// target index will not support, then an `HTTP 400` is returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If `collection` is unknown, then an `HTTP 404` is returned.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function post_api_index (req, res) {
|
|
if (req.suffix.length !== 0) {
|
|
actions.resultBad(req, res, arangodb.ERROR_HTTP_BAD_PARAMETER,
|
|
"expecting POST /" + API + "?collection=<collection-name>");
|
|
return;
|
|
}
|
|
|
|
var name = req.parameters.collection;
|
|
var collection = arangodb.db._collection(name);
|
|
|
|
if (collection === null) {
|
|
actions.collectionNotFound(req, res, name);
|
|
return;
|
|
}
|
|
|
|
var body = actions.getJsonBody(req, res);
|
|
|
|
if (body === undefined) {
|
|
return;
|
|
}
|
|
|
|
// inject collection name into body
|
|
if (body.collection === undefined) {
|
|
body.collection = name;
|
|
}
|
|
|
|
// fill "unique" attribute from "constraint" attribute to be downward-compatible
|
|
// with old geo index API
|
|
if (body.hasOwnProperty("constraint") && ! body.hasOwnProperty("unique")) {
|
|
body.unique = body.constraint;
|
|
}
|
|
|
|
// rewrite bitarray fields
|
|
if (body.type === "bitarray") {
|
|
if (typeof body.fields === "object" &&
|
|
Array.isArray(body.fields) &&
|
|
body.fields.length > 0) {
|
|
if (! Array.isArray(body.fields[0])) {
|
|
var f = [ ], i;
|
|
for (i = 0; i < body.fields.length; i += 2) {
|
|
f.push([ body.fields[i], body.fields[i + 1] ]);
|
|
}
|
|
body.fields = f;
|
|
}
|
|
}
|
|
}
|
|
|
|
// create the index
|
|
var index = collection.ensureIndex(body);
|
|
if (index.isNewlyCreated) {
|
|
actions.resultOk(req, res, actions.HTTP_CREATED, index);
|
|
}
|
|
else {
|
|
actions.resultOk(req, res, actions.HTTP_OK, index);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief deletes an index
|
|
///
|
|
/// @RESTHEADER{DELETE /_api/index/{index-handle},deletes an index}
|
|
///
|
|
/// @RESTQUERYPARAMETERS
|
|
///
|
|
/// @RESTQUERYPARAM{index-handle,string,required}
|
|
/// The index handle.
|
|
///
|
|
/// @RESTDESCRIPTION
|
|
///
|
|
/// Deletes an index with `index-handle`.
|
|
///
|
|
/// @RESTRETURNCODES
|
|
///
|
|
/// @RESTRETURNCODE{200}
|
|
/// If the index could be deleted, then an `HTTP 200` is
|
|
/// returned.
|
|
///
|
|
/// @RESTRETURNCODE{404}
|
|
/// If the `index-handle` is unknown, then an `HTTP 404` is returned.
|
|
/// @EXAMPLES
|
|
///
|
|
/// @EXAMPLE_ARANGOSH_RUN{RestIndexDeleteUniqueSkiplist}
|
|
/// var cn = "products";
|
|
/// db._drop(cn);
|
|
/// db._create(cn, { waitForSync: true });
|
|
///
|
|
/// var url = "/_api/index/" + db.products.ensureSkiplist("a","b").id;
|
|
///
|
|
/// var response = logCurlRequest('DELETE', url);
|
|
///
|
|
/// assert(response.code === 200);
|
|
///
|
|
/// logJsonResponse(response);
|
|
/// @END_EXAMPLE_ARANGOSH_RUN
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function delete_api_index (req, res) {
|
|
if (req.suffix.length !== 2) {
|
|
actions.resultBad(req, res, arangodb.ERROR_HTTP_BAD_PARAMETER,
|
|
"expect DELETE /" + API + "/<index-handle>");
|
|
return;
|
|
}
|
|
|
|
var name = decodeURIComponent(req.suffix[0]);
|
|
var collection = arangodb.db._collection(name);
|
|
|
|
if (collection === null) {
|
|
actions.collectionNotFound(req, res, name);
|
|
return;
|
|
}
|
|
|
|
var iid = parseInt(decodeURIComponent(req.suffix[1]), 10);
|
|
var dropped = collection.dropIndex(name + "/" + iid);
|
|
|
|
if (dropped) {
|
|
actions.resultOk(req, res, actions.HTTP_OK, { id : name + "/" + iid });
|
|
}
|
|
else {
|
|
actions.indexNotFound(req, res, collection, name + "/" + iid);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief reads or creates an index
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
actions.defineHttp({
|
|
url : API,
|
|
context : "api",
|
|
|
|
callback : function (req, res) {
|
|
try {
|
|
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);
|
|
}
|
|
}
|
|
catch (err) {
|
|
actions.resultException(req, res, err, undefined, false);
|
|
}
|
|
}
|
|
});
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @}\\)"
|
|
// End:
|