mirror of https://gitee.com/bigwinds/arangodb
141 lines
4.0 KiB
C++
141 lines
4.0 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2018 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 Jan Christoph Uhde
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGOD_AQL_RETURN_EXECUTOR_H
|
|
#define ARANGOD_AQL_RETURN_EXECUTOR_H
|
|
|
|
#include "Aql/ExecutionState.h"
|
|
#include "Aql/ExecutorInfos.h"
|
|
#include "Aql/InputAqlItemRow.h"
|
|
#include "Aql/OutputAqlItemRow.h"
|
|
#include "Aql/Stats.h"
|
|
|
|
namespace arangodb {
|
|
namespace transaction {
|
|
class Methods;
|
|
}
|
|
|
|
namespace aql {
|
|
|
|
template <bool>
|
|
class SingleRowFetcher;
|
|
class ExecutorInfos;
|
|
class NoStats;
|
|
|
|
class ReturnExecutorInfos : public ExecutorInfos {
|
|
public:
|
|
ReturnExecutorInfos(RegisterId inputRegister, RegisterId nrInputRegisters,
|
|
RegisterId nrOutputRegisters, bool doCount,
|
|
bool returnInheritedResults);
|
|
|
|
ReturnExecutorInfos() = delete;
|
|
ReturnExecutorInfos(ReturnExecutorInfos&&) = default;
|
|
ReturnExecutorInfos(ReturnExecutorInfos const&) = delete;
|
|
~ReturnExecutorInfos() = default;
|
|
|
|
RegisterId getInputRegisterId() const { return _inputRegisterId; }
|
|
|
|
RegisterId getOutputRegisterId() const {
|
|
// Should not be used with returnInheritedResults.
|
|
TRI_ASSERT(!returnInheritedResults());
|
|
return 0;
|
|
}
|
|
|
|
bool doCount() const { return _doCount; }
|
|
|
|
bool returnInheritedResults() const { return _returnInheritedResults; }
|
|
|
|
private:
|
|
/// @brief the variable produced by Return
|
|
RegisterId _inputRegisterId;
|
|
bool _doCount;
|
|
bool _returnInheritedResults;
|
|
};
|
|
|
|
/**
|
|
* @brief Implementation of Return Node
|
|
*/
|
|
template <bool passBlocksThrough>
|
|
class ReturnExecutor {
|
|
public:
|
|
struct Properties {
|
|
static const bool preservesOrder = true;
|
|
static const bool allowsBlockPassthrough = passBlocksThrough;
|
|
/* This could be set to true after some investigation/fixes */
|
|
static const bool inputSizeRestrictsOutputSize = false;
|
|
};
|
|
using Fetcher = SingleRowFetcher<Properties::allowsBlockPassthrough>;
|
|
using Infos = ReturnExecutorInfos;
|
|
using Stats = CountStats;
|
|
|
|
ReturnExecutor(Fetcher& fetcher, ReturnExecutorInfos&);
|
|
~ReturnExecutor();
|
|
|
|
/**
|
|
* @brief produce the next Row of Aql Values.
|
|
*
|
|
* @return ExecutionState,
|
|
* if something was written output.hasValue() == true
|
|
*/
|
|
inline std::pair<ExecutionState, Stats> produceRow(OutputAqlItemRow& output) {
|
|
ExecutionState state;
|
|
ReturnExecutor::Stats stats;
|
|
InputAqlItemRow inputRow = InputAqlItemRow{CreateInvalidInputRowHint{}};
|
|
std::tie(state, inputRow) = _fetcher.fetchRow();
|
|
|
|
if (state == ExecutionState::WAITING) {
|
|
TRI_ASSERT(!inputRow);
|
|
return {state, stats};
|
|
}
|
|
|
|
if (!inputRow) {
|
|
TRI_ASSERT(state == ExecutionState::DONE);
|
|
return {state, stats};
|
|
}
|
|
|
|
TRI_ASSERT(passBlocksThrough == _infos.returnInheritedResults());
|
|
if (_infos.returnInheritedResults()) {
|
|
output.copyRow(inputRow);
|
|
} else {
|
|
AqlValue val = inputRow.stealValue(_infos.getInputRegisterId());
|
|
AqlValueGuard guard(val, true);
|
|
TRI_IF_FAILURE("ReturnBlock::getSome") {
|
|
THROW_ARANGO_EXCEPTION(TRI_ERROR_DEBUG);
|
|
}
|
|
output.moveValueInto(_infos.getOutputRegisterId(), inputRow, guard);
|
|
}
|
|
|
|
if (_infos.doCount()) {
|
|
stats.incrCounted();
|
|
}
|
|
return {state, stats};
|
|
}
|
|
|
|
private:
|
|
ReturnExecutorInfos& _infos;
|
|
Fetcher& _fetcher;
|
|
};
|
|
} // namespace aql
|
|
} // namespace arangodb
|
|
|
|
#endif
|