1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*
* Drizzle Client & Protocol Library
*
* Copyright (C) 2008 Eric Day (eday@oddments.org)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* * The names of its contributors may not be used to endorse or
* promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#pragma once
/**
* @file
* @brief Column Declarations
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup drizzle_column Column Declarations
* @ingroup drizzle_client_interface
* @ingroup drizzle_server_interface
*
* These functions are used to get detailed column information. This information
* is usually sent as the first part of a result set. There are multiple ways
* for column information to be buffered depending on the functions being used.
* @{
*/
/**
* Initialize a column structure.
*/
DRIZZLE_API
drizzle_column_st *drizzle_column_create(drizzle_result_st *result,
drizzle_column_st *column);
/**
* Free a column structure.
*/
DRIZZLE_API
void drizzle_column_free(drizzle_column_st *column);
/**
* Get the drizzle_result_st struct that the column belongs to.
*/
DRIZZLE_API
drizzle_result_st *drizzle_column_drizzle_result(drizzle_column_st *column);
/**
* Get catalog name for a column.
*/
DRIZZLE_API
const char *drizzle_column_catalog(drizzle_column_st *column);
/**
* Get database name for a column.
*/
DRIZZLE_API
const char *drizzle_column_db(drizzle_column_st *column);
/**
* Get table name for a column.
*/
DRIZZLE_API
const char *drizzle_column_table(drizzle_column_st *column);
/**
* Get original table name for a column.
*/
DRIZZLE_API
const char *drizzle_column_orig_table(drizzle_column_st *column);
/**
* Get column name for a column.
*/
DRIZZLE_API
const char *drizzle_column_name(drizzle_column_st *column);
/**
* Get original column name for a column.
*/
DRIZZLE_API
const char *drizzle_column_orig_name(drizzle_column_st *column);
/**
* Get charset for a column.
*/
DRIZZLE_API
drizzle_charset_t drizzle_column_charset(drizzle_column_st *column);
/**
* Get size of a column.
*/
DRIZZLE_API
uint32_t drizzle_column_size(drizzle_column_st *column);
/**
* Get max size of a column.
*/
DRIZZLE_API
size_t drizzle_column_max_size(drizzle_column_st *column);
/**
* Set max size of a column.
*/
DRIZZLE_API
void drizzle_column_set_max_size(drizzle_column_st *column, size_t size);
/**
* Get the type of a column.
*/
DRIZZLE_API
drizzle_column_type_t drizzle_column_type(drizzle_column_st *column);
/**
* Get the Drizzle type of a column.
*/
DRIZZLE_API
drizzle_column_type_drizzle_t
drizzle_column_type_drizzle(drizzle_column_st *column);
/**
* Get flags for a column.
*/
DRIZZLE_API
int drizzle_column_flags(drizzle_column_st *column);
/**
* Get the number of decimals for numeric columns.
*/
DRIZZLE_API
uint8_t drizzle_column_decimals(drizzle_column_st *column);
/**
* Get default value for a column.
*/
DRIZZLE_API
const uint8_t *drizzle_column_default_value(drizzle_column_st *column,
size_t *size);
/** @} */
#ifdef __cplusplus
}
#endif
|