← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/libdrizzle/query.rst

  • Committer: Monty Taylor
  • Date: 2010-10-11 06:27:10 UTC
  • mto: (1843.1.1 build)
  • mto: This revision was merged to the branch mainline in revision 1844.
  • Revision ID: mordred@inaugust.com-20101011062710-hw270dnron7sojwe
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can
quite easily and mechanically go in and transfer the descriptions in -
especially if they decide on a proper way to describe arguments.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libdrizzle/query.rst
 
1
 
 
2
.. highlightlang:: c
 
3
 
 
4
Query Object
 
5
------------
 
6
 
 
7
.. index:: object: drizzle_query_st
 
8
 
 
9
These functions are used to issue queries on a connection. Single queries
 
10
are made using the drizzle_query function, or you can queue multiple queries
 
11
and run them concurrently using the other query functions.
 
12
 
 
13
 
 
14
.. c:function:: drizzle_result_st *   drizzle_query (drizzle_con_st *con, drizzle_result_st *result, const char *query, size_t size, drizzle_return_t *ret_ptr)
 
15
 
 
16
.. c:function:: drizzle_result_st *   drizzle_query_str (drizzle_con_st *con, drizzle_result_st *result, const char *query, drizzle_return_t *ret_ptr)
 
17
 
 
18
.. c:function:: 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)
 
19
 
 
20
.. c:function:: 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, void *context)
 
21
 
 
22
.. c:function:: drizzle_query_st *  drizzle_query_create (drizzle_st *drizzle, drizzle_query_st *query)
 
23
 
 
24
.. c:function:: void  drizzle_query_free (drizzle_query_st *query)
 
25
 
 
26
.. c:function:: void  drizzle_query_free_all (drizzle_st *drizzle)
 
27
 
 
28
.. c:function:: drizzle_con_st *  drizzle_query_con (drizzle_query_st *query)
 
29
 
 
30
.. c:function:: void  drizzle_query_set_con (drizzle_query_st *query, drizzle_con_st *con)
 
31
 
 
32
.. c:function:: drizzle_result_st *   drizzle_query_result (drizzle_query_st *query)
 
33
 
 
34
.. c:function:: void  drizzle_query_set_result (drizzle_query_st *query, drizzle_result_st *result)
 
35
 
 
36
.. c:function:: char *  drizzle_query_string (drizzle_query_st *query, size_t *size)
 
37
 
 
38
.. c:function:: void  drizzle_query_set_string (drizzle_query_st *query, const char *string, size_t size)
 
39
 
 
40
.. c:function:: drizzle_query_options_t   drizzle_query_options (drizzle_query_st *query)
 
41
 
 
42
.. c:function:: void  drizzle_query_set_options (drizzle_query_st *query, drizzle_query_options_t options)
 
43
 
 
44
.. c:function:: void  drizzle_query_add_options (drizzle_query_st *query, drizzle_query_options_t options)
 
45
 
 
46
.. c:function:: void  drizzle_query_remove_options (drizzle_query_st *query, drizzle_query_options_t options)
 
47
 
 
48
.. c:function:: void *  drizzle_query_context (drizzle_query_st *query)
 
49
 
 
50
.. c:function:: void  drizzle_query_set_context (drizzle_query_st *query, void *context)
 
51
 
 
52
.. c:function:: void  drizzle_query_set_context_free_fn (drizzle_query_st *query,
 
53
 
 
54
.. c:function:: drizzle_query_context_free_fn *function)
 
55
 
 
56
.. c:function:: drizzle_query_st *  drizzle_query_run (drizzle_st *drizzle, drizzle_return_t *ret_ptr)
 
57
 
 
58
.. c:function:: drizzle_return_t  drizzle_query_run_all (drizzle_st *drizzle)
 
59
 
 
60
.. c:function:: size_t  drizzle_escape_string (char *to, const char *from, size_t from_size)
 
61
 
 
62
.. c:function:: size_t  drizzle_hex_string (char *to, const char *from, size_t from_size)
 
63
 
 
64
.. c:function:: void  drizzle_mysql_password_hash (char *to, const char *from, size_t from_size)