A batch of zero or more rows returned by a scan operation. More...

#include <scan_batch.h>

Inheritance diagram for kudu::client::KuduScanBatch:

Public Types
typedef RowPtr	value_type
	A handy typedef for the RowPtr.

Public Member Functions
int	NumRows () const

KuduScanBatch::RowPtr	Row (int idx) const

const_iterator	begin () const

const_iterator	end () const

const KuduSchema *	projection_schema () const

	RowPtr ()

const RowPtr *	operator-> () const

bool	IsNull (const Slice &col_name) const

bool	IsNull (int col_idx) const

Status	IsDeleted (bool *val) const WARN_UNUSED_RESULT KUDU_NO_EXPORT

const void *	cell (int col_idx) const

std::string	ToString () const

KuduScanBatch::RowPtr	operator* () const

KuduScanBatch::RowPtr	operator-> () const

const_iterator &	operator++ ()

const_iterator	operator++ (int)

bool	operator== (const const_iterator &other) const

bool	operator!= (const const_iterator &other) const

Advanced/Unstable API
There are no guarantees on the stability of the format returned by these methods, which might change at any given time. Note The Slices returned by both direct_data() and indirect_data() are only valid for the lifetime of the KuduScanBatch.
Slice	direct_data () const

Slice	indirect_data () const

Getters for integral type columns by column name.
Status	GetBool (const Slice &col_name, bool *val) const WARN_UNUSED_RESULT

Status	GetInt8 (const Slice &col_name, int8_t *val) const WARN_UNUSED_RESULT

Status	GetInt16 (const Slice &col_name, int16_t *val) const WARN_UNUSED_RESULT

Status	GetInt32 (const Slice &col_name, int32_t *val) const WARN_UNUSED_RESULT

Status	GetInt64 (const Slice &col_name, int64_t *val) const WARN_UNUSED_RESULT

Status	GetUnixTimeMicros (const Slice &col_name, int64_t *micros_since_utc_epoch) const WARN_UNUSED_RESULT

Status	GetDate (const Slice &col_name, int32_t *days_since_unix_epoch) const WARN_UNUSED_RESULT

Status	GetFloat (const Slice &col_name, float *val) const WARN_UNUSED_RESULT

Status	GetDouble (const Slice &col_name, double *val) const WARN_UNUSED_RESULT

Getters for integral type columns by column index.
These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.
Status	GetBool (int col_idx, bool *val) const WARN_UNUSED_RESULT

Status	GetInt8 (int col_idx, int8_t *val) const WARN_UNUSED_RESULT

Status	GetInt16 (int col_idx, int16_t *val) const WARN_UNUSED_RESULT

Status	GetInt32 (int col_idx, int32_t *val) const WARN_UNUSED_RESULT

Status	GetInt64 (int col_idx, int64_t *val) const WARN_UNUSED_RESULT

Status	GetUnixTimeMicros (int col_idx, int64_t *micros_since_utc_epoch) const WARN_UNUSED_RESULT

Status	GetDate (int col_idx, int32_t *days_since_unix_epoch) const WARN_UNUSED_RESULT

Status	GetFloat (int col_idx, float *val) const WARN_UNUSED_RESULT

Status	GetDouble (int col_idx, double *val) const WARN_UNUSED_RESULT

Getters for string/binary/varchar column by column name.
Status	GetString (const Slice &col_name, Slice *val) const WARN_UNUSED_RESULT

Status	GetBinary (const Slice &col_name, Slice *val) const WARN_UNUSED_RESULT

Status	GetVarchar (const Slice &col_name, Slice *val) const WARN_UNUSED_RESULT

Getters for string/binary/varchar column by column index.
Status	GetString (int col_idx, Slice *val) const WARN_UNUSED_RESULT

Status	GetBinary (int col_idx, Slice *val) const WARN_UNUSED_RESULT

Status	GetVarchar (int col_idx, Slice *val) const WARN_UNUSED_RESULT

Detailed Description

A batch of zero or more rows returned by a scan operation.

Every call to KuduScanner::NextBatch() returns a batch of zero or more rows. You can iterate over the rows in the batch using:

range-foreach loop (C++11):

for (KuduScanBatch::RowPtr row : batch) {
  ... row.GetInt(1, ...)
  ...
}

regular for loop (C++03):

for (KuduScanBatch::const_iterator it = batch.begin(), it != batch.end();
     ++it) {
  KuduScanBatch::RowPtr row(*it);
  ...
}

or

for (int i = 0, num_rows = batch.NumRows();
     i < num_rows;
     i++) {
  KuduScanBatch::RowPtr row = batch.Row(i);
  ...
}

Note: In the above example, NumRows() is only called once at the beginning of the loop to avoid extra calls to the non-inlined method.

Member Function Documentation

◆ begin()

KuduScanBatch::const_iterator kudu::client::KuduScanBatch::begin ( ) const

inline

Returns: Forward iterator to the start of the rows in the batch.

◆ cell()

const void * kudu::client::KuduScanBatch::cell ( int col_idx ) const

Get the column's row data.

Note: Should be avoided unless absolutely necessary.

