mirror of https://gitee.com/bigwinds/arangodb
250 lines
9.7 KiB
C++
250 lines
9.7 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief wrapper for single collection transactions
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2004-2012 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 triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// @author Jan Steemann
|
|
/// @author Copyright 2011-2012, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef TRIAGENS_UTILS_SINGLE_COLLECTION_TRANSACTION_H
|
|
#define TRIAGENS_UTILS_SINGLE_COLLECTION_TRANSACTION_H 1
|
|
|
|
#include "common.h"
|
|
|
|
#include "VocBase/barrier.h"
|
|
#include "VocBase/primary-collection.h"
|
|
#include "VocBase/transaction.h"
|
|
#include "VocBase/vocbase.h"
|
|
#include "BasicsC/voc-errors.h"
|
|
|
|
#include "Basics/StringUtils.h"
|
|
#include "Logger/Logger.h"
|
|
|
|
#include "Utils/Transaction.h"
|
|
|
|
namespace triagens {
|
|
namespace arango {
|
|
|
|
template<typename T>
|
|
class SingleCollectionTransaction : public Transaction<T> {
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- class SingleCollectionTransaction
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- constructors and destructors
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup ArangoDB
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief create the transaction, using a collection object
|
|
///
|
|
/// A single collection transaction operates on a single collection (you guessed
|
|
/// it), and may execute at most one write operation if it is a write
|
|
/// transaction. It may execute multiple reads, though.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
SingleCollectionTransaction (TRI_vocbase_t* const vocbase,
|
|
const string& name,
|
|
const TRI_transaction_type_e accessType) :
|
|
Transaction<T>(vocbase, new TransactionCollectionsList(vocbase, name, accessType)),
|
|
_name(name),
|
|
_collection(0) {
|
|
}
|
|
|
|
SingleCollectionTransaction (TRI_vocbase_t* const vocbase,
|
|
const string& name,
|
|
const TRI_transaction_type_e accessType,
|
|
const TRI_col_type_e createType) :
|
|
Transaction<T>(vocbase, new TransactionCollectionsList(vocbase, name, accessType, createType)),
|
|
_name(name),
|
|
_collection(0) {
|
|
}
|
|
|
|
SingleCollectionTransaction (TRI_vocbase_t* const vocbase,
|
|
const string& name,
|
|
const TRI_transaction_type_e accessType,
|
|
const bool create,
|
|
const TRI_col_type_e createType) :
|
|
Transaction<T>(vocbase, new TransactionCollectionsList(vocbase, name, accessType, create, createType)),
|
|
_name(name),
|
|
_collection(0) {
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief end the transaction
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual ~SingleCollectionTransaction () {
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup ArangoDB
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the name of the underlying collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
const string collectionName () const {
|
|
return _name;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get the underlying primary collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline TRI_primary_collection_t* primaryCollection () {
|
|
if (_collection == 0) {
|
|
const vector<TransactionCollection*> collections = this->_collections->getCollections();
|
|
_collection = TRI_GetCollectionTransaction(this->_trx, collections[0]->getName().c_str());
|
|
}
|
|
|
|
assert(_collection != 0);
|
|
assert(_collection->_collection != 0);
|
|
return _collection->_collection;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the collection's shaper
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline TRI_shaper_t* shaper () {
|
|
return primaryCollection()->_shaper;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the collection's barrier list
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline TRI_barrier_list_t* barrierList () {
|
|
return &primaryCollection()->_barrierList;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get the underlying collection's id
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline TRI_voc_cid_t cid () {
|
|
if (_collection == 0) {
|
|
_collection = TRI_GetCollectionTransaction(this->_trx, this->collectionName().c_str());
|
|
}
|
|
|
|
assert(_collection != 0);
|
|
return _collection->_cid;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief read a document within a transaction
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int read (TRI_doc_mptr_t** mptr, const string& key) {
|
|
TRI_primary_collection_t* const primary = primaryCollection();
|
|
|
|
return this->readCollectionDocument(primary, mptr, key);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief read all document ids within a transaction
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int read (vector<string>& ids) {
|
|
TRI_primary_collection_t* primary = primaryCollection();
|
|
|
|
return this->readCollectionDocuments(primary, ids);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief read all documents within a transaction, using skip and limit
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int read (vector<TRI_doc_mptr_t*>& docs,
|
|
TRI_barrier_t** barrier,
|
|
TRI_voc_ssize_t skip,
|
|
TRI_voc_size_t limit,
|
|
uint32_t* total) {
|
|
TRI_primary_collection_t* primary = primaryCollection();
|
|
|
|
return this->readCollectionPointers(primary, docs, barrier, skip, limit, total);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private variables
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup ArangoDB
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief name of the collection used
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
string _name;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief data structure for the single collection used
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
TRI_vocbase_col_t* _collection;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
#endif
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}\\)"
|
|
// End:
|