libdrizzle Public API Documentation

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.

drizzle_row_t drizzle_row_buffer ( drizzle_result_st result,
drizzle_return_t ret_ptr 
)

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

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

void drizzle_row_free ( drizzle_result_st result,
drizzle_row_t  row 
)

Free a row that was buffered with drizzle_row_buffer().

size_t* drizzle_row_field_sizes ( drizzle_result_st result  ) 

Get an array of all field sizes for buffered rows.

drizzle_row_t drizzle_row_next ( drizzle_result_st result  ) 

Get next buffered row from a fully buffered result.

drizzle_row_t drizzle_row_prev ( drizzle_result_st result  ) 

Get previous buffered row from a fully buffered result.

void drizzle_row_seek ( drizzle_result_st result,
uint64_t  row 
)

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

drizzle_row_t drizzle_row_index ( drizzle_result_st result,
uint64_t  row 
)

Get the given buffered row from a fully buffered result.

uint64_t drizzle_row_current ( drizzle_result_st result  ) 

Get current row number.


Generated on Tue May 4 16:37:28 2010 by  doxygen 1.4.7