Drizzled Public API Documentation

Column Declarations for Clients

Functions

DRIZZLE_API drizzle_return_t drizzle_column_skip (drizzle_result_st *result)
DRIZZLE_API drizzle_column_stdrizzle_column_read (drizzle_result_st *result, drizzle_column_st *column, drizzle_return_t *ret_ptr)
DRIZZLE_API drizzle_return_t drizzle_column_buffer (drizzle_result_st *result)
DRIZZLE_API drizzle_column_stdrizzle_column_next (drizzle_result_st *result)
DRIZZLE_API drizzle_column_stdrizzle_column_prev (drizzle_result_st *result)
DRIZZLE_API void drizzle_column_seek (drizzle_result_st *result, uint16_t column)
DRIZZLE_API drizzle_column_stdrizzle_column_index (drizzle_result_st *result, uint16_t column)
DRIZZLE_API uint16_t drizzle_column_current (drizzle_result_st *result)

Detailed Description

These functions are used to get detailed column information. This information is usually sent as the first part of a result set. There are both buffered and unbuffered functions provided.


Function Documentation

Buffer all columns in result structure.

Definition at line 548 of file column.c.

References drizzle_column_read(), and drizzle_set_error().

Referenced by drizzle_result_buffer().

Get current column number in a buffered or unbuffered result.

Definition at line 616 of file column.c.

Get the given buffered column from a result structure.

Definition at line 607 of file column.c.

Get next buffered column from a result structure.

Definition at line 583 of file column.c.

Get previous buffered column from a result structure.

Definition at line 592 of file column.c.

Read column information.

Parameters:
[in,out]resultpointer to the structure to read from.
[out]columnpointer to the structure to contain the information.
[out]ret_ptrStandard libdrizzle return value.
Returns:
column if there is valid data, NULL if there are no more columns.

Definition at line 532 of file column.c.

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

Referenced by drizzle_column_buffer().

DRIZZLE_API void drizzle_column_seek ( drizzle_result_st result,
uint16_t  column 
)

Seek to the given buffered column in a result structure.

Definition at line 601 of file column.c.

Skip all columns in result.

Definition at line 519 of file column.c.

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