mirror of
https://github.com/pocoproject/poco.git
synced 2025-01-06 00:31:10 +01:00
75 lines
1.7 KiB
C++
75 lines
1.7 KiB
C++
//
|
|
// Cursor.h
|
|
//
|
|
// Library: MongoDB
|
|
// Package: MongoDB
|
|
// Module: Cursor
|
|
//
|
|
// Definition of the Cursor class.
|
|
//
|
|
// Copyright (c) 2012, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// SPDX-License-Identifier: BSL-1.0
|
|
//
|
|
|
|
|
|
#ifndef MongoDB_Cursor_INCLUDED
|
|
#define MongoDB_Cursor_INCLUDED
|
|
|
|
|
|
#include "Poco/MongoDB/MongoDB.h"
|
|
#include "Poco/MongoDB/Connection.h"
|
|
#include "Poco/MongoDB/QueryRequest.h"
|
|
#include "Poco/MongoDB/ResponseMessage.h"
|
|
|
|
|
|
namespace Poco {
|
|
namespace MongoDB {
|
|
|
|
|
|
class MongoDB_API Cursor: public Document
|
|
/// Cursor is an helper class for querying multiple documents.
|
|
{
|
|
public:
|
|
Cursor(const std::string& dbname, const std::string& collectionName, QueryRequest::Flags flags = QueryRequest::QUERY_DEFAULT);
|
|
/// Creates a Cursor for the given database and collection, using the specified flags.
|
|
|
|
Cursor(const std::string& fullCollectionName, QueryRequest::Flags flags = QueryRequest::QUERY_DEFAULT);
|
|
/// Creates a Cursor for the given database and collection ("database.collection"), using the specified flags.
|
|
|
|
virtual ~Cursor();
|
|
/// Destroys the Cursor.
|
|
|
|
ResponseMessage& next(Connection& connection);
|
|
/// Tries to get the next documents. As long as ResponseMessage has a
|
|
/// cursor ID next can be called to retrieve the next bunch of documents.
|
|
///
|
|
/// The cursor must be killed (see kill()) when not all documents are needed.
|
|
|
|
QueryRequest& query();
|
|
/// Returns the associated query.
|
|
|
|
void kill(Connection& connection);
|
|
/// Kills the cursor and reset it so that it can be reused.
|
|
|
|
private:
|
|
QueryRequest _query;
|
|
ResponseMessage _response;
|
|
};
|
|
|
|
|
|
//
|
|
// inlines
|
|
//
|
|
inline QueryRequest& Cursor::query()
|
|
{
|
|
return _query;
|
|
}
|
|
|
|
|
|
} } // namespace Poco::MongoDB
|
|
|
|
|
|
#endif // MongoDB_Cursor_INCLUDED
|