mirror of https://gitee.com/bigwinds/arangodb
116 lines
3.9 KiB
C++
116 lines
3.9 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2017 ArangoDB 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 Simon Grätzer
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGOD_VOC_BASE_API_COLLECTIONS_H
|
|
#define ARANGOD_VOC_BASE_API_COLLECTIONS_H 1
|
|
|
|
#include "Basics/Result.h"
|
|
#include "VocBase/AccessMode.h"
|
|
#include "VocBase/voc-types.h"
|
|
#include "VocBase/vocbase.h"
|
|
|
|
#include <velocypack/Builder.h>
|
|
#include <velocypack/Slice.h>
|
|
#include <functional>
|
|
|
|
namespace arangodb {
|
|
class LogicalCollection;
|
|
|
|
namespace transaction {
|
|
class Methods;
|
|
}
|
|
|
|
namespace methods {
|
|
|
|
/// Common code for collection REST handler and v8-collections
|
|
struct Collections {
|
|
struct Context {
|
|
Context(TRI_vocbase_t& vocbase, LogicalCollection& coll);
|
|
Context(
|
|
TRI_vocbase_t& vocbase,
|
|
LogicalCollection& coll,
|
|
transaction::Methods* trx
|
|
);
|
|
|
|
~Context();
|
|
|
|
transaction::Methods* trx(AccessMode::Type const& type, bool embeddable,
|
|
bool forceLoadCollection);
|
|
TRI_vocbase_t& vocbase() const;
|
|
LogicalCollection* coll() const;
|
|
|
|
private:
|
|
TRI_vocbase_t& _vocbase;
|
|
LogicalCollection& _coll;
|
|
transaction::Methods* _trx;
|
|
bool const _responsibleForTrx;
|
|
};
|
|
|
|
typedef std::function<void(LogicalCollection&)> const& FuncCallback;
|
|
typedef std::function<void(velocypack::Slice const&)> const& DocCallback;
|
|
|
|
static void enumerate(TRI_vocbase_t* vocbase, FuncCallback);
|
|
|
|
/// @brief lookup a collection in vocbase or clusterinfo.
|
|
static Result lookup(TRI_vocbase_t* vocbase, std::string const& collection,
|
|
FuncCallback);
|
|
/// Create collection, ownership of collection in callback is
|
|
/// transferred to callee
|
|
static Result create(TRI_vocbase_t*, std::string const& name,
|
|
TRI_col_type_e collectionType,
|
|
velocypack::Slice const& properties,
|
|
bool createWaitsForSyncReplication,
|
|
bool enforceReplicationFactor, FuncCallback);
|
|
|
|
static Result load(TRI_vocbase_t& vocbase, LogicalCollection* coll);
|
|
static Result unload(TRI_vocbase_t* vocbase, LogicalCollection* coll);
|
|
|
|
static Result properties(Context& ctxt, velocypack::Builder&);
|
|
static Result updateProperties(LogicalCollection* coll,
|
|
velocypack::Slice const&);
|
|
|
|
static Result rename(LogicalCollection* coll, std::string const& newName,
|
|
bool doOverride);
|
|
|
|
static Result drop(TRI_vocbase_t*, LogicalCollection* coll,
|
|
bool allowDropSystem, double timeout);
|
|
|
|
static Result warmup(TRI_vocbase_t& vocbase, LogicalCollection const& coll);
|
|
|
|
static Result revisionId(Context& ctxt, TRI_voc_rid_t& rid);
|
|
|
|
/// @brief Helper implementation similar to ArangoCollection.all() in v8
|
|
static arangodb::Result all(TRI_vocbase_t& vocbase, std::string const& cname,
|
|
DocCallback cb);
|
|
};
|
|
#ifdef USE_ENTERPRISE
|
|
Result ULColCoordinatorEnterprise(std::string const& databaseName,
|
|
std::string const& collectionCID,
|
|
TRI_vocbase_col_status_e status);
|
|
|
|
Result DropColCoordinatorEnterprise(LogicalCollection* collection,
|
|
bool allowDropSystem);
|
|
#endif
|
|
}
|
|
}
|
|
|
|
#endif |