mirror of https://gitee.com/bigwinds/arangodb
280 lines
11 KiB
C++
280 lines
11 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Infrastructure for ExecutionBlocks (the execution engine)
|
|
///
|
|
/// @file arangod/Aql/ExecutionBlock.h
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2010-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 triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// @author Michael Hackstein
|
|
/// @author Copyright 2015, ArangoDB GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_AQL_TRAVERSAL_BLOCK_H
|
|
#define ARANGODB_AQL_TRAVERSAL_BLOCK_H 1
|
|
|
|
#include "Aql/ExecutionBlock.h"
|
|
#include "Aql/TraversalNode.h"
|
|
#include "VocBase/Traverser.h"
|
|
|
|
namespace triagens {
|
|
namespace aql {
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- TraversalBlock
|
|
// -----------------------------------------------------------------------------
|
|
|
|
class TraversalBlock : public ExecutionBlock {
|
|
|
|
public:
|
|
|
|
TraversalBlock (ExecutionEngine* engine,
|
|
TraversalNode const* ep);
|
|
|
|
~TraversalBlock ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief cleanup, here we clean up all internally generated values
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void freeCaches ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief initialize, here we fetch all docs from the database
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int initialize () override;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief initializeCursor
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int initializeCursor (AqlItemBlock* items, size_t pos) override;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief getSome
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
AqlItemBlock* getSome (size_t atLeast, size_t atMost) override final;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// skip between atLeast and atMost, returns the number actually skipped . . .
|
|
// will only return less than atLeast if there aren't atLeast many
|
|
// things to skip overall.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t skipSome (size_t atLeast, size_t atMost) override final;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private variables
|
|
// -----------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief vertices buffer
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<triagens::aql::AqlValue> _vertices;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief edges buffer
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<triagens::aql::AqlValue> _edges;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief path buffer
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<triagens::aql::AqlValue> _paths;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief current position in _paths, _edges, _vertices
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t _posInPaths;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Depth first Traverser object
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::unique_ptr<triagens::arango::traverser::Traverser> _traverser;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief The information to get the starting point, when a register id is used
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
triagens::aql::RegisterId _reg;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Keep a copy of the start vertex id-string. Can be freed if this start
|
|
/// vertex is not in use any more.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string _vertexId;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Indicator if we use a register for input variable.
|
|
/// Invariant: _useRegister == true <=> _reg != undefined
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _useRegister;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Indicator if we have used the constant input parameter for computation
|
|
/// We use it to check if we are done with enumerating.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _usedConstant;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Variable for the vertex output
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
Variable const* _vertexVar;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Register for the vertex output
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
RegisterId _vertexReg;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Variable for the edge output
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
Variable const* _edgeVar;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Register for the edge output
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
RegisterId _edgeReg;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Variable for the full path output
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
Variable const* _pathVar;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Register for the full path output
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
RegisterId _pathReg;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief A collection name resolver required to identify vertex collections
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
triagens::arango::CollectionNameResolver* _resolver;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief reference to the conditions that might be executed locally
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::unordered_map<size_t, std::vector<triagens::arango::traverser::TraverserExpression*>> const* _expressions;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not one of the bounds expressions requires V8
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _hasV8Expression;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief _inVars, a vector containing for each expression above
|
|
/// a vector of Variable*, used to execute the expression
|
|
/////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<std::vector<Variable const*>> _inVars;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief _inRegs, a vector containing for each expression above
|
|
/// a vector of RegisterId, used to execute the expression
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<std::vector<RegisterId>> _inRegs;
|
|
|
|
triagens::basics::Json _AccessP;
|
|
triagens::basics::Json _currentJsonPath;/// TODO: wech!
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief continue fetching of paths
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool morePaths (size_t hint);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief skip the next paths
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t skipPaths (size_t hint);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Initialize the path enumerator
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void initializePaths (AqlItemBlock const*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Checks if we output the vertex
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool usesVertexOutput () {
|
|
return _vertexVar != nullptr;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Checks if we output the edge
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool usesEdgeOutput () {
|
|
return _edgeVar != nullptr;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Checks if we output the path
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool usesPathOutput () {
|
|
return _pathVar != nullptr;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Executes the path-local filter expressions
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void executeExpressions ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Executes the path-local filter expressions
|
|
/// Also determines the context
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void executeFilterExpressions ();
|
|
|
|
};
|
|
} // namespace triagens::aql
|
|
} // namespace triagens
|
|
|
|
#endif
|