mirror of https://gitee.com/bigwinds/arangodb
116 lines
3.1 KiB
C++
116 lines
3.1 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014-2018 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
|
|
/// @author Simon Grätzer
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGOD_AQL_QUERY_CURSOR_H
|
|
#define ARANGOD_AQL_QUERY_CURSOR_H 1
|
|
|
|
#include "Aql/QueryResult.h"
|
|
#include "Basics/Common.h"
|
|
#include "Utils/Cursor.h"
|
|
#include "VocBase/vocbase.h"
|
|
|
|
namespace arangodb {
|
|
namespace aql {
|
|
|
|
class Query;
|
|
|
|
/// Cursor managing an entire query result in-memory
|
|
/// Should be used in conjunction with the RestCursorHandler
|
|
class QueryResultCursor final : public arangodb::Cursor {
|
|
public:
|
|
QueryResultCursor(
|
|
TRI_vocbase_t& vocbase,
|
|
CursorId id,
|
|
aql::QueryResult&& result,
|
|
size_t batchSize,
|
|
double ttl,
|
|
bool hasCount
|
|
);
|
|
|
|
~QueryResultCursor() = default;
|
|
|
|
aql::QueryResult const* result() const { return &_result; }
|
|
|
|
CursorType type() const override final { return CURSOR_VPACK; }
|
|
|
|
bool hasNext();
|
|
|
|
arangodb::velocypack::Slice next();
|
|
|
|
size_t count() const override final;
|
|
|
|
Result dump(velocypack::Builder&) override final;
|
|
|
|
std::shared_ptr<transaction::Context> context() const override final {
|
|
return _result.context;
|
|
}
|
|
|
|
/// @brief Returns a slice to read the extra values.
|
|
/// Make sure the Cursor Object is not destroyed while reading this slice.
|
|
/// If no extras are set this will return a NONE slice.
|
|
arangodb::velocypack::Slice extra() const;
|
|
|
|
private:
|
|
DatabaseGuard _guard;
|
|
aql::QueryResult _result;
|
|
arangodb::velocypack::ArrayIterator _iterator;
|
|
bool _cached;
|
|
};
|
|
|
|
/// Cursor managing a query from which it continuously gets
|
|
/// new results. Query, transaction and locks will live until
|
|
/// cursor is deleted (or query exhausted)
|
|
class QueryStreamCursor final : public arangodb::Cursor {
|
|
public:
|
|
QueryStreamCursor(
|
|
TRI_vocbase_t& vocbase,
|
|
CursorId id,
|
|
std::string const& query,
|
|
std::shared_ptr<velocypack::Builder> bindVars,
|
|
std::shared_ptr<velocypack::Builder> opts,
|
|
size_t batchSize,
|
|
double ttl
|
|
);
|
|
|
|
~QueryStreamCursor();
|
|
|
|
CursorType type() const override final { return CURSOR_VPACK; }
|
|
|
|
size_t count() const override final { return 0; }
|
|
|
|
Result dump(velocypack::Builder&) override final;
|
|
|
|
std::shared_ptr<transaction::Context> context() const override final;
|
|
|
|
private:
|
|
DatabaseGuard _guard;
|
|
std::string _queryString;
|
|
std::unique_ptr<aql::Query> _query;
|
|
};
|
|
|
|
} // aql
|
|
} // arangodb
|
|
|
|
#endif
|