mirror of https://gitee.com/bigwinds/arangodb
412 lines
16 KiB
C++
412 lines
16 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief index base class
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
|
|
/// Copyright 2004-2014 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 ArangoDB GmbH, Cologne, Germany
|
|
///
|
|
/// @author Jan Steemann
|
|
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
|
|
/// @author Copyright 2011-2013, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_INDEXES_INDEX_H
|
|
#define ARANGODB_INDEXES_INDEX_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
#include "Basics/AttributeNameParser.h"
|
|
#include "VocBase/document-collection.h"
|
|
#include "VocBase/shaped-json.h"
|
|
#include "VocBase/vocbase.h"
|
|
#include "VocBase/VocShaper.h"
|
|
#include "VocBase/voc-types.h"
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- forward declarations
|
|
// -----------------------------------------------------------------------------
|
|
|
|
struct TRI_doc_mptr_t;
|
|
struct TRI_document_collection_t;
|
|
struct TRI_json_t;
|
|
struct TRI_shaped_json_s;
|
|
struct TRI_transaction_collection_s;
|
|
|
|
namespace triagens {
|
|
namespace aql {
|
|
class Ast;
|
|
struct AstNode;
|
|
class SortCondition;
|
|
struct Variable;
|
|
}
|
|
}
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- struct index_element
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Unified index element. Do not directly construct it.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
struct TRI_index_element_t {
|
|
|
|
private:
|
|
TRI_doc_mptr_t* _document;
|
|
|
|
// Do not use new for this struct, use ...
|
|
TRI_index_element_t () {
|
|
}
|
|
|
|
~TRI_index_element_t () = delete;
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Get a pointer to the Document's masterpointer.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
TRI_doc_mptr_t* document () const {
|
|
return _document;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Set the pointer to the Document's masterpointer.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void document (TRI_doc_mptr_t* doc) noexcept {
|
|
_document = doc;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Get a pointer to sub objects
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
TRI_shaped_sub_t* subObjects () const {
|
|
return reinterpret_cast<TRI_shaped_sub_t*>((char*) &_document + sizeof(TRI_doc_mptr_t*));
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Allocate a new index Element
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static TRI_index_element_t* allocate (size_t numSubs) {
|
|
void* space = TRI_Allocate(
|
|
TRI_UNKNOWN_MEM_ZONE, sizeof(TRI_doc_mptr_t*) + (sizeof(TRI_shaped_sub_t) * numSubs), false
|
|
);
|
|
return new (space) TRI_index_element_t();
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Memory usage of an index element
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline size_t memoryUsage (size_t numSubs) {
|
|
return sizeof(TRI_doc_mptr_t*) + (sizeof(TRI_shaped_sub_t) * numSubs);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Free the index element.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static void free (TRI_index_element_t* el) {
|
|
TRI_ASSERT_EXPENSIVE(el != nullptr);
|
|
TRI_ASSERT_EXPENSIVE(el->document() != nullptr);
|
|
TRI_ASSERT_EXPENSIVE(el->subObjects() != nullptr);
|
|
|
|
TRI_Free(TRI_UNKNOWN_MEM_ZONE, el);
|
|
}
|
|
|
|
};
|
|
|
|
namespace triagens {
|
|
namespace arango {
|
|
class IndexIterator;
|
|
struct IndexIteratorContext;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- class Index
|
|
// -----------------------------------------------------------------------------
|
|
|
|
class Index {
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- constructors / destructors
|
|
// -----------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
Index () = delete;
|
|
Index (Index const&) = delete;
|
|
Index& operator= (Index const&) = delete;
|
|
|
|
Index (TRI_idx_iid_t,
|
|
struct TRI_document_collection_t*,
|
|
std::vector<std::vector<triagens::basics::AttributeName> >const&,
|
|
bool unique,
|
|
bool sparse);
|
|
|
|
explicit Index (struct TRI_json_t const*);
|
|
|
|
virtual ~Index ();
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief index types
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
enum IndexType {
|
|
TRI_IDX_TYPE_UNKNOWN = 0,
|
|
TRI_IDX_TYPE_PRIMARY_INDEX,
|
|
TRI_IDX_TYPE_GEO1_INDEX,
|
|
TRI_IDX_TYPE_GEO2_INDEX,
|
|
TRI_IDX_TYPE_HASH_INDEX,
|
|
TRI_IDX_TYPE_EDGE_INDEX,
|
|
TRI_IDX_TYPE_FULLTEXT_INDEX,
|
|
TRI_IDX_TYPE_PRIORITY_QUEUE_INDEX, // DEPRECATED and not functional anymore
|
|
TRI_IDX_TYPE_SKIPLIST_INDEX,
|
|
TRI_IDX_TYPE_BITARRAY_INDEX, // DEPRECATED and not functional anymore
|
|
TRI_IDX_TYPE_CAP_CONSTRAINT
|
|
};
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public methods
|
|
// -----------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the index id
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline TRI_idx_iid_t id () const {
|
|
return _iid;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the index fields
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline std::vector<std::vector<triagens::basics::AttributeName>> const& fields () const {
|
|
return _fields;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the index fields names
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline std::vector<std::vector<std::string>> fieldNames () const {
|
|
std::vector<std::vector<std::string>> result;
|
|
|
|
for (auto const& it : _fields) {
|
|
std::vector<std::string> parts;
|
|
for (auto const& it2 : it) {
|
|
parts.emplace_back(it2.name);
|
|
}
|
|
result.emplace_back(std::move(parts));
|
|
}
|
|
return result;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not the ith attribute is expanded (somewhere)
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline bool isAttributeExpanded (size_t i) const {
|
|
if (i >= _fields.size()) {
|
|
return false;
|
|
}
|
|
TRI_ASSERT(i < _fields.size());
|
|
for (auto const& it : _fields[i]) {
|
|
if (it.shouldExpand) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the underlying collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline struct TRI_document_collection_t* collection () const {
|
|
return _collection;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return a contextual string for logging
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string context () const;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not the index is sparse
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline bool sparse () const {
|
|
return _sparse;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not the index is unique
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline bool unique () const {
|
|
return _unique;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the name of the index
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
char const* typeName () const {
|
|
return typeName(type());
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the index type based on a type name
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static IndexType type (char const*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the name of an index type
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static char const* typeName (IndexType);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief validate an index id
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static bool validateId (char const*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief validate an index handle (collection name + / + index id)
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static bool validateHandle (char const*,
|
|
size_t*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief generate a new index id
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static TRI_idx_iid_t generateId ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief index comparator, used by the coordinator to detect if two index
|
|
/// contents are the same
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static bool Compare (struct TRI_json_t const* lhs,
|
|
struct TRI_json_t const* rhs);
|
|
|
|
virtual IndexType type () const = 0;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not the index is sorted
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool isSorted () const = 0;
|
|
|
|
virtual bool hasSelectivityEstimate () const = 0;
|
|
virtual double selectivityEstimate () const;
|
|
virtual size_t memory () const = 0;
|
|
virtual triagens::basics::Json toJson (TRI_memory_zone_t*, bool) const;
|
|
virtual triagens::basics::Json toJsonFigures (TRI_memory_zone_t*) const;
|
|
virtual bool dumpFields () const = 0;
|
|
|
|
virtual int insert (struct TRI_doc_mptr_t const*, bool) = 0;
|
|
virtual int remove (struct TRI_doc_mptr_t const*, bool) = 0;
|
|
virtual int postInsert (struct TRI_transaction_collection_s*, struct TRI_doc_mptr_t const*);
|
|
virtual int batchInsert (std::vector<TRI_doc_mptr_t const*> const*, size_t);
|
|
|
|
// a garbage collection function for the index
|
|
virtual int cleanup ();
|
|
|
|
// give index a hint about the expected size
|
|
virtual int sizeHint (size_t);
|
|
|
|
virtual bool hasBatchInsert () const;
|
|
|
|
virtual bool supportsFilterCondition (triagens::aql::AstNode const*,
|
|
triagens::aql::Variable const*,
|
|
size_t,
|
|
size_t&,
|
|
double&) const;
|
|
|
|
virtual bool supportsSortCondition (triagens::aql::SortCondition const*,
|
|
triagens::aql::Variable const*,
|
|
size_t,
|
|
double&) const;
|
|
|
|
virtual IndexIterator* iteratorForCondition (IndexIteratorContext*,
|
|
triagens::aql::Ast*,
|
|
triagens::aql::AstNode const*,
|
|
triagens::aql::Variable const*,
|
|
bool) const;
|
|
|
|
virtual triagens::aql::AstNode* specializeCondition (triagens::aql::AstNode*,
|
|
triagens::aql::Variable const*) const;
|
|
|
|
bool canUseConditionPart (triagens::aql::AstNode const* access,
|
|
triagens::aql::AstNode const* other,
|
|
triagens::aql::AstNode const* op,
|
|
triagens::aql::Variable const* reference,
|
|
bool) const;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- protected variables
|
|
// -----------------------------------------------------------------------------
|
|
|
|
protected:
|
|
|
|
TRI_idx_iid_t const _iid;
|
|
|
|
struct TRI_document_collection_t* _collection;
|
|
|
|
std::vector<std::vector<triagens::basics::AttributeName>> _fields;
|
|
|
|
bool const _unique;
|
|
|
|
bool const _sparse;
|
|
|
|
double _selectivityEstimate;
|
|
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
std::ostream& operator<< (std::ostream&, triagens::arango::Index const*);
|
|
std::ostream& operator<< (std::ostream&, triagens::arango::Index const&);
|
|
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
|
|
// End:
|