Drizzled Public API Documentation

Result Declarations

Classes

struct  drizzle_result_st

Enumerations

enum  drizzle_result_options_t {
  DRIZZLE_RESULT_NONE = 0, DRIZZLE_RESULT_ALLOCATED = (1 << 0), DRIZZLE_RESULT_SKIP_COLUMN = (1 << 1), DRIZZLE_RESULT_BUFFER_COLUMN = (1 << 2),
  DRIZZLE_RESULT_BUFFER_ROW = (1 << 3), DRIZZLE_RESULT_EOF_PACKET = (1 << 4), DRIZZLE_RESULT_ROW_BREAK = (1 << 5)
}

Functions

DRIZZLE_API drizzle_result_stdrizzle_result_create (drizzle_con_st *con, drizzle_result_st *result)
DRIZZLE_API drizzle_result_stdrizzle_result_clone (drizzle_con_st *con, drizzle_result_st *result, drizzle_result_st *from)
DRIZZLE_API void drizzle_result_free (drizzle_result_st *result)
DRIZZLE_API void drizzle_result_free_all (drizzle_con_st *con)
DRIZZLE_API drizzle_con_stdrizzle_result_drizzle_con (drizzle_result_st *result)
DRIZZLE_API bool drizzle_result_eof (drizzle_result_st *result)
DRIZZLE_API const char * drizzle_result_info (drizzle_result_st *result)
DRIZZLE_API const char * drizzle_result_error (drizzle_result_st *result)
DRIZZLE_API uint16_t drizzle_result_error_code (drizzle_result_st *result)
DRIZZLE_API const char * drizzle_result_sqlstate (drizzle_result_st *result)
DRIZZLE_API uint16_t drizzle_result_warning_count (drizzle_result_st *result)
DRIZZLE_API uint64_t drizzle_result_insert_id (drizzle_result_st *result)
DRIZZLE_API uint64_t drizzle_result_affected_rows (drizzle_result_st *result)
DRIZZLE_API uint16_t drizzle_result_column_count (drizzle_result_st *result)
DRIZZLE_API uint64_t drizzle_result_row_count (drizzle_result_st *result)

Detailed Description

These are core result functions used by both clients and servers.


Enumeration Type Documentation

Options for drizzle_result_st.

Definition at line 330 of file constants.h.


Function Documentation

DRIZZLE_API uint64_t drizzle_result_affected_rows ( drizzle_result_st result)

Get the number of affected rows during the command.

Definition at line 182 of file result.c.

DRIZZLE_API drizzle_result_st* drizzle_result_clone ( drizzle_con_st con,
drizzle_result_st result,
drizzle_result_st from 
)

Clone a connection structure.

Definition at line 78 of file result.c.

References drizzle_result_create(), drizzle_result_set_info(), and drizzle_result_set_sqlstate().

DRIZZLE_API uint16_t drizzle_result_column_count ( drizzle_result_st result)

Get the number of columns in a result set.

Definition at line 187 of file result.c.

DRIZZLE_API drizzle_result_st* drizzle_result_create ( drizzle_con_st con,
drizzle_result_st result 
)

Initialize a result structure.

Definition at line 48 of file result.c.

References drizzle_set_error().

Referenced by drizzle_con_command_write(), drizzle_result_clone(), and drizzle_result_read().

DRIZZLE_API drizzle_con_st* drizzle_result_drizzle_con ( drizzle_result_st result)

Get the drizzle_con_st struct that the result belongs to.

Definition at line 142 of file result.c.

DRIZZLE_API bool drizzle_result_eof ( drizzle_result_st result)

Get EOF flag for a result.

Definition at line 147 of file result.c.

DRIZZLE_API const char* drizzle_result_error ( drizzle_result_st result)

Get error string for a result.

Definition at line 157 of file result.c.

DRIZZLE_API uint16_t drizzle_result_error_code ( drizzle_result_st result)

Get server defined error code for a result.

Definition at line 162 of file result.c.

DRIZZLE_API void drizzle_result_free ( drizzle_result_st result)
DRIZZLE_API void drizzle_result_free_all ( drizzle_con_st con)

Free all result structures.

Definition at line 136 of file result.c.

References drizzle_result_free().

Referenced by drizzle_con_free().

DRIZZLE_API const char* drizzle_result_info ( drizzle_result_st result)

Get information string for a result.

Definition at line 152 of file result.c.

DRIZZLE_API uint64_t drizzle_result_insert_id ( drizzle_result_st result)

Get inet ID of the last command, if any.

Definition at line 177 of file result.c.

DRIZZLE_API uint64_t drizzle_result_row_count ( drizzle_result_st result)

Get the number of rows returned for the command.

Definition at line 192 of file result.c.

DRIZZLE_API const char* drizzle_result_sqlstate ( drizzle_result_st result)

Get SQL state code for a result.

Definition at line 167 of file result.c.

DRIZZLE_API uint16_t drizzle_result_warning_count ( drizzle_result_st result)

Get the number of warnings encounted during a command.

Definition at line 172 of file result.c.