Drizzled Public API Documentation

Connection Declarations

Classes

struct  drizzle_con_tcp_st
struct  drizzle_con_uds_st
struct  drizzle_con_st

Modules

 Static Connection Declarations
 Local Connection Declarations

Enumerations

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), DRIZZLE_CON_FOUND_ROWS = (1 << 9), DRIZZLE_CON_ADMIN = (1 << 10),
  DRIZZLE_CON_INTERACTIVE = (1 << 11), DRIZZLE_CON_MULTI_STATEMENTS = (1 << 12), DRIZZLE_CON_AUTH_PLUGIN = (1 << 13)
}
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_PS_MULTI_RESULTS = (1 << 18),
  DRIZZLE_CAPABILITIES_PLUGIN_AUTH = (1 << 19), DRIZZLE_CAPABILITIES_ADMIN = (1 << 25), DRIZZLE_CAPABILITIES_SSL_VERIFY_SERVER_CERT = (1 << 30), DRIZZLE_CAPABILITIES_REMEMBER_OPTIONS = (1 << 31),
  DRIZZLE_CAPABILITIES_CLIENT
}

Functions

DRIZZLE_API int drizzle_con_fd (const drizzle_con_st *con)
DRIZZLE_API drizzle_return_t drizzle_con_set_fd (drizzle_con_st *con, int fd)
DRIZZLE_API void drizzle_con_close (drizzle_con_st *con)
DRIZZLE_API drizzle_return_t drizzle_con_set_events (drizzle_con_st *con, short events)
DRIZZLE_API drizzle_return_t drizzle_con_set_revents (drizzle_con_st *con, short revents)
DRIZZLE_API drizzle_stdrizzle_con_drizzle (const drizzle_con_st *con)
DRIZZLE_API const char * drizzle_con_error (const drizzle_con_st *con)
DRIZZLE_API int drizzle_con_errno (const drizzle_con_st *con)
DRIZZLE_API uint16_t drizzle_con_error_code (const drizzle_con_st *con)
DRIZZLE_API const char * drizzle_con_sqlstate (const drizzle_con_st *con)
DRIZZLE_API drizzle_con_options_t drizzle_con_options (const drizzle_con_st *con)
DRIZZLE_API void drizzle_con_set_options (drizzle_con_st *con, drizzle_con_options_t options)
DRIZZLE_API void drizzle_con_add_options (drizzle_con_st *con, drizzle_con_options_t options)
DRIZZLE_API void drizzle_con_remove_options (drizzle_con_st *con, drizzle_con_options_t options)
DRIZZLE_API const char * drizzle_con_host (const drizzle_con_st *con)
DRIZZLE_API in_port_t drizzle_con_port (const drizzle_con_st *con)
DRIZZLE_API void drizzle_con_set_tcp (drizzle_con_st *con, const char *host, in_port_t port)
DRIZZLE_API const char * drizzle_con_uds (const drizzle_con_st *con)
DRIZZLE_API void drizzle_con_set_uds (drizzle_con_st *con, const char *uds)
DRIZZLE_API const char * drizzle_con_user (const drizzle_con_st *con)
DRIZZLE_API const char * drizzle_con_password (const drizzle_con_st *con)
DRIZZLE_API void drizzle_con_set_auth (drizzle_con_st *con, const char *user, const char *password)
DRIZZLE_API const char * drizzle_con_db (const drizzle_con_st *con)
DRIZZLE_API void drizzle_con_set_db (drizzle_con_st *con, const char *db)
DRIZZLE_API void * drizzle_con_context (const drizzle_con_st *con)
DRIZZLE_API void drizzle_con_set_context (drizzle_con_st *con, void *context)
DRIZZLE_API void drizzle_con_set_context_free_fn (drizzle_con_st *con, drizzle_con_context_free_fn *function)
DRIZZLE_API uint8_t drizzle_con_protocol_version (const drizzle_con_st *con)
DRIZZLE_API const char * drizzle_con_server_version (const drizzle_con_st *con)
DRIZZLE_API uint32_t drizzle_con_server_version_number (const drizzle_con_st *con)
DRIZZLE_API uint32_t drizzle_con_thread_id (const drizzle_con_st *con)
DRIZZLE_API const uint8_t * drizzle_con_scramble (const drizzle_con_st *con)
DRIZZLE_API drizzle_capabilities_t drizzle_con_capabilities (const drizzle_con_st *con)
DRIZZLE_API drizzle_charset_t drizzle_con_charset (const drizzle_con_st *con)
DRIZZLE_API drizzle_con_status_t drizzle_con_status (const drizzle_con_st *con)
DRIZZLE_API uint32_t drizzle_con_max_packet_size (const drizzle_con_st *con)

