← Back to branch summary

~thomir-deactivatedaccount/drizzle/drizzle-fix-bug653747

« back to all changes in this revision

Viewing changes to docs/libdrizzle/column.rst

  • Committer: Brian Aker
  • Date: 2010-10-10 02:07:52 UTC
  • mfrom: (1827.2.3 staging)
  • Revision ID: brian@tangent.org-20101010020752-ktv73isay5dxtvp3
Merge in switch on table_share_instance inheritance.

Show diffs side-by-side

added added

removed removed

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