~drizzle-trunk/drizzle/development : contents of libdrizzle-2.0/column.h at revision 2485

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

/*
 * 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 schema name for a column.
 */
DRIZZLE_API
const char *drizzle_column_shema(drizzle_column_st *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

2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	1	/*
	2	* Drizzle Client & Protocol Library
	3	*
	4	* Copyright (C) 2008 Eric Day (eday@oddments.org)
	5	* All rights reserved.
	6	*
	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	*
	35	*/
	36
2449.1.4 by Brian Aker Complete update of libdrizzle	37	#pragma once
2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	38
	39	/**
	40	* @file
	41	* @brief Column Declarations
	42	*/
	43
	44	#ifdef __cplusplus
	45	extern "C" {
	46	#endif
	47
	48	/**
	49	* @addtogroup drizzle_column Column Declarations
	50	* @ingroup drizzle_client_interface
	51	* @ingroup drizzle_server_interface
	52	*
	53	* These functions are used to get detailed column information. This information
	54	* is usually sent as the first part of a result set. There are multiple ways
	55	* for column information to be buffered depending on the functions being used.
	56	* @{
	57	*/
	58
	59	/**
	60	* Initialize a column structure.
	61	*/
	62	DRIZZLE_API
	63	drizzle_column_st drizzle_column_create(drizzle_result_st result,
	64	drizzle_column_st *column);
	65
	66	/**
	67	* Free a column structure.
	68	*/
	69	DRIZZLE_API
	70	void drizzle_column_free(drizzle_column_st *column);
	71
	72	/**
	73	* Get the drizzle_result_st struct that the column belongs to.
	74	*/
	75	DRIZZLE_API
	76	drizzle_result_st drizzle_column_drizzle_result(drizzle_column_st column);
	77
	78	/**
	79	* Get catalog name for a column.
	80	*/
	81	DRIZZLE_API
	82	const char drizzle_column_catalog(drizzle_column_st column);
	83
	84	/**
2461.1.1 by Brian Aker Fix safety issues around calling API with no check for NULL	85	* Get schema name for a column.
2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	86	*/
	87	DRIZZLE_API
2461.1.1 by Brian Aker Fix safety issues around calling API with no check for NULL	88	const char drizzle_column_shema(drizzle_column_st column);
	89
	90	DRIZZLE_API
2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	91	const char drizzle_column_db(drizzle_column_st column);
	92
	93	/**
	94	* Get table name for a column.
	95	*/
	96	DRIZZLE_API
	97	const char drizzle_column_table(drizzle_column_st column);
	98
	99	/**
	100	* Get original table name for a column.
	101	*/
	102	DRIZZLE_API
	103	const char drizzle_column_orig_table(drizzle_column_st column);
	104
	105	/**
	106	* Get column name for a column.
	107	*/
	108	DRIZZLE_API
	109	const char drizzle_column_name(drizzle_column_st column);
	110
	111	/**
	112	* Get original column name for a column.
	113	*/
	114	DRIZZLE_API
	115	const char drizzle_column_orig_name(drizzle_column_st column);
	116
	117	/**
	118	* Get charset for a column.
	119	*/
	120	DRIZZLE_API
	121	drizzle_charset_t drizzle_column_charset(drizzle_column_st *column);
	122
	123	/**
	124	* Get size of a column.
	125	*/
	126	DRIZZLE_API
	127	uint32_t drizzle_column_size(drizzle_column_st *column);
	128
	129	/**
	130	* Get max size of a column.
	131	*/
	132	DRIZZLE_API
	133	size_t drizzle_column_max_size(drizzle_column_st *column);
	134
	135	/**
	136	* Set max size of a column.
	137	*/
	138	DRIZZLE_API
	139	void drizzle_column_set_max_size(drizzle_column_st *column, size_t size);
	140
	141	/**
	142	* Get the type of a column.
	143	*/
	144	DRIZZLE_API
	145	drizzle_column_type_t drizzle_column_type(drizzle_column_st *column);
	146
	147	/**
	148	* Get the Drizzle type of a column.
	149	*/
	150	DRIZZLE_API
2461.1.2 by Brian Aker Pass through refactoring.	151	drizzle_column_type_drizzle_t drizzle_column_type_drizzle(drizzle_column_st *column);
2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	152
	153	/**
	154	* Get flags for a column.
	155	*/
	156	DRIZZLE_API
	157	int drizzle_column_flags(drizzle_column_st *column);
	158
	159	/**
	160	* Get the number of decimals for numeric columns.
	161	*/
	162	DRIZZLE_API
	163	uint8_t drizzle_column_decimals(drizzle_column_st *column);
	164
	165	/**
	166	* Get default value for a column.
	167	*/
	168	DRIZZLE_API
	169	const uint8_t drizzle_column_default_value(drizzle_column_st column,
	170	size_t *size);
	171
	172	/** @} */
	173
	174	#ifdef __cplusplus
	175	}
	176	#endif