Enumeration Type Documentation

Capabilities for drizzle_con_st.

Definition at line 211 of file constants.h.

Options for drizzle_con_st.

Definition at line 159 of file constants.h.

Socket types for drizzle_con_st.

Definition at line 182 of file constants.h.

Status flags for drizle_con_st.

Definition at line 192 of file constants.h.


Function Documentation

Add options for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]optionsAvailable options for connection structure to set.

Definition at line 191 of file conn.c.

Referenced by drizzle_con_accept(), drizzle_con_add_tcp(), drizzle_con_add_tcp_listen(), drizzle_con_add_uds(), and drizzle_con_add_uds_listen().

Get capabilities for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Capabilities for connection.

Definition at line 357 of file conn.c.

DRIZZLE_API drizzle_charset_t drizzle_con_charset ( const drizzle_con_st con)

Get character set for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Character set for connection.

Definition at line 362 of file conn.c.

Close a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.

Definition at line 84 of file conn.c.

References drizzle_state_reset().

Referenced by drizzle_con_free(), drizzle_con_set_events(), drizzle_con_set_revents(), and drizzle_state_loop().

Get application context pointer for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Application context with this connection.

Definition at line 302 of file conn.c.

DRIZZLE_API const char* drizzle_con_db ( const drizzle_con_st con)

Get database for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Database associated with this connection.

Definition at line 286 of file conn.c.

Get the drizzle_st struct that the connection belongs to.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Drizzle object that this connection is part of.

Definition at line 155 of file conn.c.

Value of errno in the case of a DRIZZLE_RETURN_ERRNO return value.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
An errno value as defined in your system errno.h file.

Definition at line 165 of file conn.c.

References drizzle_errno().

DRIZZLE_API const char* drizzle_con_error ( const drizzle_con_st con)

Return an error string for last error encountered.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Pointer to static buffer in library that holds an error string.

Definition at line 160 of file conn.c.

References drizzle_error().

Get server defined error code for the last result read.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
An error code given back in the server response.

Definition at line 170 of file conn.c.

References drizzle_error_code().

Get file descriptor for connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
File descriptor of connection, or -1 if not active.

Definition at line 66 of file conn.c.

DRIZZLE_API const char* drizzle_con_host ( const drizzle_con_st con)

Get TCP host for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Host this connection is configured for, or NULL if not set.

Definition at line 209 of file conn.c.

Get max packet size for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Max packet size for connection.

Definition at line 372 of file conn.c.

Get options for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Options set for the connection structure.

Definition at line 180 of file conn.c.

DRIZZLE_API const char* drizzle_con_password ( const drizzle_con_st con)

Get password for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Password associated with this connection.

Definition at line 261 of file conn.c.

DRIZZLE_API in_port_t drizzle_con_port ( const drizzle_con_st con)

Get TCP port for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Port this connection is configured for, 0 if not set.

Definition at line 222 of file conn.c.

Get protocol version for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Protocol version for connection.

Definition at line 318 of file conn.c.

Remove options for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]optionsAvailable options for connection structure to remove.

Definition at line 203 of file conn.c.

DRIZZLE_API const uint8_t* drizzle_con_scramble ( const drizzle_con_st con)

Get scramble buffer for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Scramble buffer for connection.

Definition at line 352 of file conn.c.

