common_constants.h

/*
 * Copyright (c) 2015, 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 MYSQL_COMMON_CONSTANTS_H
#define MYSQL_COMMON_CONSTANTS_H
 
#include "version_info.h"
 
#define DEFAULT_MYSQL_PORT  3306
#define DEFAULT_MYSQLX_PORT 33060
 
// ----------------------------------------------------------------------------
 
/*
  Common constants
  ================
 
  Warning: Values of these constants are part of the public API. Changing them
  is a non backward compatible API change.
 
  Note: Value of 0 is reserved for special uses and thus constant values
  are always > 0.
 
  Note: the empty END_LIST macro at the end of list macros helps Doxygen
  correctly interpret documentation for the list item.
*/
 
#define OPT_STR(X,Y,N) X##_str(Y,N)
#define OPT_BOOL(X,Y,N) X##_bool(Y,N)
#define OPT_NUM(X,Y,N) X##_num(Y,N)
#define OPT_ANY(X,Y,N) X##_any(Y,N)
 
 
#undef END_LIST
#define END_LIST
 
 
#define CLIENT_OPTION_LIST(x)                                                  \
  OPT_BOOL(x,POOLING,1)    \
  OPT_NUM(x,POOL_MAX_SIZE,2)          \
  OPT_NUM(x,POOL_QUEUE_TIMEOUT,3)                                      \
  OPT_NUM(x,POOL_MAX_IDLE_TIME,4)                       \
  END_LIST
 
 
#define SESSION_OPTION_LIST(x)                                               \
  OPT_STR(x,URI,1)                           \
                  \
  OPT_STR(x,HOST,2)                                                          \
  OPT_NUM(x,PORT,3)                       \
                                                                         \
  OPT_NUM(x,PRIORITY,4)                                                      \
  OPT_STR(x,USER,5)                                         \
  OPT_STR(x,PWD,6)                                           \
  OPT_STR(x,DB,7)                                    \
 \
  OPT_ANY(x,SSL_MODE,8)                                                      \
              \
  OPT_STR(x,SSL_CA,9)                                                        \
 \
  OPT_ANY(x,AUTH,10)                                                        \
  OPT_STR(x,SOCKET,11)                              \
 \
  OPT_NUM(x,CONNECT_TIMEOUT,12)                                              \
 \
  OPT_STR(x,CONNECTION_ATTRIBUTES,13)                                        \
                                                                         \
  OPT_STR(x,TLS_VERSIONS, 14)                                                \
                                                                         \
  OPT_STR(x,TLS_CIPHERSUITES, 15)                                            \
                                                                        \
  OPT_BOOL(x, DNS_SRV, 16)                                                  \
  OPT_ANY(x,COMPRESSION,17)            \
                                                                        \
  OPT_STR(x,COMPRESSION_ALGORITHMS,18)                                      \
              \
  OPT_STR(x,SSL_CAPATH,19)                                                 \
          \
  OPT_STR(x,SSL_CRL,20)                                                     \
                                                                         \
  OPT_STR(x,SSL_CRLPATH,21)                                                 \
 \
  OPT_NUM(x,READ_TIMEOUT,22)                                              \
 \
  OPT_NUM(x,WRITE_TIMEOUT,23)                                             \
  END_LIST
 
 
/*
  Names for options supported in the query part of a connection string and
  how they map to session options above.
 
  Note: when adding new options to this list, also update doxygen docs
  for mysqlx::SessionSettings URL ctor (include\mysqlx\devapi\settings.h) and
  for mysqlx_get_session_from_url() (include\mysqlx\xapi.h).
*/
 
