libdrizzle Public API Documentation

constants.h File Reference

Defines, typedefs, enums, and macros. More...

Go to the source code of this file.

Macros

#define DRIZZLE_RETURN_SERVER_GONE   DRIZZLE_RETURN_LOST_CONNECTION
 
#define DRIZZLE_RETURN_EOF   DRIZZLE_RETURN_LOST_CONNECTION
 
#define DRIZZLE_COLUMN_TYPE_VIRTUAL   17
 
#define DRIZZLE_DEFAULT_TCP_HOST   "127.0.0.1"
 
#define DRIZZLE_DEFAULT_TCP_PORT   4427
 
#define DRIZZLE_DEFAULT_TCP_PORT_MYSQL   3306
 
#define DRIZZLE_DEFAULT_UDS   "/tmp/drizzle.sock"
 
#define DRIZZLE_DEFAULT_UDS_MYSQL   "/tmp/mysql.sock"
 
#define DRIZZLE_DEFAULT_BACKLOG   64
 
#define DRIZZLE_MAX_ERROR_SIZE   2048
 
#define DRIZZLE_MAX_USER_SIZE   64
 
#define DRIZZLE_MAX_PASSWORD_SIZE   32
 
#define DRIZZLE_MAX_DB_SIZE   64
 
#define DRIZZLE_MAX_INFO_SIZE   2048
 
#define DRIZZLE_MAX_SQLSTATE_SIZE   5
 
#define DRIZZLE_MAX_CATALOG_SIZE   128
 
#define DRIZZLE_MAX_TABLE_SIZE   128
 
#define DRIZZLE_MAX_COLUMN_NAME_SIZE   2048
 
#define DRIZZLE_MAX_DEFAULT_VALUE_SIZE   2048
 
#define DRIZZLE_MAX_PACKET_SIZE   UINT32_MAX
 
#define DRIZZLE_MAX_BUFFER_SIZE   32768
 
#define DRIZZLE_BUFFER_COPY_THRESHOLD   8192
 
#define DRIZZLE_MAX_SERVER_VERSION_SIZE   32
 
#define DRIZZLE_MAX_SCRAMBLE_SIZE   20
 
#define DRIZZLE_STATE_STACK_SIZE   8
 
#define DRIZZLE_ROW_GROW_SIZE   8192
 
#define DRIZZLE_DEFAULT_SOCKET_TIMEOUT   10
 
#define DRIZZLE_DEFAULT_SOCKET_SEND_SIZE   32768
 
#define DRIZZLE_DEFAULT_SOCKET_RECV_SIZE   32768
 
#define drizzle_get_byte2(__buffer)
 
#define drizzle_get_byte3(__buffer)
 
#define drizzle_get_byte4(__buffer)
 
#define drizzle_get_byte8(__buffer)
 
#define drizzle_set_byte2(__buffer, __int)
 
#define drizzle_set_byte3(__buffer, __int)
 
#define drizzle_set_byte4(__buffer, __int)
 
#define drizzle_set_byte8(__buffer, __int)
 
#define drizzle_mb_char(__c)
 
#define drizzle_mb_length(__c)
 

Typedefs

typedef struct drizzle_st drizzle_st
 
typedef struct drizzle_con_tcp_st drizzle_con_tcp_st
 
typedef struct drizzle_con_uds_st drizzle_con_uds_st
 
typedef struct drizzle_con_st drizzle_con_st
 
typedef struct drizzle_query_st drizzle_query_st
 
typedef struct drizzle_result_st drizzle_result_st
 
typedef struct drizzle_column_st drizzle_column_st
 
typedef char * drizzle_field_t
 
typedef drizzle_field_tdrizzle_row_t
 
typedef uint8_t drizzle_charset_t
 
typedef void drizzle_context_free_fn(drizzle_st *drizzle, void *context)
 
typedef void drizzle_log_fn(const char *line, drizzle_verbose_t verbose, void *context)
 
typedef drizzle_return_t drizzle_state_fn(drizzle_con_st *con)
 
typedef void drizzle_con_context_free_fn(drizzle_con_st *con, void *context)
 
typedef void drizzle_query_context_free_fn(drizzle_query_st *query, void *context)
 