Get server version string for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Server version string for connection.

Definition at line 323 of file conn.c.

Get server version number for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Server version number for connection.

Definition at line 328 of file conn.c.

DRIZZLE_API void drizzle_con_set_auth ( drizzle_con_st con,
const char *  user,
const char *  password 
)

Set username and password for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]userUsername to use for this connection.
[in]passwordPassword to use for this connection.

Definition at line 266 of file conn.c.

Referenced by drizzle_con_add_tcp(), drizzle_con_add_uds(), drizzle_con_copy_handshake(), and slave::QueueProducer::openConnection().

DRIZZLE_API void drizzle_con_set_context ( drizzle_con_st con,
void *  context 
)

Set application context pointer for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]contextApplication context to use with this connection.

Definition at line 307 of file conn.c.

DRIZZLE_API void drizzle_con_set_context_free_fn ( drizzle_con_st con,
drizzle_con_context_free_fn *  function 
)

Set callback function when the context pointer should be freed.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]functionFunction to call to clean up connection context.

Definition at line 312 of file conn.c.

DRIZZLE_API void drizzle_con_set_db ( drizzle_con_st con,
const char *  db 
)

Set database for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]dbDatabase to use with this connection.

Definition at line 291 of file conn.c.

Referenced by drizzle_con_add_tcp(), drizzle_con_add_uds(), drizzle_con_copy_handshake(), and drizzle_con_select_db().

Set events to be watched for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]eventsBitfield of poll() events to watch.
Returns:
Standard drizzle return value.

Definition at line 102 of file conn.c.

References drizzle_con_close().

Referenced by drizzle_con_accept().

Use given file descriptor for connction.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]fdFile descriptor for connection.
Returns:
Standard drizzle return value.

Definition at line 71 of file conn.c.

References _con_setsockopt().

Referenced by drizzle_con_accept().

Set options for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]optionsAvailable options for connection structure to set.

Definition at line 185 of file conn.c.

Set events that are ready for a connection. This is used with the external event callbacks. See drizzle_set_event_watch_fn().

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]reventsBitfield of poll() events that were detected.
Returns:
Standard drizzle return value.

Definition at line 125 of file conn.c.

References drizzle_con_close().

Referenced by drizzle_con_wait().

DRIZZLE_API void drizzle_con_set_tcp ( drizzle_con_st con,
const char *  host,
in_port_t  port 
)

Set TCP host and port for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]hostHost to use for this connection, NULL for default value.
[in]portPort to use for this connection, 0 for default value.

Definition at line 238 of file conn.c.

References drizzle_con_reset_addrinfo().

Referenced by drizzle_con_add_tcp(), drizzle_con_add_tcp_listen(), drizzle_con_clone(), and slave::QueueProducer::openConnection().

DRIZZLE_API void drizzle_con_set_uds ( drizzle_con_st con,
const char *  uds 
)

Set unix domain socket for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]udsUnix domain socket to use for this connection, NULL for defailt value.

Definition at line 60 of file conn_uds.c.

References drizzle_con_reset_addrinfo().

Referenced by drizzle_con_add_uds(), drizzle_con_add_uds_listen(), and drizzle_con_clone().

DRIZZLE_API const char* drizzle_con_sqlstate ( const drizzle_con_st con)

Get SQL state code for the last result read.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
A SQLSTATE code given back in the server response.

Definition at line 175 of file conn.c.

References drizzle_sqlstate().

Get status for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Status for connection.

Definition at line 367 of file conn.c.

Get thread ID for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Thread ID for connection.

Definition at line 347 of file conn.c.

DRIZZLE_API const char* drizzle_con_uds ( const drizzle_con_st con)

Get unix domain socket for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Unix domain socket set for this connection, NULL if not set.

Definition at line 44 of file conn_uds.c.

DRIZZLE_API const char* drizzle_con_user ( const drizzle_con_st con)

Get username for a connection.

Parameters:
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
User associated with this connection.

Definition at line 256 of file conn.c.