2
* Drizzle Client & Protocol Library
4
* Copyright (C) 2008 Eric Day (eday@oddments.org)
7
* Redistribution and use in source and binary forms, with or without
8
* modification, are permitted provided that the following conditions are
11
* * Redistributions of source code must retain the above copyright
12
* notice, this list of conditions and the following disclaimer.
14
* * Redistributions in binary form must reproduce the above
15
* copyright notice, this list of conditions and the following disclaimer
16
* in the documentation and/or other materials provided with the
19
* * The names of its contributors may not be used to endorse or
20
* promote products derived from this software without specific prior
23
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40
* @brief Column Declarations
50
* @addtogroup drizzle_column Column Declarations
51
* @ingroup drizzle_client_interface
52
* @ingroup drizzle_server_interface
54
* These functions are used to get detailed column information. This information
55
* is usually sent as the first part of a result set. There are multiple ways
56
* for column information to be buffered depending on the functions being used.
61
* Initialize a column structure.
64
drizzle_column_st *drizzle_column_create(drizzle_result_st *result,
65
drizzle_column_st *column);
68
* Free a column structure.
71
void drizzle_column_free(drizzle_column_st *column);
74
* Get the drizzle_result_st struct that the column belongs to.
77
drizzle_result_st *drizzle_column_drizzle_result(drizzle_column_st *column);
80
* Get catalog name for a column.
83
const char *drizzle_column_catalog(drizzle_column_st *column);
86
* Get database name for a column.
89
const char *drizzle_column_db(drizzle_column_st *column);
92
* Get table name for a column.
95
const char *drizzle_column_table(drizzle_column_st *column);
98
* Get original table name for a column.
101
const char *drizzle_column_orig_table(drizzle_column_st *column);
104
* Get column name for a column.
107
const char *drizzle_column_name(drizzle_column_st *column);
110
* Get original column name for a column.
113
const char *drizzle_column_orig_name(drizzle_column_st *column);
116
* Get charset for a column.
119
drizzle_charset_t drizzle_column_charset(drizzle_column_st *column);
122
* Get size of a column.
125
uint32_t drizzle_column_size(drizzle_column_st *column);
128
* Get max size of a column.
131
size_t drizzle_column_max_size(drizzle_column_st *column);
134
* Set max size of a column.
137
void drizzle_column_set_max_size(drizzle_column_st *column, size_t size);
140
* Get the type of a column.
143
drizzle_column_type_t drizzle_column_type(drizzle_column_st *column);
146
* Get the Drizzle type of a column.
149
drizzle_column_type_drizzle_t
150
drizzle_column_type_drizzle(drizzle_column_st *column);
153
* Get flags for a column.
156
drizzle_column_flags_t drizzle_column_flags(drizzle_column_st *column);
159
* Get the number of decimals for numeric columns.
162
uint8_t drizzle_column_decimals(drizzle_column_st *column);
165
* Get default value for a column.
168
const uint8_t *drizzle_column_default_value(drizzle_column_st *column,
added
removed
libdrizzle/column.h
