Class for use of Elasticsearch Scroll API with deprecated scan option. More...

#include <scroll.h>

Inheritance diagram for elasticlient::ScrollByScan:

Collaboration diagram for elasticlient::ScrollByScan:

Public Member Functions
	ScrollByScan (ScrollByScan &&)

	ScrollByScan (const std::shared_ptr< Client > &client, std::size_t scrollSize=100, const std::string &scrollTimeout="1m", int primaryShardsCount=0)

	ScrollByScan (const std::vector< std::string > &hostUrlList, std::size_t scrollSize=100, const std::string &scrollTimeout="1m", int primaryShardsCount=0, std::int32_t connectionTimeout=6000)

Public Member Functions inherited from elasticlient::Scroll
	Scroll (const std::shared_ptr< Client > &client, std::size_t scrollSize=100, const std::string &scrollTimeout="1m")

	Scroll (const std::vector< std::string > &hostUrlList, std::size_t scrollSize=100, const std::string &scrollTimeout="1m", std::int32_t connectionTimeout=6000)

	Scroll (Scroll &&)

void	clear ()
	Clear scroll for next usage. Should be called immediately after last next() was called.

void	init (const std::string &indexName, const std::string &docType, const std::string &searchBody)

bool	next (Json::Value &parsedResult)

const std::shared_ptr< Client > &	getClient () const
	Return Client class with current config.

Protected Member Functions
virtual bool	createScroll (Json::Value &parsedResult) override

Additional Inherited Members
Protected Attributes inherited from elasticlient::Scroll
std::unique_ptr< Implementation >	impl
	Hidden implementation and data holder.

Detailed Description

Class for use of Elasticsearch Scroll API with deprecated scan option.

Constructor & Destructor Documentation

◆ ScrollByScan() [1/2]

elasticlient::ScrollByScan::ScrollByScan	(	const std::shared_ptr< Client > &	client,
		std::size_t	scrollSize = `100`,
		const std::string &	scrollTimeout = `"1m"`,
		int	primaryShardsCount = `0`
	)

explicit

See also: Scroll

◆ ScrollByScan() [2/2]

elasticlient::ScrollByScan::ScrollByScan	(	const std::vector< std::string > &	hostUrlList,
		std::size_t	scrollSize = `100`,
		const std::string &	scrollTimeout = `"1m"`,
		int	primaryShardsCount = `0`,
		std::int32_t	connectionTimeout = `6000`
	)

explicit

See also: Scroll

Member Function Documentation

◆ createScroll()

virtual bool elasticlient::ScrollByScan::createScroll ( Json::Value & parsedResult )

overrideprotectedvirtual

Creates new scroll - obtain scrollId and parsedResult Different from parrent Scroll::createScroll(), for scan it must make two Elasticsearch calls one for obtain scrollId and second for obtain first bulk of results.

Reimplemented from elasticlient::Scroll.

The documentation for this class was generated from the following file:

/home/runner/work/elasticlient/elasticlient/include/elasticlient/scroll.h

Public Member Functions