mirror of https://gitee.com/bigwinds/arangodb
140 lines
4.5 KiB
C++
140 lines
4.5 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_ROCKSDB_ENGINE_ROCKSDB_INDEX_H
|
|
#define ARANGOD_ROCKSDB_ENGINE_ROCKSDB_INDEX_H 1
|
|
|
|
#include "Basics/AttributeNameParser.h"
|
|
#include "Basics/Common.h"
|
|
#include "Indexes/Index.h"
|
|
#include "RocksDBEngine/RocksDBKeyBounds.h"
|
|
#include <rocksdb/status.h>
|
|
|
|
namespace rocksdb {class Comparator; class ColumnFamilyHandle;}
|
|
namespace arangodb {
|
|
namespace cache {
|
|
class Cache;
|
|
}
|
|
class LogicalCollection;
|
|
class RocksDBCounterManager;
|
|
class RocksDBMethods;
|
|
|
|
class RocksDBIndex : public Index {
|
|
|
|
protected:
|
|
// This is the number of distinct elements the index estimator can reliably store
|
|
// This correlates directly with the memmory of the estimator:
|
|
// memmory == ESTIMATOR_SIZE * 6 bytes
|
|
static uint64_t const ESTIMATOR_SIZE;
|
|
|
|
protected:
|
|
RocksDBIndex(TRI_idx_iid_t, LogicalCollection*,
|
|
std::vector<std::vector<arangodb::basics::AttributeName>> const&
|
|
attributes,
|
|
bool unique, bool sparse,
|
|
rocksdb::ColumnFamilyHandle* cf,
|
|
uint64_t objectId = 0,
|
|
bool useCache = false);
|
|
|
|
RocksDBIndex(TRI_idx_iid_t, LogicalCollection*,
|
|
arangodb::velocypack::Slice const&, rocksdb::ColumnFamilyHandle* cf,
|
|
bool useCache = false);
|
|
|
|
public:
|
|
~RocksDBIndex();
|
|
void toVelocyPackFigures(VPackBuilder& builder) const override;
|
|
|
|
uint64_t objectId() const { return _objectId; }
|
|
|
|
bool isPersistent() const override final { return true; }
|
|
|
|
/// @brief return a VelocyPack representation of the index
|
|
void toVelocyPack(velocypack::Builder& builder, bool withFigures,
|
|
bool forPersistence) const override;
|
|
|
|
int drop() override;
|
|
|
|
int load() override;
|
|
int unload() override;
|
|
|
|
virtual void truncate(transaction::Methods*);
|
|
|
|
/// @brief provides a size hint for the index
|
|
int sizeHint(transaction::Methods* /*trx*/, size_t /*size*/) override final {
|
|
// nothing to do here
|
|
return TRI_ERROR_NO_ERROR;
|
|
}
|
|
|
|
/// insert index elements into the specified write batch. Should be used
|
|
/// as an optimization for the non transactional fillIndex method
|
|
virtual int insertRaw(RocksDBMethods*, TRI_voc_rid_t,
|
|
arangodb::velocypack::Slice const&) = 0;
|
|
|
|
/// remove index elements and put it in the specified write batch. Should be
|
|
/// used as an optimization for the non transactional fillIndex method
|
|
virtual int removeRaw(RocksDBMethods*, TRI_voc_rid_t,
|
|
arangodb::velocypack::Slice const&) = 0;
|
|
|
|
void createCache();
|
|
void disableCache();
|
|
|
|
virtual void serializeEstimate(std::string& output) const;
|
|
|
|
virtual bool deserializeEstimate(RocksDBCounterManager* mgr);
|
|
|
|
virtual void recalculateEstimates();
|
|
|
|
rocksdb::ColumnFamilyHandle* columnFamily() const{
|
|
return _cf;
|
|
}
|
|
|
|
rocksdb::Comparator const* comparator() const;
|
|
|
|
protected:
|
|
// Will be called during truncate to allow the index to update selectivity
|
|
// estimates, blacklist keys, etc.
|
|
virtual Result postprocessRemove(transaction::Methods* trx,
|
|
rocksdb::Slice const& key, rocksdb::Slice const& value);
|
|
|
|
inline bool useCache() const { return (_useCache && _cachePresent); }
|
|
void blackListKey(char const* data, std::size_t len);
|
|
void blackListKey(StringRef& ref){
|
|
blackListKey(ref.data(), ref.size());
|
|
};
|
|
|
|
RocksDBKeyBounds getBounds() const;
|
|
|
|
protected:
|
|
uint64_t _objectId;
|
|
rocksdb::ColumnFamilyHandle* _cf;
|
|
|
|
mutable std::shared_ptr<cache::Cache> _cache;
|
|
// we use this boolean for testing whether _cache is set.
|
|
// it's quicker than accessing the shared_ptr each time
|
|
bool _cachePresent;
|
|
bool _useCache;
|
|
};
|
|
} // namespace arangodb
|
|
|
|
#endif
|