connection.h

/*
 * Copyright (c) 2008, 2024, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2.0, as
 * published by the Free Software Foundation.
 *
 * This program is designed to work with certain software (including
 * but not limited to OpenSSL) that is licensed under separate terms, as
 * designated in a particular file or component or in included license
 * documentation. The authors of MySQL hereby grant you an additional
 * permission to link the program and your derivative works with the
 * separately licensed software that they have either included with
 * the program or referenced in the documentation.
 *
 * Without limiting anything contained in the foregoing, this file,
 * which is part of Connector/C++, is also subject to the
 * Universal FOSS Exception, version 1.0, a copy of which can be found at
 * https://oss.oracle.com/licenses/universal-foss-exception.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License, version 2.0, for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/



#ifndef _SQL_CONNECTION_H_
#define_SQL_CONNECTION_H_

#include<map>

#include"build_config.h"
#include"warning.h"
#include"sqlstring.h"
#include"variant.h"

/*
 Options used on ConnectOptionsMap
*/

/*
 Connect related
*/
#defineOPT_HOSTNAME"hostName"
#defineOPT_USERNAME"userName"
#defineOPT_PASSWORD"password"
#defineOPT_PASSWORD1"password1"
#defineOPT_PASSWORD2"password2"
#defineOPT_PASSWORD3"password3"
#defineOPT_PORT"port"
#defineOPT_SOCKET"socket"
#defineOPT_PIPE"pipe"
#defineOPT_SCHEMA"schema"
#defineOPT_MULTI_HOST"OPT_MULTI_HOST"
#defineOPT_DNS_SRV"OPT_DNS_SRV"
#defineOPT_NAMED_PIPE"OPT_NAMED_PIPE"
#defineOPT_INIT_COMMAND"preInit"
#defineOPT_POST_INIT_COMMAND"postInit"
#defineOPT_LOCAL_INFILE"OPT_LOCAL_INFILE"
#defineOPT_LOAD_DATA_LOCAL_DIR"OPT_LOAD_DATA_LOCAL_DIR"

/*
 SSL related
*/
#defineOPT_SSL_MODE"ssl-mode"
#defineOPT_SSL_KEY"ssl-key"
#defineOPT_SSL_CERT"ssl-cert"
#defineOPT_SSL_CA"ssl-ca"
#defineOPT_SSL_CAPATH"ssl-capath"
#defineOPT_SSL_CIPHER"ssl-cipher"
#defineOPT_SSL_CRL"ssl-crl"
#defineOPT_SSL_CRLPATH"ssl-crlpath"
#defineOPT_SERVER_PUBLIC_KEY"rsaKey"
#defineOPT_TLS_VERSION"tls-version"

/*
 Connection related
*/
#defineOPT_RECONNECT"OPT_RECONNECT"
#defineOPT_RETRY_COUNT"OPT_RETRY_COUNT"
#defineOPT_CONNECT_TIMEOUT"OPT_CONNECT_TIMEOUT"
#defineOPT_READ_TIMEOUT"OPT_READ_TIMEOUT"
#defineOPT_WRITE_TIMEOUT"OPT_WRITE_TIMEOUT"
#defineOPT_MAX_ALLOWED_PACKET"OPT_MAX_ALLOWED_PACKET"
#defineOPT_NET_BUFFER_LENGTH"OPT_NET_BUFFER_LENGTH"

/*
 Connection Attributes
*/
#defineOPT_CONNECT_ATTR_ADD"OPT_CONNECT_ATTR_ADD"
#defineOPT_CONNECT_ATTR_DELETE"OPT_CONNECT_ATTR_DELETE"
#defineOPT_CONNECT_ATTR_RESET"OPT_CONNECT_ATTR_RESET"

/*
 Authentication
*/
#defineOPT_ENABLE_CLEARTEXT_PLUGIN"OPT_ENABLE_CLEARTEXT_PLUGIN"
#defineOPT_CAN_HANDLE_EXPIRED_PASSWORDS"OPT_CAN_HANDLE_EXPIRED_PASSWORDS"
#defineOPT_GET_SERVER_PUBLIC_KEY"OPT_GET_SERVER_PUBLIC_KEY"
#defineOPT_LEGACY_AUTH"useLegacyAuth"
#defineOPT_DEFAULT_AUTH"defaultAuth"

/*
 Charracter set results and Metadata
*/
#defineOPT_CHARACTER_SET_RESULTS"characterSetResults"
#defineOPT_OPTIONAL_RESULTSET_METADATA"OPT_OPTIONAL_RESULTSET_METADATA"
#defineOPT_REPORT_DATA_TRUNCATION"OPT_REPORT_DATA_TRUNCATION"
#defineOPT_CHARSET_NAME"OPT_CHARSET_NAME"
#defineOPT_DEFAULT_STMT_RESULT_TYPE"defaultStatementResultType"

/*
 Client side options
*/
#defineOPT_CLIENT_COMPRESS"CLIENT_COMPRESS"
#defineOPT_CLIENT_FOUND_ROWS"CLIENT_FOUND_ROWS"
#defineOPT_CLIENT_IGNORE_SIGPIPE"CLIENT_IGNORE_SIGPIPE"
#defineOPT_CLIENT_IGNORE_SPACE"CLIENT_IGNORE_SPACE"
#defineOPT_CLIENT_INTERACTIVE"CLIENT_INTERACTIVE"
#defineOPT_CLIENT_LOCAL_FILES"CLIENT_LOCAL_FILES"
#defineOPT_CLIENT_MULTI_STATEMENTS"CLIENT_MULTI_STATEMENTS"
#defineOPT_CLIENT_NO_SCHEMA"CLIENT_NO_SCHEMA"
#defineOPT_SET_CHARSET_DIR"charsetDir"
#defineOPT_PLUGIN_DIR"pluginDir"
#defineOPT_READ_DEFAULT_GROUP"readDefaultGroup"
#defineOPT_READ_DEFAULT_FILE"readDefaultFile"

