mirror of https://gitee.com/bigwinds/arangodb
296 lines
12 KiB
C++
296 lines
12 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014-2018 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 Max Neunhoeffer
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGOD_CLUSTER_CLUSTER_METHODS_H
|
|
#define ARANGOD_CLUSTER_CLUSTER_METHODS_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
#include "Basics/StringRef.h"
|
|
#include <velocypack/Slice.h>
|
|
#include <velocypack/velocypack-aliases.h>
|
|
|
|
#include "Agency/AgencyComm.h"
|
|
#include "Cluster/TraverserEngineRegistry.h"
|
|
#include "Rest/HttpResponse.h"
|
|
#include "VocBase/LogicalCollection.h"
|
|
#include "VocBase/voc-types.h"
|
|
|
|
namespace arangodb {
|
|
namespace velocypack {
|
|
template <typename T>
|
|
class Buffer;
|
|
class Builder;
|
|
class Slice;
|
|
}
|
|
|
|
struct OperationOptions;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a copy of all HTTP headers to forward
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::unordered_map<std::string, std::string> getForwardableRequestHeaders(
|
|
GeneralRequest*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief check if a list of attributes have the same values in two vpack
|
|
/// documents
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool shardKeysChanged(LogicalCollection const& collection,
|
|
VPackSlice const& oldValue, VPackSlice const& newValue,
|
|
bool isPatch);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns revision for a sharded collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int revisionOnCoordinator(std::string const& dbname,
|
|
std::string const& collname, TRI_voc_rid_t&);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Warmup index caches on Shards
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int warmupOnCoordinator(std::string const& dbname,
|
|
std::string const& cid);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns figures for a sharded collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int figuresOnCoordinator(std::string const& dbname, std::string const& collname,
|
|
std::shared_ptr<arangodb::velocypack::Builder>&);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief counts number of documents in a coordinator, by shard
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int countOnCoordinator(std::string const& dbname, std::string const& collname,
|
|
transaction::Methods const& trx,
|
|
std::vector<std::pair<std::string, uint64_t>>& result);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief gets the selectivity estimates from DBservers
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int selectivityEstimatesOnCoordinator(std::string const& dbname, std::string const& collname,
|
|
std::unordered_map<std::string, double>& result);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a document in a coordinator
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
Result createDocumentOnCoordinator(
|
|
std::string const& dbname, std::string const& collname,
|
|
transaction::Methods const& trx,
|
|
OperationOptions const& options, arangodb::velocypack::Slice const& slice,
|
|
arangodb::rest::ResponseCode& responseCode,
|
|
std::unordered_map<int, size_t>& errorCounters,
|
|
std::shared_ptr<arangodb::velocypack::Builder>& resultBody);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief delete a document in a coordinator
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int deleteDocumentOnCoordinator(
|
|
std::string const& dbname, std::string const& collname,
|
|
transaction::Methods const& trx,
|
|
VPackSlice const slice, OperationOptions const& options,
|
|
arangodb::rest::ResponseCode& responseCode,
|
|
std::unordered_map<int, size_t>& errorCounters,
|
|
std::shared_ptr<arangodb::velocypack::Builder>& resultBody);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get a document in a coordinator
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int getDocumentOnCoordinator(
|
|
std::string const& dbname, std::string const& collname,
|
|
transaction::Methods const& trx,
|
|
VPackSlice slice, OperationOptions const& options,
|
|
std::unique_ptr<std::unordered_map<std::string, std::string>> headers,
|
|
arangodb::rest::ResponseCode& responseCode,
|
|
std::unordered_map<int, size_t>& errorCounter,
|
|
std::shared_ptr<arangodb::velocypack::Builder>& resultBody);
|
|
|
|
/// @brief fetch edges from TraverserEngines
|
|
/// Contacts all TraverserEngines placed
|
|
/// on the DBServers for the given list
|
|
/// of vertex _id's.
|
|
/// All non-empty and non-cached results
|
|
/// of DBServers will be inserted in the
|
|
/// datalake. Slices used in the result
|
|
/// point to content inside of this lake
|
|
/// only and do not run out of scope unless
|
|
/// the lake is cleared.
|
|
/// TraversalVariant
|
|
|
|
int fetchEdgesFromEngines(
|
|
std::string const&,
|
|
std::unordered_map<ServerID, traverser::TraverserEngineID> const*,
|
|
arangodb::velocypack::Slice vertexId, size_t,
|
|
std::unordered_map<StringRef, arangodb::velocypack::Slice>&,
|
|
std::vector<arangodb::velocypack::Slice>&,
|
|
std::vector<std::shared_ptr<arangodb::velocypack::Builder>>&,
|
|
arangodb::velocypack::Builder&, size_t&, size_t&);
|
|
|
|
/// @brief fetch edges from TraverserEngines
|
|
/// Contacts all TraverserEngines placed
|
|
/// on the DBServers for the given list
|
|
/// of vertex _id's.
|
|
/// All non-empty and non-cached results
|
|
/// of DBServers will be inserted in the
|
|
/// datalake. Slices used in the result
|
|
/// point to content inside of this lake
|
|
/// only and do not run out of scope unless
|
|
/// the lake is cleared.
|
|
/// ShortestPathVariant
|
|
|
|
int fetchEdgesFromEngines(
|
|
std::string const& dbname,
|
|
std::unordered_map<ServerID, traverser::TraverserEngineID> const* engines,
|
|
arangodb::velocypack::Slice vertexId,
|
|
bool backward,
|
|
std::unordered_map<StringRef, arangodb::velocypack::Slice>& cache,
|
|
std::vector<arangodb::velocypack::Slice>& result,
|
|
std::vector<std::shared_ptr<arangodb::velocypack::Builder>>& datalake,
|
|
arangodb::velocypack::Builder& builder, size_t& read);
|
|
|
|
/// @brief fetch vertices from TraverserEngines
|
|
/// Contacts all TraverserEngines placed
|
|
/// on the DBServers for the given list
|
|
/// of vertex _id's.
|
|
/// If any server responds with a document
|
|
/// it will be inserted into the result.
|
|
/// If no server responds with a document
|
|
/// a 'null' will be inserted into the result.
|
|
|
|
void fetchVerticesFromEngines(
|
|
std::string const&,
|
|
std::unordered_map<ServerID, traverser::TraverserEngineID> const*,
|
|
std::unordered_set<StringRef>&,
|
|
std::unordered_map<StringRef, std::shared_ptr<arangodb::velocypack::Buffer<uint8_t>>>&,
|
|
arangodb::velocypack::Builder&);
|
|
|
|
/// @brief fetch vertices from TraverserEngines
|
|
/// Contacts all TraverserEngines placed
|
|
/// on the DBServers for the given list
|
|
/// of vertex _id's.
|
|
/// If any server responds with a document
|
|
/// it will be inserted into the result.
|
|
/// If no server responds with a document
|
|
/// a 'null' will be inserted into the result.
|
|
/// ShortestPath Variant
|
|
|
|
void fetchVerticesFromEngines(
|
|
std::string const&,
|
|
std::unordered_map<ServerID, traverser::TraverserEngineID> const*,
|
|
std::unordered_set<StringRef>&,
|
|
std::unordered_map<StringRef, arangodb::velocypack::Slice>& result,
|
|
std::vector<std::shared_ptr<arangodb::velocypack::Builder>>& datalake,
|
|
arangodb::velocypack::Builder&);
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get a filtered set of edges on Coordinator.
|
|
/// Also returns the result in VelocyPack
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int getFilteredEdgesOnCoordinator(
|
|
std::string const& dbname, std::string const& collname,
|
|
transaction::Methods const& trx,
|
|
std::string const& vertex, TRI_edge_direction_e const& direction,
|
|
arangodb::rest::ResponseCode& responseCode,
|
|
arangodb::velocypack::Builder& result);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief modify a document in a coordinator
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int modifyDocumentOnCoordinator(
|
|
std::string const& dbname, std::string const& collname,
|
|
transaction::Methods const& trx,
|
|
arangodb::velocypack::Slice const& slice, OperationOptions const& options,
|
|
bool isPatch,
|
|
std::unique_ptr<std::unordered_map<std::string, std::string>>& headers,
|
|
arangodb::rest::ResponseCode& responseCode,
|
|
std::unordered_map<int, size_t>& errorCounter,
|
|
std::shared_ptr<arangodb::velocypack::Builder>& resultBody);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief truncate a cluster collection on a coordinator
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int truncateCollectionOnCoordinator(std::string const& dbname,
|
|
std::string const& collname);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief flush Wal on all DBservers
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int flushWalOnAllDBServers(bool waitForSync, bool waitForCollector, double maxWaitTime = -1.0);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief rotate the active journals for the collection on all DBservers
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int rotateActiveJournalOnAllDBServers(std::string const& dbname,
|
|
std::string const& collname);
|
|
|
|
class ClusterMethods {
|
|
public:
|
|
// wrapper Class for static functions.
|
|
// Cannot be instanciated.
|
|
ClusterMethods() = delete;
|
|
~ClusterMethods() = delete;
|
|
|
|
// @brief Create a new collection on coordinator from a parameter VPack
|
|
// Note that this returns a newly allocated object and ownership is
|
|
// transferred
|
|
// to the caller, which is expressed by the returned unique_ptr.
|
|
static std::shared_ptr<LogicalCollection> createCollectionOnCoordinator(
|
|
TRI_col_type_e collectionType,
|
|
TRI_vocbase_t& vocbase,
|
|
arangodb::velocypack::Slice parameters,
|
|
bool ignoreDistributeShardsLikeErrors,
|
|
bool waitForSyncReplication,
|
|
bool enforceReplicationFactor
|
|
);
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Persist collection in Agency and trigger shard creation process
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static std::shared_ptr<LogicalCollection> persistCollectionInAgency(
|
|
LogicalCollection* col, bool ignoreDistributeShardsLikeErrors,
|
|
bool waitForSyncReplication, bool enforceReplicationFactor,
|
|
arangodb::velocypack::Slice parameters);
|
|
};
|
|
|
|
} // namespace arangodb
|
|
|
|
#endif
|