libdrizzle Developer Documentation

Functions
Row Declarations for Clients
Drizzle Client Interface

Functions

uint64_t drizzle_row_read (drizzle_result_st *result, drizzle_return_t *ret_ptr)
drizzle_row_t drizzle_row_buffer (drizzle_result_st *result, drizzle_return_t *ret_ptr)
void drizzle_row_free (drizzle_result_st *result, drizzle_row_t row)
size_t * drizzle_row_field_sizes (drizzle_result_st *result)
drizzle_row_t drizzle_row_next (drizzle_result_st *result)
drizzle_row_t drizzle_row_prev (drizzle_result_st *result)
void drizzle_row_seek (drizzle_result_st *result, uint64_t row)
drizzle_row_t drizzle_row_index (drizzle_result_st *result, uint64_t row)
uint64_t drizzle_row_current (drizzle_result_st *result)

Detailed Description

These functions allow you to access rows in a result set. If the result is unbuffered, you can read and buffer rows one at a time. If the rows are buffered in the result, the drizzle_row_next() and related functions can be used.


Function Documentation

uint64_t drizzle_row_read ( drizzle_result_st result,
drizzle_return_t ret_ptr 
)

Get next row number for unbuffered results. Use the drizzle_field* functions to read individual fields after this function succeeds.

Definition at line 22 of file row.c.

Read and buffer one row. The returned row must be freed by the caller with drizzle_row_free().

Parameters:
[in,out]resultpointer to the result structure to read from.
[out]ret_pointerStandard drizzle return value.
Returns:
the row that was read, or NULL if there are no more rows.

Definition at line 35 of file row.c.

void drizzle_row_free ( drizzle_result_st result,
drizzle_row_t  row 
)

Free a row that was buffered with drizzle_row_buffer().

Definition at line 88 of file row.c.

Get an array of all field sizes for buffered rows.

Definition at line 98 of file row.c.

Get next buffered row from a fully buffered result.

Definition at line 103 of file row.c.

Get previous buffered row from a fully buffered result.

Definition at line 113 of file row.c.

void drizzle_row_seek ( drizzle_result_st result,
uint64_t  row 
)

Seek to the given buffered row in a fully buffered result.

Definition at line 123 of file row.c.

drizzle_row_t drizzle_row_index ( drizzle_result_st result,
uint64_t  row 
)

Get the given buffered row from a fully buffered result.

Definition at line 129 of file row.c.

uint64_t drizzle_row_current ( drizzle_result_st result)

Get current row number.

Definition at line 137 of file row.c.