Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

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

( 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
size_t

cass_result_row_count

( result )

Gets the number of rows for the specified result.

Parameters:
Name Type Details
in result
Returns:
Type Details
size_t

The number of rows in the result.
size_t

cass_result_column_count

( result )

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

Parameters:
Name Type Details
in result
Returns:
Type Details
size_t

The number of columns per row in the result.
CassError

cass_result_column_name

( result, index, name, name_length )

Gets the column name at index for the specified result.

Parameters:
Name Type Details
in result
in index
out name

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

CASS_OK if successful, otherwise error occurred
CassValueType

cass_result_column_type

( result, index )

Gets the column type at index for the specified result.

Parameters:
Name Type Details
in result
in index
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

( result, index )

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

Parameters:
Name Type Details
in result
in index
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

( result )

Gets the first row of the result.

Parameters:
Name Type Details
in result
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

( result )

Returns true if there are more pages.

Requires Cassandra: 2.0+

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

cass_true if there are more pages
CassError

cass_result_paging_state_token

( result, paging_state, 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
out paging_state
out paging_state_size
Returns:
Type Details
CassError

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

cass_iterator_from_result

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

A new iterator that must be freed.
See Also: