Column Declarations

Data Structures
struct	drizzle_column_st
Enumerations
enum	drizzle_column_options_t { DRIZZLE_COLUMN_ALLOCATED = (1 << 0) }
enum	drizzle_column_type_t {   DRIZZLE_COLUMN_TYPE_DECIMAL, DRIZZLE_COLUMN_TYPE_TINY, DRIZZLE_COLUMN_TYPE_SHORT, DRIZZLE_COLUMN_TYPE_LONG,   DRIZZLE_COLUMN_TYPE_FLOAT, DRIZZLE_COLUMN_TYPE_DOUBLE, DRIZZLE_COLUMN_TYPE_NULL, DRIZZLE_COLUMN_TYPE_TIMESTAMP,   DRIZZLE_COLUMN_TYPE_LONGLONG, DRIZZLE_COLUMN_TYPE_INT24, DRIZZLE_COLUMN_TYPE_DATE, DRIZZLE_COLUMN_TYPE_TIME,   DRIZZLE_COLUMN_TYPE_DATETIME, DRIZZLE_COLUMN_TYPE_YEAR, DRIZZLE_COLUMN_TYPE_NEWDATE, DRIZZLE_COLUMN_TYPE_VARCHAR,   DRIZZLE_COLUMN_TYPE_BIT, DRIZZLE_COLUMN_TYPE_NEWDECIMAL = 246, DRIZZLE_COLUMN_TYPE_ENUM = 247, DRIZZLE_COLUMN_TYPE_SET = 248,   DRIZZLE_COLUMN_TYPE_TINY_BLOB = 249, DRIZZLE_COLUMN_TYPE_MEDIUM_BLOB = 250, DRIZZLE_COLUMN_TYPE_LONG_BLOB = 251, DRIZZLE_COLUMN_TYPE_BLOB = 252,   DRIZZLE_COLUMN_TYPE_VAR_STRING = 253, DRIZZLE_COLUMN_TYPE_STRING = 254, DRIZZLE_COLUMN_TYPE_GEOMETRY = 255 }
enum	drizzle_column_type_drizzle_t {   DRIZZLE_COLUMN_TYPE_DRIZZLE_TINY, DRIZZLE_COLUMN_TYPE_DRIZZLE_LONG, DRIZZLE_COLUMN_TYPE_DRIZZLE_DOUBLE, DRIZZLE_COLUMN_TYPE_DRIZZLE_NULL,   DRIZZLE_COLUMN_TYPE_DRIZZLE_TIMESTAMP, DRIZZLE_COLUMN_TYPE_DRIZZLE_LONGLONG, DRIZZLE_COLUMN_TYPE_DRIZZLE_DATETIME, DRIZZLE_COLUMN_TYPE_DRIZZLE_DATE,   DRIZZLE_COLUMN_TYPE_DRIZZLE_VARCHAR, DRIZZLE_COLUMN_TYPE_DRIZZLE_NEWDECIMAL, DRIZZLE_COLUMN_TYPE_DRIZZLE_ENUM, DRIZZLE_COLUMN_TYPE_DRIZZLE_BLOB,   DRIZZLE_COLUMN_TYPE_DRIZZLE_MAX = DRIZZLE_COLUMN_TYPE_DRIZZLE_BLOB }
enum	drizzle_column_flags_t {   DRIZZLE_COLUMN_FLAGS_NONE = 0, DRIZZLE_COLUMN_FLAGS_NOT_NULL = (1 << 0), DRIZZLE_COLUMN_FLAGS_PRI_KEY = (1 << 1), DRIZZLE_COLUMN_FLAGS_UNIQUE_KEY = (1 << 2),   DRIZZLE_COLUMN_FLAGS_MULTIPLE_KEY = (1 << 3), DRIZZLE_COLUMN_FLAGS_BLOB = (1 << 4), DRIZZLE_COLUMN_FLAGS_UNSIGNED = (1 << 5), DRIZZLE_COLUMN_FLAGS_ZEROFILL = (1 << 6),   DRIZZLE_COLUMN_FLAGS_BINARY = (1 << 7), DRIZZLE_COLUMN_FLAGS_ENUM = (1 << 8), DRIZZLE_COLUMN_FLAGS_AUTO_INCREMENT = (1 << 9), DRIZZLE_COLUMN_FLAGS_TIMESTAMP = (1 << 10),   DRIZZLE_COLUMN_FLAGS_SET = (1 << 11), DRIZZLE_COLUMN_FLAGS_NO_DEFAULT_VALUE = (1 << 12), DRIZZLE_COLUMN_FLAGS_ON_UPDATE_NOW = (1 << 13), DRIZZLE_COLUMN_FLAGS_PART_KEY = (1 << 14),   DRIZZLE_COLUMN_FLAGS_NUM = (1 << 15), DRIZZLE_COLUMN_FLAGS_GROUP = (1 << 15), DRIZZLE_COLUMN_FLAGS_UNIQUE = (1 << 16), DRIZZLE_COLUMN_FLAGS_BINCMP = (1 << 17),   DRIZZLE_COLUMN_FLAGS_GET_FIXED_FIELDS = (1 << 18), DRIZZLE_COLUMN_FLAGS_IN_PART_FUNC = (1 << 19), DRIZZLE_COLUMN_FLAGS_IN_ADD_INDEX = (1 << 20), DRIZZLE_COLUMN_FLAGS_RENAMED = (1 << 21) }
Functions
drizzle_column_st *	drizzle_column_create (drizzle_result_st *result, drizzle_column_st *column)
void	drizzle_column_free (drizzle_column_st *column)
drizzle_result_st *	drizzle_column_drizzle_result (drizzle_column_st *column)
const char *	drizzle_column_catalog (drizzle_column_st *column)
const char *	drizzle_column_db (drizzle_column_st *column)
const char *	drizzle_column_table (drizzle_column_st *column)
const char *	drizzle_column_orig_table (drizzle_column_st *column)
const char *	drizzle_column_name (drizzle_column_st *column)
const char *	drizzle_column_orig_name (drizzle_column_st *column)
drizzle_charset_t	drizzle_column_charset (drizzle_column_st *column)
uint32_t	drizzle_column_size (drizzle_column_st *column)
size_t	drizzle_column_max_size (drizzle_column_st *column)
void	drizzle_column_set_max_size (drizzle_column_st *column, size_t size)
drizzle_column_type_t	drizzle_column_type (drizzle_column_st *column)
drizzle_column_type_drizzle_t	drizzle_column_type_drizzle (drizzle_column_st *column)
drizzle_column_flags_t	drizzle_column_flags (drizzle_column_st *column)
uint8_t	drizzle_column_decimals (drizzle_column_st *column)
const uint8_t *	drizzle_column_default_value (drizzle_column_st *column, size_t *size)

---

Detailed Description

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.

---

Enumeration Type Documentation

enum drizzle_column_options_t

Options for drizzle_column_st.

Enumerator:

DRIZZLE_COLUMN_ALLOCATED

Definition at line 304 of file constants.h.

enum drizzle_column_type_t

Types for drizzle_column_st.

Enumerator:

DRIZZLE_COLUMN_TYPE_DECIMAL
DRIZZLE_COLUMN_TYPE_TINY
DRIZZLE_COLUMN_TYPE_SHORT
DRIZZLE_COLUMN_TYPE_LONG
DRIZZLE_COLUMN_TYPE_FLOAT
DRIZZLE_COLUMN_TYPE_DOUBLE
DRIZZLE_COLUMN_TYPE_NULL
DRIZZLE_COLUMN_TYPE_TIMESTAMP
DRIZZLE_COLUMN_TYPE_LONGLONG
DRIZZLE_COLUMN_TYPE_INT24
DRIZZLE_COLUMN_TYPE_DATE
DRIZZLE_COLUMN_TYPE_TIME
DRIZZLE_COLUMN_TYPE_DATETIME
DRIZZLE_COLUMN_TYPE_YEAR
DRIZZLE_COLUMN_TYPE_NEWDATE
DRIZZLE_COLUMN_TYPE_VARCHAR
DRIZZLE_COLUMN_TYPE_BIT
DRIZZLE_COLUMN_TYPE_NEWDECIMAL
DRIZZLE_COLUMN_TYPE_ENUM
DRIZZLE_COLUMN_TYPE_SET
DRIZZLE_COLUMN_TYPE_TINY_BLOB
DRIZZLE_COLUMN_TYPE_MEDIUM_BLOB
DRIZZLE_COLUMN_TYPE_LONG_BLOB
DRIZZLE_COLUMN_TYPE_BLOB
DRIZZLE_COLUMN_TYPE_VAR_STRING
DRIZZLE_COLUMN_TYPE_STRING
DRIZZLE_COLUMN_TYPE_GEOMETRY

Definition at line 313 of file constants.h.

enum drizzle_column_type_drizzle_t

Types for drizzle_column_st for Drizzle.

Enumerator:

DRIZZLE_COLUMN_TYPE_DRIZZLE_TINY
DRIZZLE_COLUMN_TYPE_DRIZZLE_LONG
DRIZZLE_COLUMN_TYPE_DRIZZLE_DOUBLE
DRIZZLE_COLUMN_TYPE_DRIZZLE_NULL
DRIZZLE_COLUMN_TYPE_DRIZZLE_TIMESTAMP
DRIZZLE_COLUMN_TYPE_DRIZZLE_LONGLONG
DRIZZLE_COLUMN_TYPE_DRIZZLE_DATETIME
DRIZZLE_COLUMN_TYPE_DRIZZLE_DATE
DRIZZLE_COLUMN_TYPE_DRIZZLE_VARCHAR
DRIZZLE_COLUMN_TYPE_DRIZZLE_NEWDECIMAL
DRIZZLE_COLUMN_TYPE_DRIZZLE_ENUM
DRIZZLE_COLUMN_TYPE_DRIZZLE_BLOB
DRIZZLE_COLUMN_TYPE_DRIZZLE_MAX

