libdrizzle Developer Documentation

Query Functions
[Drizzle Client Interface]

Data Structures

struct  drizzle_query_st

Enumerations

enum  drizzle_query_options_t { DRIZZLE_QUERY_ALLOCATED = (1 << 0) }
enum  drizzle_query_state_t { DRIZZLE_QUERY_STATE_INIT, DRIZZLE_QUERY_STATE_QUERY, DRIZZLE_QUERY_STATE_RESULT, DRIZZLE_QUERY_STATE_DONE }

Functions

drizzle_result_st * drizzle_query (drizzle_con_st *con, drizzle_result_st *result, const char *query, size_t size, drizzle_return_t *ret_ptr)
drizzle_result_st * drizzle_query_str (drizzle_con_st *con, drizzle_result_st *result, const char *query, drizzle_return_t *ret_ptr)
drizzle_result_st * drizzle_query_inc (drizzle_con_st *con, drizzle_result_st *result, const char *query, size_t size, size_t total, drizzle_return_t *ret_ptr)
drizzle_query_st * drizzle_query_add (drizzle_st *drizzle, drizzle_query_st *query, drizzle_con_st *con, drizzle_result_st *result, const char *query_string, size_t size, drizzle_query_options_t options, const void *data)
drizzle_query_st * drizzle_query_create (drizzle_st *drizzle, drizzle_query_st *query)
void drizzle_query_free (drizzle_query_st *query)
drizzle_con_st * drizzle_query_con (drizzle_query_st *query)
void drizzle_query_set_con (drizzle_query_st *query, drizzle_con_st *con)
drizzle_result_st * drizzle_query_result (drizzle_query_st *query)
void drizzle_query_set_result (drizzle_query_st *query, drizzle_result_st *result)
char * drizzle_query_string (drizzle_query_st *query, size_t *size)
void drizzle_query_set_string (drizzle_query_st *query, const char *string, size_t size)
drizzle_query_options_t drizzle_query_options (drizzle_query_st *query)
void drizzle_query_set_options (drizzle_query_st *query, drizzle_query_options_t options)
void drizzle_query_add_options (drizzle_query_st *query, drizzle_query_options_t options)
void drizzle_query_remove_options (drizzle_query_st *query, drizzle_query_options_t options)
void * drizzle_query_data (drizzle_query_st *query)
void drizzle_query_set_data (drizzle_query_st *query, const void *data)
void drizzle_query_set_data_free (drizzle_query_st *query, drizzle_query_data_free_fn *free_fn)
drizzle_query_st * drizzle_query_run (drizzle_st *drizzle, drizzle_return_t *ret_ptr)
drizzle_return_t drizzle_query_run_all (drizzle_st *drizzle)
uint64_t drizzle_escape_string (char *to, const char *from, uint64_t from_size)
uint64_t drizzle_hex_string (char *to, const char *from, uint64_t from_size)

Detailed Description

These functions are used to issue queries on a connection. Single queries are made using the drizzle_query function, or you can queue multiple queries and run them concurrently using the other query functions.

Enumeration Type Documentation

enum drizzle_query_options_t

Options for drizzle_query_st.

Enumerator:
DRIZZLE_QUERY_ALLOCATED 

Definition at line 289 of file constants.h.

enum drizzle_query_state_t

States for drizle_query_st.

Enumerator:
DRIZZLE_QUERY_STATE_INIT 
DRIZZLE_QUERY_STATE_QUERY 
DRIZZLE_QUERY_STATE_RESULT 
DRIZZLE_QUERY_STATE_DONE 

Definition at line 298 of file constants.h.

Function Documentation

drizzle_result_st* drizzle_query ( drizzle_con_st *  con,
drizzle_result_st *  result,
const char *  query,
size_t  size,
drizzle_return_t *  ret_ptr 
)

Send query to server.

Definition at line 18 of file query.c.

drizzle_result_st* drizzle_query_str ( drizzle_con_st *  con,
drizzle_result_st *  result,
const char *  query,
drizzle_return_t *  ret_ptr 
)

