struct CassResult

The result of a query.

A result object is read-only and is thread-safe to read or iterate over concurrently.

Functions

void

cass_result_free

( const CassResult * result )

Frees a result instance.

This method invalidates all values, rows, and iterators that were derived from this result.

Parameters:
Name Type Details
in result const CassResult *
size_t

cass_result_row_count

( const CassResult * result )

Gets the number of rows for the specified result.

Parameters:
Name Type Details
in result const CassResult *
Returns:
Type Details
size_t

The number of rows in the result.
size_t

cass_result_column_count

( const CassResult * result )

Gets the number of columns per row for the specified result.

Parameters:
Name Type Details
in result const CassResult *
Returns:
Type Details
size_t

The number of columns per row in the result.
CassError

cass_result_column_name

( const CassResult * result, size_t index, const char ** name, size_t * name_length )

Gets the column name at index for the specified result.

Parameters:
Name Type Details
in result const CassResult *
in index size_t
out name const char **

The column name at the specified index.
out name_length size_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassValueType

cass_result_column_type

( const CassResult * result, size_t index )

Gets the column type at index for the specified result.

Parameters:
Name Type Details
in result const CassResult *
in index size_t
Returns:
Type Details
CassValueType

The column type at the specified index. CASS_VALUE_TYPE_UNKNOWN is returned if the index is out of bounds.
const CassDataType *

cass_result_column_data_type

( const CassResult * result, size_t index )

Gets the column data type at index for the specified result.

Parameters:
Name Type Details
in result const CassResult *
in index size_t
Returns:
Type Details
const CassDataType *

The column type at the specified index. NULL is returned if the index is out of bounds.
const CassRow *

cass_result_first_row

( const CassResult * result )

Gets the first row of the result.

Parameters:
Name Type Details
in result const CassResult *
Returns:
Type Details
const CassRow *

The first row of the result. NULL if there are no rows.
cass_bool_t

cass_result_has_more_pages

( const CassResult * result )

Returns true if there are more pages.

Requires Cassandra: 2.0+

Parameters:
Name Type Details
in result const CassResult *
Returns:
Type Details
cass_bool_t

cass_true if there are more pages
CassError

cass_result_paging_state_token

( const CassResult * result, const char ** paging_state, size_t * paging_state_size )

Gets the raw paging state from the result. The paging state is bound to the lifetime of the result object. If paging state needs to live beyond the lifetime of the result object it must be copied.

Warning: The paging state should not be exposed to or come from untrusted environments. The paging state could be spoofed and potentially used to gain access to other data.

Requires Cassandra: 2.0+

Parameters:
Name Type Details
in result const CassResult *
out paging_state const char **
out paging_state_size size_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
See Also:
CassIterator *

cass_iterator_from_result

( const CassResult * result )

Creates a new iterator for the specified result. This can be used to iterate over rows in the result.

Parameters:
Name Type Details
in result const CassResult *
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also: