Drizzled Public API Documentation

Column Declarations

Classes

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_TIME, DRIZZLE_COLUMN_TYPE_DRIZZLE_BOOLEAN, DRIZZLE_COLUMN_TYPE_DRIZZLE_UUID, DRIZZLE_COLUMN_TYPE_DRIZZLE_MICROTIME,
  DRIZZLE_COLUMN_TYPE_DRIZZLE_MAX = DRIZZLE_COLUMN_TYPE_DRIZZLE_MICROTIME
}
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_API drizzle_column_stdrizzle_column_create (drizzle_result_st *result, drizzle_column_st *column)
DRIZZLE_API void drizzle_column_free (drizzle_column_st *column)
DRIZZLE_API drizzle_result_stdrizzle_column_drizzle_result (drizzle_column_st *column)
DRIZZLE_API const char * drizzle_column_catalog (drizzle_column_st *column)
DRIZZLE_API const char * drizzle_column_db (drizzle_column_st *column)
DRIZZLE_API const char * drizzle_column_table (drizzle_column_st *column)
DRIZZLE_API const char * drizzle_column_orig_table (drizzle_column_st *column)
DRIZZLE_API const char * drizzle_column_name (drizzle_column_st *column)
DRIZZLE_API const char * drizzle_column_orig_name (drizzle_column_st *column)
DRIZZLE_API drizzle_charset_t drizzle_column_charset (drizzle_column_st *column)
DRIZZLE_API uint32_t drizzle_column_size (drizzle_column_st *column)
DRIZZLE_API size_t drizzle_column_max_size (drizzle_column_st *column)
DRIZZLE_API void drizzle_column_set_max_size (drizzle_column_st *column, size_t size)
DRIZZLE_API drizzle_column_type_t drizzle_column_type (drizzle_column_st *column)
DRIZZLE_API
drizzle_column_type_drizzle_t 
drizzle_column_type_drizzle (drizzle_column_st *column)
DRIZZLE_API drizzle_column_flags_t drizzle_column_flags (drizzle_column_st *column)
DRIZZLE_API uint8_t drizzle_column_decimals (drizzle_column_st *column)
DRIZZLE_API 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

Flags for drizzle_column_st.

Definition at line 414 of file constants.h.

Options for drizzle_column_st.

Definition at line 345 of file constants.h.

Types for drizzle_column_st for Drizzle.

Definition at line 389 of file constants.h.

Types for drizzle_column_st.

Definition at line 354 of file constants.h.


Function Documentation

Get catalog name for a column.

Definition at line 437 of file column.c.

DRIZZLE_API drizzle_charset_t drizzle_column_charset ( drizzle_column_st column)

Get charset for a column.

Definition at line 467 of file column.c.

Initialize a column structure.

Definition at line 354 of file column.c.

References drizzle_set_error().

DRIZZLE_API const char* drizzle_column_db ( drizzle_column_st column)

Get database name for a column.

Definition at line 442 of file column.c.

Get the number of decimals for numeric columns.

Definition at line 503 of file column.c.

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

Get default value for a column.

Definition at line 508 of file column.c.

Get the drizzle_result_st struct that the column belongs to.

Definition at line 432 of file column.c.

Get flags for a column.

Definition at line 498 of file column.c.

Free a column structure.

Definition at line 419 of file column.c.

Referenced by drizzle_result_free().

Get max size of a column.

Definition at line 477 of file column.c.

Get column name for a column.

Definition at line 457 of file column.c.

Get original column name for a column.

Definition at line 462 of file column.c.

Get original table name for a column.

Definition at line 452 of file column.c.

DRIZZLE_API void drizzle_column_set_max_size ( drizzle_column_st column,
size_t  size 
)

Set max size of a column.

Definition at line 482 of file column.c.

Get size of a column.

Definition at line 472 of file column.c.

Get table name for a column.

Definition at line 447 of file column.c.

Get the type of a column.

Definition at line 487 of file column.c.

Get the Drizzle type of a column.

Definition at line 493 of file column.c.