← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/libdrizzle/row.rst

Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libdrizzle/row.rst
 
1
 
 
2
.. highlightlang:: c
 
3
 
 
4
Row Object
 
5
----------
 
6
 
 
7
.. index:: object: drizzle_row_st
 
8
 
 
9
Client Functions
 
10
^^^^^^^^^^^^^^^^
 
11
 
 
12
These functions allow you to access rows in a result set. If the result is
 
13
unbuffered, you can read and buffer rows one at a time. If the rows are
 
14
buffered in the result, the drizzle_row_next() and related functions can be
 
15
used.
 
16
 
 
17
 
 
18
.. c:function:: uint64_t  drizzle_row_read (drizzle_result_st *result, drizzle_return_t *ret_ptr)
 
19
 
 
20
.. c:function:: drizzle_row_t   drizzle_row_buffer (drizzle_result_st *result, drizzle_return_t *ret_ptr)
 
21
 
 
22
.. c:function:: void  drizzle_row_free (drizzle_result_st *result, drizzle_row_t row)
 
23
 
 
24
.. c:function:: size_t *  drizzle_row_field_sizes (drizzle_result_st *result)
 
25
 
 
26
.. c:function:: drizzle_row_t   drizzle_row_next (drizzle_result_st *result)
 
27
 
 
28
.. c:function:: drizzle_row_t   drizzle_row_prev (drizzle_result_st *result)
 
29
 
 
30
.. c:function:: void  drizzle_row_seek (drizzle_result_st *result, uint64_t row)
 
31
 
 
32
.. c:function:: drizzle_row_t   drizzle_row_index (drizzle_result_st *result, uint64_t row)
 
33
 
 
34
.. c:function:: uint64_t  drizzle_row_current (drizzle_result_st *result)
 
35
 
 
36
Server Functions
 
37
^^^^^^^^^^^^^^^^
 
38
 
 
39
These functions allow you to send row information over a connection.
 
40
 
 
41
.. c:function:: drizzle_return_t  drizzle_row_write (drizzle_result_st *result)