/*
 Auth plugin options
*/
#defineOPT_OCI_CONFIG_FILE"OPT_OCI_CONFIG_FILE"
#defineOPT_AUTHENTICATION_KERBEROS_CLIENT_MODE \
"OPT_AUTHENTICATION_KERBEROS_CLIENT_MODE"
#defineOPT_OCI_CLIENT_CONFIG_PROFILE"OPT_OCI_CLIENT_CONFIG_PROFILE"
#defineOPT_OPENID_TOKEN_FILE"OPT_OPENID_TOKEN_FILE"
#defineOPT_WEBAUTHN_DEVICE_NUMBER"OPT_WEBAUTHN_DEVICE_NUMBER"

/*
 Telemetry options
*/
#defineOPT_OPENTELEMETRY"OPT_OPENTELEMETRY"

namespacesql
{

typedef sql::Variant ConnectPropertyVal;

typedef std::map< sql::SQLString, ConnectPropertyVal > ConnectOptionsMap;

classDatabaseMetaData;
classPreparedStatement;
classStatement;
classDriver;

typedefenum transaction_isolation
{
 TRANSACTION_NONE= 0,
 TRANSACTION_READ_COMMITTED,
 TRANSACTION_READ_UNCOMMITTED,
 TRANSACTION_REPEATABLE_READ,
 TRANSACTION_SERIALIZABLE
} enum_transaction_isolation;

enum ssl_mode
{
 SSL_MODE_DISABLED= 1, SSL_MODE_PREFERRED, SSL_MODE_REQUIRED,
 SSL_MODE_VERIFY_CA, SSL_MODE_VERIFY_IDENTITY
};

typedefenum opentelemetry_mode
{
 OTEL_DISABLED = 1, OTEL_PREFERRED, OTEL_REQUIRED
} enum_opentelemetry_mode;

classCPPCONN_PUBLIC_FUNC Savepoint
{
/* Prevent use of these */
Savepoint(const Savepoint &);
voidoperator=(Savepoint &);
public:
Savepoint() {};
virtual~Savepoint() {};
virtualintgetSavepointId() = 0;

virtual sql::SQLString getSavepointName() = 0;
};


classCPPCONN_PUBLIC_FUNC Connection
{
/* Prevent use of these */
Connection(const Connection &);
voidoperator=(Connection &);
public:

Connection() {};

virtual~Connection() {};

virtualvoidclearWarnings() = 0;

virtual Statement *createStatement() = 0;

virtualvoidclose() = 0;

virtualvoidcommit() = 0;

virtualboolgetAutoCommit() = 0;

virtual sql::SQLString getCatalog() = 0;

virtual Driver *getDriver() = 0;

virtual sql::SQLString getSchema() = 0;

virtual sql::SQLString getClientInfo() = 0;

virtualvoidgetClientOption(const sql::SQLString & optionName, void * optionValue) = 0;

virtual sql::SQLString getClientOption(const sql::SQLString & optionName) = 0;

virtual DatabaseMetaData * getMetaData() = 0;

virtual enum_transaction_isolation getTransactionIsolation() = 0;

virtualconst SQLWarning * getWarnings() = 0;

virtualboolisClosed() = 0;

virtualboolisReadOnly() = 0;

virtualboolisValid() = 0;

virtualboolreconnect() = 0;

virtual sql::SQLString nativeSQL(const sql::SQLString& sql) = 0;

virtual PreparedStatement * prepareStatement(const sql::SQLString& sql) = 0;

virtual PreparedStatement * prepareStatement(const sql::SQLString& sql, int autoGeneratedKeys) = 0;

virtual PreparedStatement * prepareStatement(const sql::SQLString& sql, int* columnIndexes) = 0;

virtual PreparedStatement * prepareStatement(const sql::SQLString& sql, int resultSetType, int resultSetConcurrency) = 0;

virtual PreparedStatement * prepareStatement(const sql::SQLString& sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) = 0;

virtual PreparedStatement * prepareStatement(const sql::SQLString& sql, sql::SQLString columnNames[]) = 0;

virtualvoidreleaseSavepoint(Savepoint * savepoint) = 0;

virtualvoidrollback() = 0;

virtualvoidrollback(Savepoint * savepoint) = 0;

virtualvoidsetAutoCommit(bool autoCommit) = 0;

virtualvoidsetCatalog(const sql::SQLString& catalog) = 0;

virtualvoidsetSchema(const sql::SQLString& catalog) = 0;

virtual sql::Connection * setClientOption(const sql::SQLString & optionName, constvoid * optionValue) = 0;

virtual sql::Connection * setClientOption(const sql::SQLString & optionName, const sql::SQLString & optionValue) = 0;

virtualvoidsetHoldability(int holdability) = 0;

virtualvoidsetReadOnly(bool readOnly) = 0;

virtual Savepoint * setSavepoint() = 0;

virtual Savepoint * setSavepoint(const sql::SQLString& name) = 0;

virtualvoidsetTransactionIsolation(enum_transaction_isolation level) = 0;

/* virtual void setTypeMap(Map map) = 0; */
};

} /* namespace sql */

#endif// _SQL_CONNECTION_H_