typedef drizzle_return_t drizzle_event_watch_fn(drizzle_con_st *con, short events, void *context)
 

Enumerations

enum  drizzle_return_t {
  DRIZZLE_RETURN_OK , DRIZZLE_RETURN_IO_WAIT , DRIZZLE_RETURN_PAUSE , DRIZZLE_RETURN_ROW_BREAK ,
  DRIZZLE_RETURN_MEMORY , DRIZZLE_RETURN_ERRNO , DRIZZLE_RETURN_INTERNAL_ERROR , DRIZZLE_RETURN_GETADDRINFO ,
  DRIZZLE_RETURN_NOT_READY , DRIZZLE_RETURN_BAD_PACKET_NUMBER , DRIZZLE_RETURN_BAD_HANDSHAKE_PACKET , DRIZZLE_RETURN_BAD_PACKET ,
  DRIZZLE_RETURN_PROTOCOL_NOT_SUPPORTED , DRIZZLE_RETURN_UNEXPECTED_DATA , DRIZZLE_RETURN_NO_SCRAMBLE , DRIZZLE_RETURN_AUTH_FAILED ,
  DRIZZLE_RETURN_NULL_SIZE , DRIZZLE_RETURN_ERROR_CODE , DRIZZLE_RETURN_TOO_MANY_COLUMNS , DRIZZLE_RETURN_ROW_END ,
  DRIZZLE_RETURN_LOST_CONNECTION , DRIZZLE_RETURN_COULD_NOT_CONNECT , DRIZZLE_RETURN_NO_ACTIVE_CONNECTIONS , DRIZZLE_RETURN_HANDSHAKE_FAILED ,
  DRIZZLE_RETURN_TIMEOUT , DRIZZLE_RETURN_MAX
}
 
enum  drizzle_verbose_t {
  DRIZZLE_VERBOSE_NEVER , DRIZZLE_VERBOSE_FATAL , DRIZZLE_VERBOSE_ERROR , DRIZZLE_VERBOSE_INFO ,
  DRIZZLE_VERBOSE_DEBUG , DRIZZLE_VERBOSE_CRAZY , DRIZZLE_VERBOSE_MAX
}
 
enum  drizzle_options_t {
  DRIZZLE_NONE = 0 , DRIZZLE_ALLOCATED = (1 << 0) , DRIZZLE_NON_BLOCKING = (1 << 1) , DRIZZLE_FREE_OBJECTS = (1 << 2) ,
  DRIZZLE_ASSERT_DANGLING = (1 << 3)
}
 
enum  drizzle_con_options_t {
  DRIZZLE_CON_NONE = 0 , DRIZZLE_CON_ALLOCATED = (1 << 0) , DRIZZLE_CON_MYSQL = (1 << 1) , DRIZZLE_CON_RAW_PACKET = (1 << 2) ,
  DRIZZLE_CON_RAW_SCRAMBLE = (1 << 3) , DRIZZLE_CON_READY = (1 << 4) , DRIZZLE_CON_NO_RESULT_READ = (1 << 5) , DRIZZLE_CON_IO_READY = (1 << 6) ,
  DRIZZLE_CON_LISTEN = (1 << 7) , DRIZZLE_CON_EXPERIMENTAL = (1 << 8)
}
 
enum  drizzle_con_socket_t { DRIZZLE_CON_SOCKET_TCP = 0 , DRIZZLE_CON_SOCKET_UDS = (1 << 0) }
 
enum  drizzle_con_status_t {
  DRIZZLE_CON_STATUS_NONE = 0 , DRIZZLE_CON_STATUS_IN_TRANS = (1 << 0) , DRIZZLE_CON_STATUS_AUTOCOMMIT = (1 << 1) , DRIZZLE_CON_STATUS_MORE_RESULTS_EXISTS = (1 << 3) ,
  DRIZZLE_CON_STATUS_QUERY_NO_GOOD_INDEX_USED = (1 << 4) , DRIZZLE_CON_STATUS_QUERY_NO_INDEX_USED = (1 << 5) , DRIZZLE_CON_STATUS_CURSOR_EXISTS = (1 << 6) , DRIZZLE_CON_STATUS_LAST_ROW_SENT = (1 << 7) ,
  DRIZZLE_CON_STATUS_DB_DROPPED = (1 << 8) , DRIZZLE_CON_STATUS_NO_BACKSLASH_ESCAPES = (1 << 9) , DRIZZLE_CON_STATUS_QUERY_WAS_SLOW = (1 << 10)
}
 
enum  drizzle_capabilities_t {
  DRIZZLE_CAPABILITIES_NONE = 0 , DRIZZLE_CAPABILITIES_LONG_PASSWORD = (1 << 0) , DRIZZLE_CAPABILITIES_FOUND_ROWS = (1 << 1) , DRIZZLE_CAPABILITIES_LONG_FLAG = (1 << 2) ,
  DRIZZLE_CAPABILITIES_CONNECT_WITH_DB = (1 << 3) , DRIZZLE_CAPABILITIES_NO_SCHEMA = (1 << 4) , DRIZZLE_CAPABILITIES_COMPRESS = (1 << 5) , DRIZZLE_CAPABILITIES_ODBC = (1 << 6) ,
  DRIZZLE_CAPABILITIES_LOCAL_FILES = (1 << 7) , DRIZZLE_CAPABILITIES_IGNORE_SPACE = (1 << 8) , DRIZZLE_CAPABILITIES_PROTOCOL_41 = (1 << 9) , DRIZZLE_CAPABILITIES_INTERACTIVE = (1 << 10) ,
  DRIZZLE_CAPABILITIES_SSL = (1 << 11) , DRIZZLE_CAPABILITIES_IGNORE_SIGPIPE = (1 << 12) , DRIZZLE_CAPABILITIES_TRANSACTIONS = (1 << 13) , DRIZZLE_CAPABILITIES_RESERVED = (1 << 14) ,
  DRIZZLE_CAPABILITIES_SECURE_CONNECTION = (1 << 15) , DRIZZLE_CAPABILITIES_MULTI_STATEMENTS = (1 << 16) , DRIZZLE_CAPABILITIES_MULTI_RESULTS = (1 << 17) , DRIZZLE_CAPABILITIES_SSL_VERIFY_SERVER_CERT = (1 << 30) ,
  DRIZZLE_CAPABILITIES_REMEMBER_OPTIONS = (1 << 31) , DRIZZLE_CAPABILITIES_CLIENT
}
 
enum  drizzle_command_t {
  DRIZZLE_COMMAND_SLEEP , DRIZZLE_COMMAND_QUIT , DRIZZLE_COMMAND_INIT_DB , DRIZZLE_COMMAND_QUERY ,
  DRIZZLE_COMMAND_FIELD_LIST , DRIZZLE_COMMAND_CREATE_DB , DRIZZLE_COMMAND_DROP_DB , DRIZZLE_COMMAND_REFRESH ,
  DRIZZLE_COMMAND_SHUTDOWN , DRIZZLE_COMMAND_STATISTICS , DRIZZLE_COMMAND_PROCESS_INFO , DRIZZLE_COMMAND_CONNECT ,
  DRIZZLE_COMMAND_PROCESS_KILL , DRIZZLE_COMMAND_DEBUG , DRIZZLE_COMMAND_PING , DRIZZLE_COMMAND_TIME ,
  DRIZZLE_COMMAND_DELAYED_INSERT , DRIZZLE_COMMAND_CHANGE_USER , DRIZZLE_COMMAND_BINLOG_DUMP , DRIZZLE_COMMAND_TABLE_DUMP ,
  DRIZZLE_COMMAND_CONNECT_OUT , DRIZZLE_COMMAND_REGISTER_SLAVE , DRIZZLE_COMMAND_STMT_PREPARE , DRIZZLE_COMMAND_STMT_EXECUTE ,
  DRIZZLE_COMMAND_STMT_SEND_LONG_DATA , DRIZZLE_COMMAND_STMT_CLOSE , DRIZZLE_COMMAND_STMT_RESET , DRIZZLE_COMMAND_SET_OPTION ,
  DRIZZLE_COMMAND_STMT_FETCH , DRIZZLE_COMMAND_DAEMON , DRIZZLE_COMMAND_END
}
 
