|
1836.3.1
by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can |
1 |
.. highlightlang:: c |
2 |
||
3 |
Column Object
|
|
4 |
-------------
|
|
5 |
||
6 |
.. index:: object: drizzle_column_st |
|
7 |
||
8 |
General Functions
|
|
9 |
^^^^^^^^^^^^^^^^^
|
|
10 |
||
11 |
These functions are used to get detailed column information. This |
|
12 |
information is usually sent as the first part of a result set. There are |
|
13 |
multiple ways for column information to be buffered depending on the |
|
14 |
functions being used. |
|
15 |
||
16 |
||
17 |
.. c:function:: drizzle_column_st * drizzle_column_create (drizzle_result_st *result, drizzle_column_st *column) |
|
18 |
||
19 |
.. c:function:: void drizzle_column_free (drizzle_column_st *column) |
|
20 |
||
21 |
.. c:function:: drizzle_result_st * drizzle_column_drizzle_result (drizzle_column_st *column) |
|
22 |
||
23 |
.. c:function:: const char * drizzle_column_catalog (drizzle_column_st *column) |
|
24 |
||
25 |
.. c:function:: const char * drizzle_column_db (drizzle_column_st *column) |
|
26 |
||
27 |
.. c:function:: const char * drizzle_column_table (drizzle_column_st *column) |
|
28 |
||
29 |
.. c:function:: const char * drizzle_column_orig_table (drizzle_column_st *column) |
|
30 |
||
31 |
.. c:function:: const char * drizzle_column_name (drizzle_column_st *column) |
|
32 |
||
33 |
.. c:function:: const char * drizzle_column_orig_name (drizzle_column_st *column) |
|
34 |
||
35 |
.. c:function:: drizzle_charset_t drizzle_column_charset (drizzle_column_st *column) |
|
36 |
||
37 |
.. c:function:: uint32_t drizzle_column_size (drizzle_column_st *column) |
|
38 |
||
39 |
.. c:function:: size_t drizzle_column_max_size (drizzle_column_st *column) |
|
40 |
||
41 |
.. c:function:: void drizzle_column_set_max_size (drizzle_column_st *column, size_t size) |
|
42 |
||
43 |
.. c:function:: drizzle_column_type_t drizzle_column_type (drizzle_column_st *column) |
|
44 |
||
45 |
.. c:function:: drizzle_column_type_drizzle_t drizzle_column_type_drizzle (drizzle_column_st *column) |
|
46 |
||
47 |
.. c:function:: drizzle_column_flags_t drizzle_column_flags (drizzle_column_st *column) |
|
48 |
||
49 |
.. c:function:: uint8_t drizzle_column_decimals (drizzle_column_st *column) |
|
50 |
||
51 |
.. c:function:: const uint8_t * drizzle_column_default_value (drizzle_column_st *column, size_t *size) |
|
52 |
||
53 |
Client Functions
|
|
54 |
^^^^^^^^^^^^^^^^
|
|
55 |
||
56 |
These functions are used to get detailed column information. This |
|
57 |
information is usually sent as the first part of a result set. There are |
|
58 |
both buffered and unbuffered functions provided. |
|
59 |
||
60 |
||
61 |
.. c:function:: drizzle_return_t drizzle_column_skip (drizzle_result_st *result) |
|
62 |
||
63 |
.. c:function:: drizzle_column_st * drizzle_column_read (drizzle_result_st *result, drizzle_column_st *column, drizzle_return_t *ret_ptr) |
|
64 |
||
65 |
.. c:function:: drizzle_return_t drizzle_column_buffer (drizzle_result_st *result) |
|
66 |
||
67 |
.. c:function:: drizzle_column_st * drizzle_column_next (drizzle_result_st *result) |
|
68 |
||
69 |
.. c:function:: drizzle_column_st * drizzle_column_prev (drizzle_result_st *result) |
|
70 |
||
71 |
.. c:function:: void drizzle_column_seek (drizzle_result_st *result, uint16_t column) |
|
72 |
||
73 |
.. c:function:: drizzle_column_st * drizzle_column_index (drizzle_result_st *result, uint16_t column) |
|
74 |
||
75 |
.. c:function:: uint16_t drizzle_column_current (drizzle_result_st *result) |
|
76 |
||
77 |
Server Functions
|
|
78 |
^^^^^^^^^^^^^^^^
|
|
79 |
||
80 |
These functions allow you to send column information over a connection. |
|
81 |
||
82 |
||
83 |
.. c:function:: drizzle_return_t drizzle_column_write (drizzle_result_st *result, drizzle_column_st *column) |
|
84 |
||
85 |
.. c:function:: void drizzle_column_set_catalog (drizzle_column_st *column, const char *catalog) |
|
86 |
||
87 |
.. c:function:: void drizzle_column_set_db (drizzle_column_st *column, const char *db) |
|
88 |
||
89 |
.. c:function:: void drizzle_column_set_table (drizzle_column_st *column, const char *table) |
|
90 |
||
91 |
.. c:function:: void drizzle_column_set_orig_table (drizzle_column_st *column, const char *orig_table) |
|
92 |
||
93 |
.. c:function:: void drizzle_column_set_name (drizzle_column_st *column, const char *name) |
|
94 |
||
95 |
.. c:function:: void drizzle_column_set_orig_name (drizzle_column_st *column, const char *orig_name) |
|
96 |
||
97 |
.. c:function:: void drizzle_column_set_charset (drizzle_column_st *column, drizzle_charset_t charset) |
|
98 |
||
99 |
.. c:function:: void drizzle_column_set_size (drizzle_column_st *column, uint32_t size) |
|
100 |
||
101 |
.. c:function:: void drizzle_column_set_type (drizzle_column_st *column, drizzle_column_type_t type) |
|
102 |
||
103 |
.. c:function:: void drizzle_column_set_flags (drizzle_column_st *column, drizzle_column_flags_t flags) |
|
104 |
||
105 |
.. c:function:: void drizzle_column_set_decimals (drizzle_column_st *column, uint8_t decimals) |
|
106 |
||
107 |
.. c:function:: void drizzle_column_set_default_value (drizzle_column_st *column, const uint8_t *default_value, size_t size) |
|
108 |
||
109 |