struct CassIterator

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

Functions

void

cass_iterator_free

( CassIterator * iterator )

Frees an iterator instance.

Parameters:
Name Type Details
in iterator CassIterator *
CassIteratorType

cass_iterator_type

( CassIterator * iterator )

Gets the type of the specified iterator.

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

The type of the iterator.
cass_bool_t

cass_iterator_next

( CassIterator * iterator )

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

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

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

cass_iterator_get_row

( CassIterator * 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 CassIterator *
Returns:
Type Details
const CassRow *

A row
const CassValue *

cass_iterator_get_column

( CassIterator * 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 CassIterator *
Returns:
Type Details
const CassValue *

A value
const CassValue *

cass_iterator_get_value

( CassIterator * 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 CassIterator *
Returns:
Type Details
const CassValue *

A value
const CassValue *

cass_iterator_get_map_key

( CassIterator * 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 CassIterator *
Returns:
Type Details
const CassValue *

A value
const CassValue *

cass_iterator_get_map_value

( CassIterator * 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 CassIterator *
Returns:
Type Details
const CassValue *

A value
CassError

cass_iterator_get_user_type_field_name

( CassIterator * iterator, const char ** name, size_t * 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.

Parameters:
Name Type Details
in iterator CassIterator *
out name const char **
out name_length size_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
const CassValue *

cass_iterator_get_user_type_field_value

( CassIterator * 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.

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

A value
const CassSchemaMeta *

cass_iterator_get_schema_meta

( CassIterator * iterator )

Gets the schema 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 CassIterator *
Returns:
Type Details
const CassSchemaMeta *

A keyspace/table/column schema metadata entry
const CassSchemaMetaField *

cass_iterator_get_schema_meta_field

( CassIterator * iterator )

Gets the schema metadata field 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 CassIterator *
Returns:
Type Details
const CassSchemaMetaField *

A schema metadata field