You've already forked mariadb-columnstore-engine
mirror of
https://github.com/mariadb-corporation/mariadb-columnstore-engine.git
synced 2025-08-15 22:22:17 +03:00
437 lines
14 KiB
C
437 lines
14 KiB
C
/*
|
|
* 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 Connection Declarations
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @addtogroup drizzle_con Connection Declarations
|
|
* @ingroup drizzle_client_interface
|
|
* @ingroup drizzle_server_interface
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Get file descriptor for connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return File descriptor of connection, or -1 if not active.
|
|
*/
|
|
DRIZZLE_API
|
|
int drizzle_con_fd(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Use given file descriptor for connction.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] fd File descriptor for connection.
|
|
* @return Standard drizzle return value.
|
|
*/
|
|
DRIZZLE_API
|
|
drizzle_return_t drizzle_con_set_fd(drizzle_con_st *con, int fd);
|
|
|
|
/**
|
|
* Close a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_close(drizzle_con_st *con);
|
|
|
|
/**
|
|
* Set events to be watched for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] events Bitfield of poll() events to watch.
|
|
* @return Standard drizzle return value.
|
|
*/
|
|
DRIZZLE_API
|
|
drizzle_return_t drizzle_con_set_events(drizzle_con_st *con, short events);
|
|
|
|
/**
|
|
* Set events that are ready for a connection. This is used with the external
|
|
* event callbacks. See drizzle_set_event_watch_fn().
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] revents Bitfield of poll() events that were detected.
|
|
* @return Standard drizzle return value.
|
|
*/
|
|
DRIZZLE_API
|
|
drizzle_return_t drizzle_con_set_revents(drizzle_con_st *con, short revents);
|
|
|
|
/**
|
|
* Get the drizzle_st struct that the connection belongs to.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Drizzle object that this connection is part of.
|
|
*/
|
|
DRIZZLE_API
|
|
drizzle_st *drizzle_con_drizzle(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Return an error string for last error encountered.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Pointer to static buffer in library that holds an error string.
|
|
*/
|
|
DRIZZLE_API
|
|
const char *drizzle_con_error(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Value of errno in the case of a DRIZZLE_RETURN_ERRNO return value.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return An errno value as defined in your system errno.h file.
|
|
*/
|
|
DRIZZLE_API
|
|
int drizzle_con_errno(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get server defined error code for the last result read.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return An error code given back in the server response.
|
|
*/
|
|
DRIZZLE_API
|
|
uint16_t drizzle_con_error_code(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get SQL state code for the last result read.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return A SQLSTATE code given back in the server response.
|
|
*/
|
|
DRIZZLE_API
|
|
const char *drizzle_con_sqlstate(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get options for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Options set for the connection structure.
|
|
*/
|
|
DRIZZLE_API
|
|
int drizzle_con_options(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Set options for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] options Available options for connection structure to set.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_set_options(drizzle_con_st *con,
|
|
int options);
|
|
|
|
/**
|
|
* Add options for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] options Available options for connection structure to set.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_add_options(drizzle_con_st *con,
|
|
int options);
|
|
|
|
/**
|
|
* Remove options for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] options Available options for connection structure to remove.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_remove_options(drizzle_con_st *con,
|
|
int options);
|
|
|
|
/**
|
|
* Get TCP host for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Host this connection is configured for, or NULL if not set.
|
|
*/
|
|
DRIZZLE_API
|
|
const char *drizzle_con_host(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get TCP port for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Port this connection is configured for, 0 if not set.
|
|
*/
|
|
DRIZZLE_API
|
|
in_port_t drizzle_con_port(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Set TCP host and port for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] host Host to use for this connection, NULL for default value.
|
|
* @param[in] port Port to use for this connection, 0 for default value.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_set_tcp(drizzle_con_st *con, const char *host, in_port_t port);
|
|
|
|
/**
|
|
* Get unix domain socket for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Unix domain socket set for this connection, NULL if not set.
|
|
*/
|
|
DRIZZLE_API
|
|
const char *drizzle_con_uds(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Set unix domain socket for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] uds Unix domain socket to use for this connection, NULL for
|
|
* defailt value.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_set_uds(drizzle_con_st *con, const char *uds);
|
|
|
|
/**
|
|
* Get username for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return User associated with this connection.
|
|
*/
|
|
DRIZZLE_API
|
|
const char *drizzle_con_user(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get password for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Password associated with this connection.
|
|
*/
|
|
DRIZZLE_API
|
|
const char *drizzle_con_password(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Set username and password for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] user Username to use for this connection.
|
|
* @param[in] password Password to use for this connection.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_set_auth(drizzle_con_st *con, const char *user,
|
|
const char *password);
|
|
|
|
/**
|
|
* Get database for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Database associated with this connection.
|
|
*/
|
|
DRIZZLE_API
|
|
const char *drizzle_con_schema(const drizzle_con_st *con);
|
|
|
|
DRIZZLE_API
|
|
const char *drizzle_con_db(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Set database for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] schema Database to use with this connection.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_set_schema(drizzle_con_st *con, const char *schema);
|
|
|
|
DRIZZLE_API
|
|
void drizzle_con_set_db(drizzle_con_st *con, const char *schema);
|
|
|
|
/**
|
|
* Get application context pointer for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Application context with this connection.
|
|
*/
|
|
DRIZZLE_API
|
|
void *drizzle_con_context(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Set application context pointer for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] context Application context to use with this connection.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_set_context(drizzle_con_st *con, void *context);
|
|
|
|
/**
|
|
* Set callback function when the context pointer should be freed.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @param[in] function Function to call to clean up connection context.
|
|
*/
|
|
DRIZZLE_API
|
|
void drizzle_con_set_context_free_fn(drizzle_con_st *con,
|
|
drizzle_con_context_free_fn *function);
|
|
|
|
/**
|
|
* Get protocol version for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Protocol version for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
uint8_t drizzle_con_protocol_version(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get server version string for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Server version string for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
const char *drizzle_con_server_version(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get server version number for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Server version number for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
uint32_t drizzle_con_server_version_number(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get thread ID for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Thread ID for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
uint32_t drizzle_con_thread_id(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get scramble buffer for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Scramble buffer for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
const uint8_t *drizzle_con_scramble(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get capabilities for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Capabilities for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
int drizzle_con_capabilities(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get character set for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Character set for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
drizzle_charset_t drizzle_con_charset(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get status for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Status for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
drizzle_con_status_t drizzle_con_status(const drizzle_con_st *con);
|
|
|
|
/**
|
|
* Get max packet size for a connection.
|
|
*
|
|
* @param[in] con Connection structure previously initialized with
|
|
* drizzle_con_create(), drizzle_con_clone(), or related functions.
|
|
* @return Max packet size for connection.
|
|
*/
|
|
DRIZZLE_API
|
|
uint32_t drizzle_con_max_packet_size(const drizzle_con_st *con);
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|