libdrizzle Developer Documentation

Result Declarations
[Drizzle Client InterfaceDrizzle Server Interface]

Data Structures

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_result_stdrizzle_result_create (drizzle_con_st *con, drizzle_result_st *result)
drizzle_result_stdrizzle_result_clone (drizzle_con_st *con, drizzle_result_st *result, drizzle_result_st *from)
void drizzle_result_free (drizzle_result_st *result)
void drizzle_result_free_all (drizzle_con_st *con)
drizzle_con_stdrizzle_result_drizzle_con (drizzle_result_st *result)
bool drizzle_result_eof (drizzle_result_st *result)
const char * drizzle_result_info (drizzle_result_st *result)
const char * drizzle_result_error (drizzle_result_st *result)
uint16_t drizzle_result_error_code (drizzle_result_st *result)
const char * drizzle_result_sqlstate (drizzle_result_st *result)
uint16_t drizzle_result_warning_count (drizzle_result_st *result)
uint64_t drizzle_result_insert_id (drizzle_result_st *result)
uint64_t drizzle_result_affected_rows (drizzle_result_st *result)
uint16_t drizzle_result_column_count (drizzle_result_st *result)
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.

Enumerator:
DRIZZLE_RESULT_NONE 
DRIZZLE_RESULT_ALLOCATED 
DRIZZLE_RESULT_SKIP_COLUMN 
DRIZZLE_RESULT_BUFFER_COLUMN 
DRIZZLE_RESULT_BUFFER_ROW 
DRIZZLE_RESULT_EOF_PACKET 
DRIZZLE_RESULT_ROW_BREAK 

Definition at line 289 of file constants.h.


Function Documentation

drizzle_result_st* drizzle_result_create ( drizzle_con_st con,
drizzle_result_st result 
)

Initialize a result structure.

Definition at line 22 of file result.c.

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 52 of file result.c.

void drizzle_result_free ( drizzle_result_st result  ) 

Free a result structure.

Definition at line 75 of file result.c.

void drizzle_result_free_all ( drizzle_con_st con  ) 

Free all result structures.

Definition at line 107 of file result.c.

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

bool drizzle_result_eof ( drizzle_result_st result  ) 

Get EOF flag for a result.

Definition at line 118 of file result.c.

const char* drizzle_result_info ( drizzle_result_st result  ) 

Get information string for a result.

Definition at line 123 of file result.c.

const char* drizzle_result_error ( drizzle_result_st result  ) 

Get error string for a result.

Definition at line 128 of file result.c.

uint16_t drizzle_result_error_code ( drizzle_result_st result  ) 

Get server defined error code for a result.

Definition at line 133 of file result.c.

const char* drizzle_result_sqlstate ( drizzle_result_st result  ) 

Get SQL state code for a result.

Definition at line 138 of file result.c.

uint16_t drizzle_result_warning_count ( drizzle_result_st result  ) 

Get the number of warnings encounted during a command.

Definition at line 143 of file result.c.

uint64_t drizzle_result_insert_id ( drizzle_result_st result  ) 

Get inet ID of the last command, if any.

Definition at line 148 of file result.c.

uint64_t drizzle_result_affected_rows ( drizzle_result_st result  ) 

Get the number of affected rows during the command.

Definition at line 153 of file result.c.

uint16_t drizzle_result_column_count ( drizzle_result_st result  ) 

Get the number of columns in a result set.

Definition at line 158 of file result.c.

uint64_t drizzle_result_row_count ( drizzle_result_st result  ) 

Get the number of rows returned for the command.

Definition at line 163 of file result.c.


Generated by  doxygen 1.6.2