Definition at line 348 of file constants.h.

enum drizzle_column_flags_t

Flags for drizzle_column_st.

Enumerator:

DRIZZLE_COLUMN_FLAGS_NONE
DRIZZLE_COLUMN_FLAGS_NOT_NULL
DRIZZLE_COLUMN_FLAGS_PRI_KEY
DRIZZLE_COLUMN_FLAGS_UNIQUE_KEY
DRIZZLE_COLUMN_FLAGS_MULTIPLE_KEY
DRIZZLE_COLUMN_FLAGS_BLOB
DRIZZLE_COLUMN_FLAGS_UNSIGNED
DRIZZLE_COLUMN_FLAGS_ZEROFILL
DRIZZLE_COLUMN_FLAGS_BINARY
DRIZZLE_COLUMN_FLAGS_ENUM
DRIZZLE_COLUMN_FLAGS_AUTO_INCREMENT
DRIZZLE_COLUMN_FLAGS_TIMESTAMP
DRIZZLE_COLUMN_FLAGS_SET
DRIZZLE_COLUMN_FLAGS_NO_DEFAULT_VALUE
DRIZZLE_COLUMN_FLAGS_ON_UPDATE_NOW
DRIZZLE_COLUMN_FLAGS_PART_KEY
DRIZZLE_COLUMN_FLAGS_NUM
DRIZZLE_COLUMN_FLAGS_GROUP
DRIZZLE_COLUMN_FLAGS_UNIQUE
DRIZZLE_COLUMN_FLAGS_BINCMP
DRIZZLE_COLUMN_FLAGS_GET_FIXED_FIELDS
DRIZZLE_COLUMN_FLAGS_IN_PART_FUNC
DRIZZLE_COLUMN_FLAGS_IN_ADD_INDEX
DRIZZLE_COLUMN_FLAGS_RENAMED

Definition at line 369 of file constants.h.

---

Function Documentation

drizzle_column_st* drizzle_column_create	(	drizzle_result_st *	result,
		drizzle_column_st *	column
	)

Initialize a column structure.

Definition at line 327 of file column.c.

void drizzle_column_free

(

drizzle_column_st *

column

)

Free a column structure.

Definition at line 356 of file column.c.

drizzle_result_st* drizzle_column_drizzle_result

(

drizzle_column_st *

column

)

Get the drizzle_result_st struct that the column belongs to.

Definition at line 369 of file column.c.

const char* drizzle_column_catalog

(

drizzle_column_st *

column

)

Get catalog name for a column.

Definition at line 374 of file column.c.

const char* drizzle_column_db

(

drizzle_column_st *

column

)

Get database name for a column.

Definition at line 379 of file column.c.

const char* drizzle_column_table

(

drizzle_column_st *

column

)

Get table name for a column.

Definition at line 384 of file column.c.

const char* drizzle_column_orig_table

(

drizzle_column_st *

column

)

Get original table name for a column.

Definition at line 389 of file column.c.

const char* drizzle_column_name

(

drizzle_column_st *

column

)

Get column name for a column.

Definition at line 394 of file column.c.

const char* drizzle_column_orig_name

(

drizzle_column_st *

column

)

Get original column name for a column.

Definition at line 399 of file column.c.

drizzle_charset_t drizzle_column_charset

(

drizzle_column_st *

column

)

Get charset for a column.

Definition at line 404 of file column.c.

uint32_t drizzle_column_size

(

drizzle_column_st *

column

)

Get size of a column.

Definition at line 409 of file column.c.

size_t drizzle_column_max_size

(

drizzle_column_st *

column

)

Get max size of a column.

Definition at line 414 of file column.c.

void drizzle_column_set_max_size	(	drizzle_column_st *	column,
		size_t	size
	)

Set max size of a column.

Definition at line 419 of file column.c.

drizzle_column_type_t drizzle_column_type

(

drizzle_column_st *

column

)

Get the type of a column.

Definition at line 424 of file column.c.

drizzle_column_type_drizzle_t drizzle_column_type_drizzle

(

drizzle_column_st *

column

)

Get the Drizzle type of a column.

Definition at line 430 of file column.c.

drizzle_column_flags_t drizzle_column_flags

(

drizzle_column_st *

column

)

Get flags for a column.

Definition at line 435 of file column.c.

uint8_t drizzle_column_decimals

(

drizzle_column_st *

column

)

Get the number of decimals for numeric columns.

Definition at line 440 of file column.c.

const uint8_t* drizzle_column_default_value	(	drizzle_column_st *	column,
		size_t *	size
	)

Get default value for a column.

Definition at line 445 of file column.c.