Parameters

[in] col_idx The index of the column.

Returns: Raw cell data for the specified index.

◆ direct_data()

Slice kudu::client::KuduScanBatch::direct_data ( ) const

Return a slice that points to the direct row data received from the server. Users of this API must have knowledge of the data format in order to decode the data.

Warning: Unstable API

Returns: a Slice that points to the raw direct row data.

◆ end()

KuduScanBatch::const_iterator kudu::client::KuduScanBatch::end ( ) const

inline

Returns: Forward iterator to the end of the rows in the batch.

◆ GetBinary() [1/2]

Status kudu::client::KuduScanBatch::GetBinary	(	const Slice &	col_name,
		Slice *	val
	)		const

Get the string/binary/varchar value for a column by its name.

Parameters

[in]	col_name	Name of the column.
[out]	val	Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetBinary() [2/2]

Status kudu::client::KuduScanBatch::GetBinary	(	int	col_idx,
		Slice *	val
	)		const

Get the string/binary/varchar value for a column by its index.

These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetBool() [1/2]

Status kudu::client::KuduScanBatch::GetBool	(	const Slice &	col_name,
		bool *	val
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	val	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetBool() [2/2]

Status kudu::client::KuduScanBatch::GetBool	(	int	col_idx,
		bool *	val
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetDate() [1/2]

Status kudu::client::KuduScanBatch::GetDate	(	const Slice &	col_name,
		int32_t *	days_since_unix_epoch
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	days_since_unix_epoch	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetDate() [2/2]

Status kudu::client::KuduScanBatch::GetDate	(	int	col_idx,
		int32_t *	days_since_unix_epoch
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	days_since_unix_epoch	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetDouble() [1/2]

Status kudu::client::KuduScanBatch::GetDouble	(	const Slice &	col_name,
		double *	val
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	val	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetDouble() [2/2]

Status kudu::client::KuduScanBatch::GetDouble	(	int	col_idx,
		double *	val
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetFloat() [1/2]

Status kudu::client::KuduScanBatch::GetFloat	(	const Slice &	col_name,
		float *	val
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	val	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetFloat() [2/2]

Status kudu::client::KuduScanBatch::GetFloat	(	int	col_idx,
		float *	val
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetInt16() [1/2]

Status kudu::client::KuduScanBatch::GetInt16	(	const Slice &	col_name,
		int16_t *	val
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	val	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetInt16() [2/2]

Status kudu::client::KuduScanBatch::GetInt16	(	int	col_idx,
		int16_t *	val
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetInt32() [1/2]

Status kudu::client::KuduScanBatch::GetInt32	(	const Slice &	col_name,
		int32_t *	val
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	val	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetInt32() [2/2]

Status kudu::client::KuduScanBatch::GetInt32	(	int	col_idx,
		int32_t *	val
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetInt64() [1/2]

Status kudu::client::KuduScanBatch::GetInt64	(	const Slice &	col_name,
		int64_t *	val
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	val	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetInt64() [2/2]

Status kudu::client::KuduScanBatch::GetInt64	(	int	col_idx,
		int64_t *	val
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetInt8() [1/2]

Status kudu::client::KuduScanBatch::GetInt8	(	const Slice &	col_name,
		int8_t *	val
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	val	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetInt8() [2/2]

Status kudu::client::KuduScanBatch::GetInt8	(	int	col_idx,
		int8_t *	val
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetString() [1/2]

Status kudu::client::KuduScanBatch::GetString	(	const Slice &	col_name,
		Slice *	val
	)		const

Get the string/binary/varchar value for a column by its name.

Parameters

[in]	col_name	Name of the column.
[out]	val	Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetString() [2/2]

Status kudu::client::KuduScanBatch::GetString	(	int	col_idx,
		Slice *	val
	)		const

Get the string/binary/varchar value for a column by its index.

These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetUnixTimeMicros() [1/2]

Status kudu::client::KuduScanBatch::GetUnixTimeMicros	(	const Slice &	col_name,
		int64_t *	micros_since_utc_epoch
	)		const

Parameters

[in]	col_name	The name of the target column.
[out]	micros_since_utc_epoch	Placeholder for the result value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetUnixTimeMicros() [2/2]

Status kudu::client::KuduScanBatch::GetUnixTimeMicros	(	int	col_idx,
		int64_t *	micros_since_utc_epoch
	)		const

Parameters

[in]	col_idx	The index of the column.
[out]	micros_since_utc_epoch	Pointer to the placeholder to put the resulting value.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetVarchar() [1/2]

Status kudu::client::KuduScanBatch::GetVarchar	(	const Slice &	col_name,
		Slice *	val
	)		const

Get the string/binary/varchar value for a column by its name.

Parameters

[in]	col_name	Name of the column.
[out]	val	Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ GetVarchar() [2/2]

Status kudu::client::KuduScanBatch::GetVarchar	(	int	col_idx,
		Slice *	val
	)		const

Get the string/binary/varchar value for a column by its index.

These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.

Parameters

[in]	col_idx	The index of the column.
[out]	val	Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary.

Returns

Operation result status. Return a bad Status if at least one of the following is true:

The type does not match.
The value is unset.
The value is NULL.

◆ indirect_data()

Slice kudu::client::KuduScanBatch::indirect_data ( ) const

Like the method above, but for indirect data.

Warning: Unstable API

Returns: a Slice that points to the raw indirect row data.

◆ IsDeleted()

Status kudu::client::KuduScanBatch::IsDeleted ( bool * val ) const

Get the value of the IS_DELETED virtual column.

Parameters

[out] val Placeholder for the result value.

Returns: Operation result status. Return a bad Status if there is no IS_DELETED virtual column in the schema.

◆ IsNull() [1/2]

bool kudu::client::KuduScanBatch::IsNull ( const Slice & col_name ) const

Parameters

[in] col_name Name of the column.

Returns: true iff the specified column of the row has NULL value.

◆ IsNull() [2/2]

bool kudu::client::KuduScanBatch::IsNull ( int col_idx ) const

Parameters

[in] col_idx Index of the column.

Returns: true iff the specified column of the row has NULL value.

◆ NumRows()

int kudu::client::KuduScanBatch::NumRows ( ) const

Returns: The number of rows in this batch.

◆ operator!=()

bool kudu::client::KuduScanBatch::operator!= ( const const_iterator & other ) const

inline

An operator to check whether two iterators are 'not equal'.

Parameters

[in] other The iterator to compare with.

Returns: true iff the other iterator points to a different row in the same batch, or to a row belonging to a different batch altogether.

◆ operator*()

KuduScanBatch::RowPtr kudu::client::KuduScanBatch::operator* ( ) const

inline

Returns: The row in the batch the iterator is pointing at.

◆ operator++() [1/2]

const_iterator & kudu::client::KuduScanBatch::operator++ ( )

inline

Prefix increment operator: advances the iterator to the next position.

Returns: The reference to the iterator, pointing to the next position.

◆ operator++() [2/2]

const_iterator kudu::client::KuduScanBatch::operator++ ( int )

inline

Postfix increment operator: advances the iterator to the next position.

Returns: A copy of the iterator pointing to the pre-increment position.

◆ operator->() [1/2]

const RowPtr * kudu::client::KuduScanBatch::operator-> ( ) const

inline

Overloaded operator -> to support pointer trait for access via const_iterator.

Returns: Pointer to the row

◆ operator->() [2/2]

KuduScanBatch::RowPtr kudu::client::KuduScanBatch::operator-> ( ) const

inline

Note: Since iterator does not keep current KuduScanBatch::RowPtr, we cannot return pointer to it. Instead we return KuduScanBatch::RowPtr, which implements pointer operator ->

Returns: The row in the batch the iterator is pointing at.

◆ operator==()

bool kudu::client::KuduScanBatch::operator== ( const const_iterator & other ) const

inline

An operator to check whether two iterators are 'equal'.

Parameters

[in] other The iterator to compare with.

Returns: true iff the other iterator points to the same row of the same batch.

◆ projection_schema()

const KuduSchema * kudu::client::KuduScanBatch::projection_schema ( ) const

Returns: The projection schema for this batch. All KuduScanBatch::RowPtr returned by this batch are guaranteed to have this schema.

◆ Row()

KuduScanBatch::RowPtr kudu::client::KuduScanBatch::Row ( int idx ) const

Get a row at the specified index.

Parameters

[in] idx The index of the row to return.

Returns: A reference to one of the rows in this batch. The returned object is only valid for as long as this KuduScanBatch object is valid.

◆ RowPtr()

kudu::client::KuduScanBatch::RowPtr ( )

inline

Construct an invalid RowPtr. Before use, you must assign a properly-initialized value.

◆ ToString()

std::string kudu::client::KuduScanBatch::ToString ( ) const

Returns: String representation for this row.

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

include/kudu/client/scan_batch.h

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

◆ begin()

◆ cell()

◆ direct_data()

◆ end()

◆ GetBinary() [1/2]

◆ GetBinary() [2/2]

◆ GetBool() [1/2]

◆ GetBool() [2/2]

◆ GetDate() [1/2]

◆ GetDate() [2/2]

◆ GetDouble() [1/2]

◆ GetDouble() [2/2]

◆ GetFloat() [1/2]

◆ GetFloat() [2/2]

◆ GetInt16() [1/2]

◆ GetInt16() [2/2]

◆ GetInt32() [1/2]

◆ GetInt32() [2/2]

◆ GetInt64() [1/2]

◆ GetInt64() [2/2]

◆ GetInt8() [1/2]

◆ GetInt8() [2/2]

◆ GetString() [1/2]

◆ GetString() [2/2]

◆ GetUnixTimeMicros() [1/2]

◆ GetUnixTimeMicros() [2/2]

◆ GetVarchar() [1/2]

◆ GetVarchar() [2/2]

◆ indirect_data()

◆ IsDeleted()

◆ IsNull() [1/2]

◆ IsNull() [2/2]

◆ NumRows()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator==()

◆ projection_schema()

◆ Row()

◆ RowPtr()

◆ ToString()