libdrizzle Public API Documentation

libdrizzle/query.h

Go to the documentation of this file.

/*
 * Drizzle Client & Protocol Library
 *
 * Copyright (C) 2008 Eric Day (eday@oddments.org)
 * All rights reserved.
 *
 * Use and distribution licensed under the BSD license.  See
 * the COPYING file in this directory for full text.
 */

#ifndef __DRIZZLE_QUERY_H
#define __DRIZZLE_QUERY_H

#ifdef __cplusplus
extern "C" {
#endif

DRIZZLE_API
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_API
drizzle_result_st *drizzle_query_str(drizzle_con_st *con,
                                     drizzle_result_st *result,
                                     const char *query,
                                     drizzle_return_t *ret_ptr);

DRIZZLE_API
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_API
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_API
drizzle_query_st *drizzle_query_create(drizzle_st *drizzle,
                                       drizzle_query_st *query);

DRIZZLE_API
void drizzle_query_free(drizzle_query_st *query);

DRIZZLE_API
drizzle_con_st *drizzle_query_con(drizzle_query_st *query);

DRIZZLE_API
void drizzle_query_set_con(drizzle_query_st *query, drizzle_con_st *con);

DRIZZLE_API
drizzle_result_st *drizzle_query_result(drizzle_query_st *query);

DRIZZLE_API
void drizzle_query_set_result(drizzle_query_st *query,
                              drizzle_result_st *result);

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

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

DRIZZLE_API
drizzle_query_options_t drizzle_query_options(drizzle_query_st *query);

DRIZZLE_API
void drizzle_query_set_options(drizzle_query_st *query,
                               drizzle_query_options_t options);

DRIZZLE_API
void drizzle_query_add_options(drizzle_query_st *query,
                               drizzle_query_options_t options);

DRIZZLE_API
void drizzle_query_remove_options(drizzle_query_st *query,
                                  drizzle_query_options_t options);

DRIZZLE_API
void *drizzle_query_data(drizzle_query_st *query);

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

DRIZZLE_API
void drizzle_query_set_data_free(drizzle_query_st *query,
                                 drizzle_query_data_free_fn *free_fn);

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

DRIZZLE_API
drizzle_return_t drizzle_query_run_all(drizzle_st *drizzle);

/*
 * Escape a string or encode a string in hexadecimal. The return value is the
 * size of the output string in to.
 */
DRIZZLE_API
uint64_t drizzle_escape_string(char *to, const char *from, uint64_t from_size);
DRIZZLE_API
uint64_t drizzle_hex_string(char *to, const char *from, uint64_t from_size);

#ifdef __cplusplus
}
#endif

#endif /* __DRIZZLE_QUERY_H */

---