#define URI_OPTION_LIST(X)  \
  X("ssl-mode", SSL_MODE)   \
  X("ssl-ca", SSL_CA)       \
  X("ssl-capath", SSL_CAPATH)       \
  X("ssl-crl", SSL_CRL)       \
  X("ssl-crlpath", SSL_CRLPATH)       \
  X("auth", AUTH)           \
  X("connect-timeout", CONNECT_TIMEOUT) \
  X("connection-attributes",CONNECTION_ATTRIBUTES)\
  X("tls-version", TLS_VERSIONS) \
  X("tls-versions", TLS_VERSIONS) \
  X("tls-ciphersuites", TLS_CIPHERSUITES) \
  X("compression", COMPRESSION) \
  X("compression-algorithms", COMPRESSION_ALGORITHMS) \
  X("read-timeout", READ_TIMEOUT) \
  X("write-timeout", WRITE_TIMEOUT) \
  END_LIST
 
 
#define SSL_MODE_LIST(x) \
  x(DISABLED,1)         \
  x(REQUIRED,2)         \
  x(VERIFY_CA,3)        \
  x(VERIFY_IDENTITY,4) \
  END_LIST
 
 
#define AUTH_METHOD_LIST(x)\
  x(PLAIN,1)        \
  x(MYSQL41,2)      \
  x(EXTERNAL,3)     \
  x(SHA256_MEMORY,4)   \
  END_LIST
 
/*
  Types that can be reported by MySQL server.
*/
 
#define RESULT_TYPE_LIST(X) \
  X(BIT,        1)   \
  X(TINYINT,    2)   \
  X(SMALLINT,   3)   \
  X(MEDIUMINT,  4)   \
  X(INT,        5)   \
  X(BIGINT,     6)   \
  X(FLOAT,      7)   \
  X(DECIMAL,    8)   \
  X(DOUBLE,     9)   \
  X(JSON,       10)  \
  X(STRING,     11)  \
  X(BYTES,      12)  \
  X(TIME,       13)  \
  X(DATE,       14)  \
  X(DATETIME,   15)  \
  X(TIMESTAMP,  16)  \
  X(SET,        17)  \
  X(ENUM,       18)  \
  X(GEOMETRY,   19)  \
  END_LIST
 
 
/*
  Check options for an updatable view.
  @see https://dev.mysql.com/doc/refman/en/view-check-option.html
*/
 
#define VIEW_CHECK_OPTION_LIST(x) \
  x(CASCADED,1) \
  x(LOCAL,2) \
  END_LIST
 
/*
  Algorithms used to process views.
  @see https://dev.mysql.com/doc/refman/en/view-algorithms.html
*/
 
#define VIEW_ALGORITHM_LIST(x) \
  x(UNDEFINED,1) \
  x(MERGE,2) \
  x(TEMPTABLE,3) \
  END_LIST
 
/*
  View security settings.
  @see https://dev.mysql.com/doc/refman/en/stored-programs-security.html
*/
 
#define VIEW_SECURITY_LIST(x) \
  x(DEFINER,1) \
  x(INVOKER,2) \
  END_LIST
 
 
#define LOCK_MODE_LIST(X) \
  X(SHARED,1)     \
  X(EXCLUSIVE,2)  \
  END_LIST
 
#define LOCK_CONTENTION_LIST(X) \
  X(DEFAULT,0)  \
  X(NOWAIT,1)  \
  X(SKIP_LOCKED,2)  \
  END_LIST
 
#define COMPRESSION_MODE_LIST(x) \
  x(DISABLED,1)         \
  x(PREFERRED,2)        \
  x(REQUIRED,3)         \
  END_LIST
 
// ----------------------------------------------------------------------------
 
 
#define COLLECTION_OPTIONS_OPTION(X)\
  X(REUSE,1)  \
  X(VALIDATION,2)  \
  END_LIST
 
#define COLLECTION_VALIDATION_OPTION(X)\
  X(SCHEMA,1)  \
  X(LEVEL,2)  \
  END_LIST
 
 
  // Schema Validation Level
 
//Windows defines STRICT as a macro... undefine it
#ifdef STRICT
  #undef STRICT
#endif
 
#define COLLECTION_VALIDATION_LEVEL(X)\
  X(OFF,1)  \
  X(STRICT,2)  \
  END_LIST
 
 
 
#endif