Drizzled Public API Documentation

Row Declarations for Clients

Functions

DRIZZLE_API uint64_t drizzle_row_read (drizzle_result_st *result, drizzle_return_t *ret_ptr)
DRIZZLE_API drizzle_row_t drizzle_row_buffer (drizzle_result_st *result, drizzle_return_t *ret_ptr)
DRIZZLE_API void drizzle_row_free (drizzle_result_st *result, drizzle_row_t row)
DRIZZLE_API size_t * drizzle_row_field_sizes (drizzle_result_st *result)
DRIZZLE_API drizzle_row_t drizzle_row_next (drizzle_result_st *result)
DRIZZLE_API drizzle_row_t drizzle_row_prev (drizzle_result_st *result)
DRIZZLE_API void drizzle_row_seek (drizzle_result_st *result, uint64_t row)
DRIZZLE_API drizzle_row_t drizzle_row_index (drizzle_result_st *result, uint64_t row)
DRIZZLE_API 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

DRIZZLE_API 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]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 61 of file row.c.

References drizzle_field_buffer(), drizzle_row_read(), and drizzle_set_error().

Referenced by drizzle_result_buffer().

Get current row number.

Definition at line 162 of file row.c.

Get an array of all field sizes for buffered rows.

Definition at line 123 of file row.c.

DRIZZLE_API 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 113 of file row.c.

References drizzle_field_free().

Referenced by drizzle_result_buffer(), and drizzle_result_free().

DRIZZLE_API 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 154 of file row.c.

DRIZZLE_API drizzle_row_t drizzle_row_next ( drizzle_result_st result)

Get next buffered row from a fully buffered result.

Definition at line 128 of file row.c.

Referenced by slave::QueueProducer::queryForReplicationEvents().

DRIZZLE_API drizzle_row_t drizzle_row_prev ( drizzle_result_st result)

Get previous buffered row from a fully buffered result.

Definition at line 138 of file row.c.

DRIZZLE_API 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.

Parameters:
[in,out]resultpointer to the structure to read from.
[out]ret_ptrStandard libdrizzle return value. May be set to DRIZZLE_RESULT_ERROR_CODE if the server return an error, such as a deadlock.
Returns:
the row id if there is a valid row, or 0 if there are no more rows or an error.

Definition at line 48 of file row.c.

References drizzle_state_loop(), drizzle_state_none(), and drizzle_state_push().

Referenced by drizzle_row_buffer().

DRIZZLE_API 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 148 of file row.c.