← Back to branch summary

~drizzle-trunk/libdrizzle/jenkins-Libdrizzle-29

« back to all changes in this revision

Viewing changes to docs/api/query.rst

  • Committer: Andrew Hutchings
  • Date: 2012-12-22 08:55:58 UTC
  • mfrom: (43.2.18 5.0)
  • Revision ID: andrew@linuxjedi.co.uk-20121222085558-b3aj47q2ah3cfccg
Merge 5.0 into 5.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api/query.rst
9
9
Functions
10
10
---------
11
11
 
12
 
.. c:function:: drizzle_return_t drizzle_set_ssl(drizzle_con_st *con, const char *key, const char *cert, const char *ca, const char *capath, const char *cipher)
 
12
.. c:function:: drizzle_return_t drizzle_set_ssl(drizzle_st *con, const char *key, const char *cert, const char *ca, const char *capath, const char *cipher)
13
13
 
14
14
   Sets the SSL data
15
15
 
21
21
   :param cipher: A list of allowed ciphers for SSL encryption
22
22
   :returns: A return status code, :py:const:`DRIZZLE_RETURN_OK` upon success
23
23
 
24
 
.. c:function:: drizzle_result_st* drizzle_query(drizzle_con_st *con, const char *query, size_t size, drizzle_return_t *ret_ptr)
 
24
.. c:function:: drizzle_result_st* drizzle_query(drizzle_st *con, const char *query, size_t size, drizzle_return_t *ret_ptr)
25
25
 
26
26
   Executes a query and returns a newly allocated result struct
27
27
 
31
31
   :param ret_ptr: A pointer to a :c:type:`drizzle_return_t` to store the return status into
32
32
   :returns: A newly allocated result object
33
33
 
34
 
.. c:function:: drizzle_result_st* drizzle_query_str(drizzle_con_st *con, const char *query, drizzle_return_t *ret_ptr)
 
34
.. c:function:: drizzle_result_st* drizzle_query_str(drizzle_st *con, const char *query, drizzle_return_t *ret_ptr)
35
35
 
36
36
   Executes a query using :c:func:`strlen` to calculate the length of the query
37
37
   string and returns a newly allocated result struct
82
82
 
83
83
   :param result: the result set to free
84
84
 
85
 
.. c:function:: void drizzle_result_free_all(drizzle_con_st *con)
 
85
.. c:function:: void drizzle_result_free_all(drizzle_st *con)
86
86
 
87
87
   Frees all result objects for a given connection object
88
88
 
89
89
   :param con: A connection object
90
90
 
91
 
.. c:function:: drizzle_con_st* drizzle_result_drizzle_con(drizzle_result_st *result)
 
91
.. c:function:: drizzle_st* drizzle_result_drizzle_con(drizzle_result_st *result)
92
92
 
93
93
   Gets the connection object from a given result object
94
94
 
163
163
   :param result: A result object
164
164
   :returns: The row count
165
165
 
166
 
.. c:function:: drizzle_result_st* drizzle_result_read(drizzle_con_st *con, drizzle_return_t *ret_ptr)
 
166
.. c:function:: drizzle_result_st* drizzle_result_read(drizzle_st *con, drizzle_return_t *ret_ptr)
167
167
 
168
168
   Reads the next result in a multi-result return
169
169