mirror of https://gitee.com/bigwinds/arangodb
202 lines
9.9 KiB
C++
202 lines
9.9 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// 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_STORAGE_ENGINE_ARANGO_ENGINE_H
|
|
#define ARANGOD_STORAGE_ENGINE_ARANGO_ENGINE_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
#include "StorageEngine/StorageEngine.h"
|
|
|
|
namespace arangodb {
|
|
|
|
class ArangoEngine final : public StorageEngine {
|
|
public:
|
|
|
|
// create the storage engine
|
|
explicit ArangoEngine(application_features::ApplicationServer*);
|
|
|
|
~ArangoEngine();
|
|
|
|
// inherited from ApplicationFeature
|
|
// ---------------------------------
|
|
|
|
// add the storage engine's specifc options to the global list of options
|
|
void collectOptions(std::shared_ptr<options::ProgramOptions>) override;
|
|
|
|
// validate the storage engine's specific options
|
|
void validateOptions(std::shared_ptr<options::ProgramOptions>) override;
|
|
|
|
// preparation phase for storage engine. can be used for internal setup.
|
|
// the storage engine must not start any threads here or write any files
|
|
void prepare() override;
|
|
|
|
// start the engine. now it's allowed to start engine-specific threads,
|
|
// write files etc.
|
|
void start() override;
|
|
|
|
// stop the storage engine. this can be used to flush all data to disk,
|
|
// shutdown threads etc. it is guaranteed that there will be no read and
|
|
// write requests to the storage engine after this call
|
|
void stop() override;
|
|
|
|
// status functionality
|
|
// --------------------
|
|
|
|
// return the name of the storage engine
|
|
char const* typeName() const override { return "arango"; }
|
|
|
|
// return the version string of the storage engine
|
|
char const* versionString() const override { return "arango-0.0.1"; }
|
|
|
|
// inventory functionality
|
|
// -----------------------
|
|
|
|
// fill the Builder object with an array of databases that were detected
|
|
// by the storage engine. this method must sort out databases that were not
|
|
// fully created (see "createDatabase" below). called at server start only
|
|
void getDatabases(arangodb::velocypack::Builder& result) override;
|
|
|
|
// fill the Builder object with an array of collections (and their corresponding
|
|
// indexes) that were detected by the storage engine. called at server start only
|
|
void getCollectionsAndIndexes(arangodb::velocypack::Builder& result) override;
|
|
|
|
// determine the maximum revision id previously handed out by the storage
|
|
// engine. this value is used as a lower bound for further HLC values handed out by
|
|
// the server. called at server start only, after getDatabases() and getCollectionsAndIndexes()
|
|
uint64_t getMaxRevision() override;
|
|
|
|
// database, collection and index management
|
|
// -----------------------------------------
|
|
|
|
// asks the storage engine to create a database as specified in the VPack
|
|
// Slice object and persist the creation info. It is guaranteed by the server that
|
|
// no other active database with the same name and id exists when this function
|
|
// is called. If this operation fails somewhere in the middle, the storage
|
|
// engine is required to fully clean up the creation and throw only then,
|
|
// so that subsequent database creation requests will not fail.
|
|
// the WAL entry for the database creation will be written *after* the call
|
|
// to "createDatabase" returns
|
|
void createDatabase(TRI_voc_tick_t id, arangodb::velocypack::Slice const& data) override;
|
|
|
|
// asks the storage engine to drop the specified database and persist the
|
|
// deletion info. Note that physical deletion of the database data must not
|
|
// be carried out by this call, as there may
|
|
// still be readers of the database's data. It is recommended that this operation
|
|
// only sets a deletion flag for the database but let's an async task perform
|
|
// the actual deletion. The async task can later call the callback function to
|
|
// check whether the physical deletion of the database is possible.
|
|
// the WAL entry for database deletion will be written *after* the call
|
|
// to "dropDatabase" returns
|
|
void dropDatabase(TRI_voc_tick_t id, std::function<bool()> const& canRemovePhysically) override;
|
|
|
|
// asks the storage engine to create a collection as specified in the VPack
|
|
// Slice object and persist the creation info. It is guaranteed by the server
|
|
// that no other active collection with the same name and id exists in the same
|
|
// database when this function is called. If this operation fails somewhere in
|
|
// the middle, the storage engine is required to fully clean up the creation
|
|
// and throw only then, so that subsequent collection creation requests will not fail.
|
|
// the WAL entry for the collection creation will be written *after* the call
|
|
// to "createCollection" returns
|
|
void createCollection(TRI_voc_tick_t databaseId, TRI_voc_cid_t id,
|
|
arangodb::velocypack::Slice const& data) override;
|
|
|
|
// asks the storage engine to drop the specified collection and persist the
|
|
// deletion info. Note that physical deletion of the collection data must not
|
|
// be carried out by this call, as there may
|
|
// still be readers of the collection's data. It is recommended that this operation
|
|
// only sets a deletion flag for the collection but let's an async task perform
|
|
// the actual deletion.
|
|
// the WAL entry for collection deletion will be written *after* the call
|
|
// to "dropCollection" returns
|
|
void dropCollection(TRI_voc_tick_t databaseId, TRI_voc_cid_t id,
|
|
std::function<bool()> const& canRemovePhysically) override;
|
|
|
|
// asks the storage engine to rename the collection as specified in the VPack
|
|
// Slice object and persist the renaming info. It is guaranteed by the server
|
|
// that no other active collection with the same name and id exists in the same
|
|
// database when this function is called. If this operation fails somewhere in
|
|
// the middle, the storage engine is required to fully revert the rename operation
|
|
// and throw only then, so that subsequent collection creation/rename requests will
|
|
// not fail. the WAL entry for the rename will be written *after* the call
|
|
// to "renameCollection" returns
|
|
void renameCollection(TRI_voc_tick_t databaseId, TRI_voc_cid_t id,
|
|
arangodb::velocypack::Slice const& data) override;
|
|
|
|
// asks the storage engine to change properties of the collection as specified in
|
|
// the VPack Slice object and persist them. If this operation fails
|
|
// somewhere in the middle, the storage engine is required to fully revert the
|
|
// property changes and throw only then, so that subsequent operations will not fail.
|
|
// the WAL entry for the propery change will be written *after* the call
|
|
// to "changeCollection" returns
|
|
void changeCollection(TRI_voc_tick_t databaseId, TRI_voc_cid_t id,
|
|
arangodb::velocypack::Slice const& data) override;
|
|
|
|
// asks the storage engine to create an index as specified in the VPack
|
|
// Slice object and persist the creation info. The database id, collection id
|
|
// and index data are passed in the Slice object. Note that this function
|
|
// is not responsible for inserting the individual documents into the index.
|
|
// If this operation fails somewhere in the middle, the storage engine is required
|
|
// to fully clean up the creation and throw only then, so that subsequent index
|
|
// creation requests will not fail.
|
|
// the WAL entry for the index creation will be written *after* the call
|
|
// to "createIndex" returns
|
|
void createIndex(TRI_voc_tick_t databaseId, TRI_voc_cid_t collectionId,
|
|
TRI_idx_iid_t id, arangodb::velocypack::Slice const& data) override;
|
|
|
|
// asks the storage engine to drop the specified index and persist the deletion
|
|
// info. Note that physical deletion of the index must not be carried out by this call,
|
|
// as there may still be users of the index. It is recommended that this operation
|
|
// only sets a deletion flag for the index but let's an async task perform
|
|
// the actual deletion.
|
|
// the WAL entry for index deletion will be written *after* the call
|
|
// to "dropIndex" returns
|
|
void dropIndex(TRI_voc_tick_t databaseId, TRI_voc_cid_t collectionId,
|
|
TRI_idx_iid_t id) override;
|
|
|
|
// document operations
|
|
// -------------------
|
|
|
|
// iterate all documents of the underlying collection
|
|
// this is called when a collection is openend, and all its documents need to be added to
|
|
// indexes etc.
|
|
void iterateDocuments(TRI_voc_tick_t databaseId, TRI_voc_cid_t collectionId,
|
|
std::function<void(arangodb::velocypack::Slice const&)> const& cb) override;
|
|
|
|
|
|
// adds a document to the storage engine
|
|
// this will be called by the WAL collector when surviving documents are being moved
|
|
// into the storage engine's realm
|
|
void addDocumentRevision(TRI_voc_tick_t databaseId, TRI_voc_cid_t collectionId,
|
|
arangodb::velocypack::Slice const& document) override;
|
|
|
|
// removes a document from the storage engine
|
|
// this will be called by the WAL collector when non-surviving documents are being removed
|
|
// from the storage engine's realm
|
|
void removeDocumentRevision(TRI_voc_tick_t databaseId, TRI_voc_cid_t collectionId,
|
|
arangodb::velocypack::Slice const& document) override;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|