~drizzle-trunk/drizzle/development : contents of libdrizzle-1.0/column.h at revision 2481

~drizzle-trunk/drizzle/development : (revision 2481)

/*
 * 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.
 *
 */


/**
 * @file
 * @brief Column Declarations
 */

#pragma once

#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
drizzle_column_flags_t 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

1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	1	/*
	2	* Drizzle Client & Protocol Library
	3	*
	4	* Copyright (C) 2008 Eric Day (eday@oddments.org)
	5	* All rights reserved.
	6	*
1971.2.1 by kalebral at gmail update files that did not have license or had incorrect license structure	7	* Redistribution and use in source and binary forms, with or without
	8	* modification, are permitted provided that the following conditions are
	9	* met:
	10	*
	11	* * Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	*
	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
	17	* distribution.
	18	*
	19	* * The names of its contributors may not be used to endorse or
	20	* promote products derived from this software without specific prior
	21	* written permission.
	22	*
	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.
	34	*
1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	35	*/
	36
1971.2.1 by kalebral at gmail update files that did not have license or had incorrect license structure	37
1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	38	/**
	39	* @file
	40	* @brief Column Declarations
	41	*/
	42
2464.1.2 by Brian Aker Fix compiling issues for 1.0, and cleanup header files.	43	#pragma once
1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	44
	45	#ifdef __cplusplus
	46	extern "C" {
	47	#endif
	48
	49	/**
	50	* @addtogroup drizzle_column Column Declarations
	51	* @ingroup drizzle_client_interface
	52	* @ingroup drizzle_server_interface
	53	*
	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.
	57	* @{
	58	*/
	59
	60	/**
	61	* Initialize a column structure.
	62	*/
	63	DRIZZLE_API
	64	drizzle_column_st drizzle_column_create(drizzle_result_st result,
	65	drizzle_column_st *column);
	66
	67	/**
	68	* Free a column structure.
	69	*/
	70	DRIZZLE_API
	71	void drizzle_column_free(drizzle_column_st *column);
	72
	73	/**
	74	* Get the drizzle_result_st struct that the column belongs to.
	75	*/
	76	DRIZZLE_API
	77	drizzle_result_st drizzle_column_drizzle_result(drizzle_column_st column);
	78
	79	/**
	80	* Get catalog name for a column.
	81	*/
	82	DRIZZLE_API
	83	const char drizzle_column_catalog(drizzle_column_st column);
	84
	85	/**
	86	* Get database name for a column.
	87	*/
	88	DRIZZLE_API
	89	const char drizzle_column_db(drizzle_column_st column);
	90
	91	/**
	92	* Get table name for a column.
	93	*/
	94	DRIZZLE_API
	95	const char drizzle_column_table(drizzle_column_st column);
	96
	97	/**
	98	* Get original table name for a column.
	99	*/
	100	DRIZZLE_API
	101	const char drizzle_column_orig_table(drizzle_column_st column);
	102
	103	/**
	104	* Get column name for a column.
	105	*/
	106	DRIZZLE_API
	107	const char drizzle_column_name(drizzle_column_st column);
108
109	/**
110	* Get original column name for a column.
111	*/
112	DRIZZLE_API
113	const char drizzle_column_orig_name(drizzle_column_st column);
114
115	/**
116	* Get charset for a column.
117	*/
118	DRIZZLE_API
119	drizzle_charset_t drizzle_column_charset(drizzle_column_st *column);
120
121	/**
122	* Get size of a column.
123	*/
124	DRIZZLE_API
125	uint32_t drizzle_column_size(drizzle_column_st *column);
126
127	/**
128	* Get max size of a column.
129	*/
130	DRIZZLE_API
131	size_t drizzle_column_max_size(drizzle_column_st *column);
132
133	/**
134	* Set max size of a column.
135	*/
136	DRIZZLE_API
137	void drizzle_column_set_max_size(drizzle_column_st *column, size_t size);
138
139	/**
140	* Get the type of a column.
141	*/
142	DRIZZLE_API
143	drizzle_column_type_t drizzle_column_type(drizzle_column_st *column);
144
145	/**
146	* Get the Drizzle type of a column.
147	*/
148	DRIZZLE_API
149	drizzle_column_type_drizzle_t
150	drizzle_column_type_drizzle(drizzle_column_st *column);
151
152	/**
153	* Get flags for a column.
154	*/
155	DRIZZLE_API
1992.6.7 by Monty Taylor Revert -Wc++-compat change.	156	drizzle_column_flags_t drizzle_column_flags(drizzle_column_st *column);
1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	157
	158	/**
	159	* Get the number of decimals for numeric columns.
	160	*/
	161	DRIZZLE_API
	162	uint8_t drizzle_column_decimals(drizzle_column_st *column);
	163
	164	/**
	165	* Get default value for a column.
	166	*/
	167	DRIZZLE_API
	168	const uint8_t drizzle_column_default_value(drizzle_column_st column,
	169	size_t *size);
	170
	171	/** @} */
	172
	173	#ifdef __cplusplus
	174	}
	175	#endif