Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

struct CassIterator

An object used to iterate over a group of rows, columns or collection values.

Functions

void

cass_iterator_free

( iterator )

Frees an iterator instance.

Parameters:
Name Type Details
in iterator
CassIteratorType

cass_iterator_type

( iterator )

Gets the type of the specified iterator.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
CassIteratorType

The type of the iterator.
cass_bool_t

cass_iterator_next

( iterator )

Advance the iterator to the next row, column or collection item.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
cass_bool_t

false if no more rows, columns or items, otherwise true
const CassRow *

cass_iterator_get_row

( iterator )

Gets the row at the result iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous row returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassRow *

A row
const CassValue *

cass_iterator_get_column

( iterator )

Gets the column value at the row iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous column returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassValue *

A value
const CassValue *

cass_iterator_get_value

( iterator )

Gets the value at a collection or tuple iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassValue *

A value
const CassValue *

cass_iterator_get_map_key

( iterator )

Gets the key at the map iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassValue *

A value
const CassValue *

cass_iterator_get_map_value

( iterator )

Gets the value at the map iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassValue *

A value
CassError

cass_iterator_get_user_type_field_name

( iterator, name, name_length )

Gets the field name at the user type defined iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous name returned by this method.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in iterator
out name
out name_length
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
const CassValue *

cass_iterator_get_user_type_field_value

( iterator )

Gets the field value at the user type defined iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassValue *

A value
const CassKeyspaceMeta *

cass_iterator_get_keyspace_meta

( iterator )

Gets the keyspace metadata entry at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassKeyspaceMeta *

A keyspace metadata entry
const CassTableMeta *

cass_iterator_get_table_meta

( iterator )

Gets the table metadata entry at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassTableMeta *

A table metadata entry
const CassMaterializedViewMeta *

cass_iterator_get_materialized_view_meta

( iterator )

Gets the materialized view metadata entry at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Requires Cassandra: 3.0+

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassMaterializedViewMeta *

A materialized view metadata entry
const CassDataType *

cass_iterator_get_user_type

( iterator )

Gets the type metadata entry at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassDataType *

A type metadata entry
const CassFunctionMeta *

cass_iterator_get_function_meta

( iterator )

Gets the function metadata entry at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassFunctionMeta *

A function metadata entry
const CassAggregateMeta *

cass_iterator_get_aggregate_meta

( iterator )

Gets the aggregate metadata entry at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassAggregateMeta *

A aggregate metadata entry
const CassColumnMeta *

cass_iterator_get_column_meta

( iterator )

Gets the column metadata entry at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassColumnMeta *

A column metadata entry
const CassIndexMeta *

cass_iterator_get_index_meta

( iterator )

Gets the index metadata entry at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassIndexMeta *

A index metadata entry
CassError

cass_iterator_get_meta_field_name

( iterator, name, name_length )

Gets the metadata field name at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
out name
out name_length
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
const CassValue *

cass_iterator_get_meta_field_value

( iterator )

Gets the metadata field value at the iterator’s current position.

Calling CassIterator::cass_iterator_next will invalidate the previous value returned by this method.

Parameters:
Name Type Details
in iterator
Returns:
Type Details
const CassValue *

A metadata field value