enum  drizzle_command_drizzle_t {
  DRIZZLE_COMMAND_DRIZZLE_SLEEP , DRIZZLE_COMMAND_DRIZZLE_QUIT , DRIZZLE_COMMAND_DRIZZLE_INIT_DB , DRIZZLE_COMMAND_DRIZZLE_QUERY ,
  DRIZZLE_COMMAND_DRIZZLE_SHUTDOWN , DRIZZLE_COMMAND_DRIZZLE_CONNECT , DRIZZLE_COMMAND_DRIZZLE_PING , DRIZZLE_COMMAND_DRIZZLE_END
}
 
enum  drizzle_query_options_t { DRIZZLE_QUERY_ALLOCATED = (1 << 0) }
 
enum  drizzle_query_state_t { DRIZZLE_QUERY_STATE_INIT , DRIZZLE_QUERY_STATE_QUERY , DRIZZLE_QUERY_STATE_RESULT , DRIZZLE_QUERY_STATE_DONE }
 
enum  drizzle_result_options_t {
  DRIZZLE_RESULT_NONE = 0 , DRIZZLE_RESULT_ALLOCATED = (1 << 0) , DRIZZLE_RESULT_SKIP_COLUMN = (1 << 1) , DRIZZLE_RESULT_BUFFER_COLUMN = (1 << 2) ,
  DRIZZLE_RESULT_BUFFER_ROW = (1 << 3) , DRIZZLE_RESULT_EOF_PACKET = (1 << 4) , DRIZZLE_RESULT_ROW_BREAK = (1 << 5)
}
 
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)
}
 

Detailed Description

Defines, typedefs, enums, and macros.

Definition in file constants.h.

Enumeration Type Documentation

◆ drizzle_command_t

Commands for drizzle_command functions.

Enumerator
DRIZZLE_COMMAND_SLEEP 
DRIZZLE_COMMAND_QUIT 
DRIZZLE_COMMAND_INIT_DB 
DRIZZLE_COMMAND_QUERY 
DRIZZLE_COMMAND_FIELD_LIST 
DRIZZLE_COMMAND_CREATE_DB 
DRIZZLE_COMMAND_DROP_DB 
DRIZZLE_COMMAND_REFRESH 
DRIZZLE_COMMAND_SHUTDOWN 
DRIZZLE_COMMAND_STATISTICS 
DRIZZLE_COMMAND_PROCESS_INFO 
DRIZZLE_COMMAND_CONNECT 
DRIZZLE_COMMAND_PROCESS_KILL 
DRIZZLE_COMMAND_DEBUG 
DRIZZLE_COMMAND_PING 
DRIZZLE_COMMAND_TIME 
DRIZZLE_COMMAND_DELAYED_INSERT 
DRIZZLE_COMMAND_CHANGE_USER 
DRIZZLE_COMMAND_BINLOG_DUMP 
DRIZZLE_COMMAND_TABLE_DUMP 
DRIZZLE_COMMAND_CONNECT_OUT 
DRIZZLE_COMMAND_REGISTER_SLAVE 
DRIZZLE_COMMAND_STMT_PREPARE 
DRIZZLE_COMMAND_STMT_EXECUTE 
DRIZZLE_COMMAND_STMT_SEND_LONG_DATA 
DRIZZLE_COMMAND_STMT_CLOSE 
DRIZZLE_COMMAND_STMT_RESET 
DRIZZLE_COMMAND_SET_OPTION 
DRIZZLE_COMMAND_STMT_FETCH 
DRIZZLE_COMMAND_DAEMON 
DRIZZLE_COMMAND_END 

Definition at line 213 of file constants.h.

◆ drizzle_command_drizzle_t

Commands for the Drizzle protocol functions.

Enumerator
DRIZZLE_COMMAND_DRIZZLE_SLEEP 
DRIZZLE_COMMAND_DRIZZLE_QUIT 
DRIZZLE_COMMAND_DRIZZLE_INIT_DB 
DRIZZLE_COMMAND_DRIZZLE_QUERY 
DRIZZLE_COMMAND_DRIZZLE_SHUTDOWN 
DRIZZLE_COMMAND_DRIZZLE_CONNECT 
DRIZZLE_COMMAND_DRIZZLE_PING 
DRIZZLE_COMMAND_DRIZZLE_END 

Definition at line 252 of file constants.h.