Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
arangodb/arangod/StorageEngine/PhysicalCollection.h

249 lines
10 KiB
C++
Raw Blame History

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 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
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGOD_VOCBASE_PHYSICAL_COLLECTION_H
#define ARANGOD_VOCBASE_PHYSICAL_COLLECTION_H 1
#include "Basics/Common.h"
#include "Basics/ReadWriteLock.h"
#include "Indexes/Index.h"
#include "Indexes/IndexIterator.h"
#include "VocBase/voc-types.h"
#include <velocypack/Builder.h>
namespace arangodb {
namespace transaction {
class Methods;
}
struct KeyLockInfo;
class LocalDocumentId;
class Index;
class IndexIterator;
class LogicalCollection;
class ManagedDocumentResult;
struct OperationOptions;
class Result;
class PhysicalCollection {
public:
virtual ~PhysicalCollection() = default;
virtual PhysicalCollection* clone(LogicalCollection& logical) const = 0;
// path to logical collection
virtual std::string const& path() const = 0;
virtual void setPath(std::string const&) = 0; // should be set during collection creation
// creation happens atm in engine->createCollection
virtual arangodb::Result updateProperties(arangodb::velocypack::Slice const& slice,
bool doSync) = 0;
virtual arangodb::Result persistProperties() = 0;
virtual TRI_voc_rid_t revision(arangodb::transaction::Methods* trx) const = 0;
/// @brief export properties
virtual void getPropertiesVPack(velocypack::Builder&) const = 0;
virtual int close() = 0;
virtual void load() = 0;
virtual void unload() = 0;
// @brief Return the number of documents in this collection
virtual uint64_t numberDocuments(transaction::Methods* trx) const = 0;
/// @brief report extra memory used by indexes etc.
virtual size_t memory() const = 0;
/// @brief opens an existing collection
virtual void open(bool ignoreErrors) = 0;
void drop();
////////////////////////////////////
// -- SECTION Indexes --
///////////////////////////////////
/// @brief fetches current index selectivity estimates
/// if allowUpdate is true, will potentially make a cluster-internal roundtrip
/// to fetch current values!
virtual IndexEstMap clusterIndexEstimates(bool allowUpdate, TRI_voc_tick_t tid) const;
/// @brief sets the current index selectivity estimates
virtual void setClusterIndexEstimates(IndexEstMap&& estimates);
/// @brief flushes the current index selectivity estimates
virtual void flushClusterIndexEstimates();
virtual void prepareIndexes(arangodb::velocypack::Slice indexesSlice) = 0;
bool hasIndexOfType(arangodb::Index::IndexType type) const;
/// @brief find index by definition
static std::shared_ptr<Index> findIndex(velocypack::Slice const&,
std::vector<std::shared_ptr<Index>> const&);
/// @brief Find index by definition
std::shared_ptr<Index> lookupIndex(velocypack::Slice const&) const;
/// @brief Find index by iid
std::shared_ptr<Index> lookupIndex(TRI_idx_iid_t) const;
/// @brief Find index by name
std::shared_ptr<Index> lookupIndex(std::string const&) const;
/// @brief get list of all indices
std::vector<std::shared_ptr<Index>> getIndexes() const;
void getIndexesVPack(velocypack::Builder&, unsigned flags,
std::function<bool(arangodb::Index const*)> const& filter) const;
/// @brief return the figures for a collection
virtual std::shared_ptr<velocypack::Builder> figures();
/// @brief create or restore an index
/// @param restore utilize specified ID, assume index has to be created
virtual std::shared_ptr<Index> createIndex(arangodb::velocypack::Slice const& info,
bool restore, bool& created) = 0;
virtual bool dropIndex(TRI_idx_iid_t iid) = 0;
virtual std::unique_ptr<IndexIterator> getAllIterator(transaction::Methods* trx) const = 0;
virtual std::unique_ptr<IndexIterator> getAnyIterator(transaction::Methods* trx) const = 0;
virtual void invokeOnAllElements(transaction::Methods* trx,
std::function<bool(LocalDocumentId const&)> callback) = 0;
////////////////////////////////////
// -- SECTION DML Operations --
///////////////////////////////////
virtual Result truncate(transaction::Methods& trx, OperationOptions& options) = 0;
/// @brief compact-data operation
virtual Result compact() = 0;
/// @brief Defer a callback to be executed when the collection
/// can be dropped. The callback is supposed to drop
/// the collection and it is guaranteed that no one is using
/// it at that moment.
virtual void deferDropCollection(std::function<bool(LogicalCollection&)> const& callback) = 0;
virtual LocalDocumentId lookupKey(transaction::Methods*,
arangodb::velocypack::Slice const&) const = 0;
virtual Result read(transaction::Methods*, arangodb::velocypack::StringRef const& key,
ManagedDocumentResult& result, bool lock) = 0;
virtual Result read(transaction::Methods*, arangodb::velocypack::Slice const& key,
ManagedDocumentResult& result, bool lock) = 0;
/// @brief read a documument referenced by token (internal method)
virtual bool readDocument(transaction::Methods* trx, LocalDocumentId const& token,
ManagedDocumentResult& result) const = 0;
/// @brief read a documument referenced by token (internal method)
virtual bool readDocumentWithCallback(transaction::Methods* trx,
LocalDocumentId const& token,
IndexIterator::DocumentCallback const& cb) const = 0;
/**
* @brief Perform document insert, may generate a '_key' value
* If (options.returnNew == false && !options.silent) result might
* just contain an object with the '_key' field
* @param callbackDuringLock Called immediately after a successful insert.
* If the insert wasn't successful, it isn't called. May be nullptr.
*/
virtual Result insert(arangodb::transaction::Methods* trx,
arangodb::velocypack::Slice newSlice,
arangodb::ManagedDocumentResult& result,
OperationOptions& options,
bool lock, KeyLockInfo* keyLockInfo,
std::function<void()> const& cbDuringLock) = 0;
Result insert(arangodb::transaction::Methods* trx, arangodb::velocypack::Slice newSlice,
arangodb::ManagedDocumentResult& result, OperationOptions& options, bool lock) {
return insert(trx, newSlice, result, options, lock, nullptr, nullptr);
}
virtual Result update(arangodb::transaction::Methods* trx,
arangodb::velocypack::Slice newSlice,
ManagedDocumentResult& result, OperationOptions& options,
bool lock, ManagedDocumentResult& previous) = 0;
virtual Result replace(arangodb::transaction::Methods* trx,
arangodb::velocypack::Slice newSlice,
ManagedDocumentResult& result, OperationOptions& options,
bool lock, ManagedDocumentResult& previous) = 0;
virtual Result remove(transaction::Methods& trx, velocypack::Slice slice,
ManagedDocumentResult& previous, OperationOptions& options,
bool lock, KeyLockInfo* keyLockInfo,
std::function<void()> const& cbDuringLock) = 0;
protected:
PhysicalCollection(LogicalCollection& collection, arangodb::velocypack::Slice const& info);
/// @brief Inject figures that are specific to StorageEngine
virtual void figuresSpecific(std::shared_ptr<arangodb::velocypack::Builder>&) = 0;
// SECTION: Document pre commit preperation
TRI_voc_rid_t newRevisionId() const;
bool isValidEdgeAttribute(velocypack::Slice const& slice) const;
/// @brief new object for insert, value must have _key set correctly.
Result newObjectForInsert(transaction::Methods* trx, velocypack::Slice const& value,
bool isEdgeCollection, velocypack::Builder& builder,
bool isRestore, TRI_voc_rid_t& revisionId) const;
/// @brief new object for remove, must have _key set
void newObjectForRemove(transaction::Methods* trx, velocypack::Slice const& oldValue,
velocypack::Builder& builder, bool isRestore,
TRI_voc_rid_t& revisionId) const;
/// @brief merge two objects for update
Result mergeObjectsForUpdate(transaction::Methods* trx, velocypack::Slice const& oldValue,
velocypack::Slice const& newValue,
bool isEdgeCollection, bool mergeObjects,
bool keepNull, velocypack::Builder& builder,
bool isRestore, TRI_voc_rid_t& revisionId) const;
/// @brief new object for replace
Result newObjectForReplace(transaction::Methods* trx, velocypack::Slice const& oldValue,
velocypack::Slice const& newValue,
bool isEdgeCollection, velocypack::Builder& builder,
bool isRestore, TRI_voc_rid_t& revisionId) const;
int checkRevision(transaction::Methods* trx, TRI_voc_rid_t expected,
TRI_voc_rid_t found) const;
LogicalCollection& _logicalCollection;
bool const _isDBServer;
mutable basics::ReadWriteLock _indexesLock;
std::vector<std::shared_ptr<Index>> _indexes;
};
} // namespace arangodb
#endif
Reference in New Issue View Git Blame Copy Permalink