Send query to server, using strlen to get the size of query buffer..

Definition at line 26 of file query.c.

drizzle_result_st* drizzle_query_inc ( drizzle_con_st *  con,
drizzle_result_st *  result,
const char *  query,
size_t  size,
size_t  total,
drizzle_return_t *  ret_ptr 
)

Send query incrementally.

Definition at line 39 of file query.c.

drizzle_query_st* drizzle_query_add ( drizzle_st *  drizzle,
drizzle_query_st *  query,
drizzle_con_st *  con,
drizzle_result_st *  result,
const char *  query_string,
size_t  size,
drizzle_query_options_t  options,
const void *  data 
)

Add a query to be run concurrently.

Definition at line 48 of file query.c.

drizzle_query_st* drizzle_query_create ( drizzle_st *  drizzle,
drizzle_query_st *  query 
)

Initialize a query structure.

Definition at line 69 of file query.c.

void drizzle_query_free ( drizzle_query_st *  query  ) 

Free a query structure.

Definition at line 99 of file query.c.

drizzle_con_st* drizzle_query_con ( drizzle_query_st *  query  ) 

Get connection struct for a query.

Definition at line 116 of file query.c.

void drizzle_query_set_con ( drizzle_query_st *  query,
drizzle_con_st *  con 
)

Set connection struct for a query.

Definition at line 121 of file query.c.

drizzle_result_st* drizzle_query_result ( drizzle_query_st *  query  ) 

Get result struct for a query.

Definition at line 126 of file query.c.

void drizzle_query_set_result ( drizzle_query_st *  query,
drizzle_result_st *  result 
)

Set result struct for a query.

Definition at line 131 of file query.c.

char* drizzle_query_string ( drizzle_query_st *  query,
size_t *  size 
)

Get query string for a query.

Definition at line 137 of file query.c.

void drizzle_query_set_string ( drizzle_query_st *  query,
const char *  string,
size_t  size 
)

Set query string for a query.

Definition at line 143 of file query.c.

drizzle_query_options_t drizzle_query_options ( drizzle_query_st *  query  ) 

Get options for a query.

Definition at line 150 of file query.c.

void drizzle_query_set_options ( drizzle_query_st *  query,
drizzle_query_options_t  options 
)

Set options for a query.

Definition at line 155 of file query.c.

void drizzle_query_add_options ( drizzle_query_st *  query,
drizzle_query_options_t  options 
)

Add options for a query.

Definition at line 161 of file query.c.

void drizzle_query_remove_options ( drizzle_query_st *  query,
drizzle_query_options_t  options 
)

Remove options for a query.

Definition at line 167 of file query.c.

void* drizzle_query_data ( drizzle_query_st *  query  ) 

Get application data for a query.

Definition at line 173 of file query.c.

void drizzle_query_set_data ( drizzle_query_st *  query,
const void *  data 
)

Set application data for a query.

Definition at line 178 of file query.c.

void drizzle_query_set_data_free ( drizzle_query_st *  query,
drizzle_query_data_free_fn *  free_fn 
)

Set callback function when the data pointer should be freed.

Definition at line 183 of file query.c.

drizzle_query_st* drizzle_query_run ( drizzle_st *  drizzle,
drizzle_return_t *  ret_ptr 
)

Run queries concurrently, returning when one is complete.

Definition at line 189 of file query.c.

drizzle_return_t drizzle_query_run_all ( drizzle_st *  drizzle  ) 

Run queries until they are all complete.

Definition at line 302 of file query.c.

uint64_t drizzle_escape_string ( char *  to,
const char *  from,
uint64_t  from_size 
)

Definition at line 316 of file query.c.

uint64_t drizzle_hex_string ( char *  to,
const char *  from,
uint64_t  from_size 
)

Definition at line 351 of file query.c.

Generated on Mon Sep 28 12:54:05 2009 by  doxygen 1.6.1