MySQL  8.0.28
Source Code Documentation
client_priv.h
Go to the documentation of this file.
1 /*
2  Copyright (c) 2001, 2021, Oracle and/or its affiliates.
3 
4  This program is free software; you can redistribute it and/or modify
5  it under the terms of the GNU General Public License, version 2.0,
6  as published by the Free Software Foundation.
7 
8  This program is also distributed with certain software (including
9  but not limited to OpenSSL) that is licensed under separate terms,
10  as designated in a particular file or component or in included license
11  documentation. The authors of MySQL hereby grant you an additional
12  permission to link the program and your derivative works with the
13  separately licensed software that they have included with MySQL.
14 
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  GNU General Public License, version 2.0, for more details.
19 
20  You should have received a copy of the GNU General Public License
21  along with this program; if not, write to the Free Software
22  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24 
25 #ifndef CLIENT_PRIV_INCLUDED
26 #define CLIENT_PRIV_INCLUDED
27 
28 /* Common defines for all clients */
29 
30 #include <mysql.h>
31 
32 #include "errmsg.h"
33 #include "m_string.h"
34 #include "my_getopt.h"
35 #include "my_sys.h"
36 
37 #ifndef WEXITSTATUS
38 #ifdef _WIN32
39 #define WEXITSTATUS(stat_val) (stat_val)
40 #else
41 #define WEXITSTATUS(stat_val) ((unsigned)(stat_val) >> 8)
42 #endif
43 #endif
44 
183  /* Add new option above this */
185 };
186 
187 /**
188  First mysql version supporting the information schema.
189 */
190 #define FIRST_INFORMATION_SCHEMA_VERSION 50003
191 
192 /**
193  Name of the information schema database.
194 */
195 #define INFORMATION_SCHEMA_DB_NAME "information_schema"
196 
197 /**
198  First mysql version supporting the performance schema.
199 */
200 #define FIRST_PERFORMANCE_SCHEMA_VERSION 50503
201 
202 /**
203  Name of the performance schema database.
204 */
205 #define PERFORMANCE_SCHEMA_DB_NAME "performance_schema"
206 
207 /**
208  First mysql version supporting the sys schema.
209 */
210 #define FIRST_SYS_SCHEMA_VERSION 50707
211 
212 /**
213  Name of the sys schema database.
214 */
215 #define SYS_SCHEMA_DB_NAME "sys"
216 
217 /**
218  Client deprecation warnings
219 */
220 #define CLIENT_WARN_DEPRECATED_NO_REPLACEMENT_MSG(opt) \
221  opt " is deprecated and will be removed in a future version\n"
222 
223 #define CLIENT_WARN_DEPRECATED_MSG(opt, new_opt) \
224  opt " is deprecated and will be removed in a future version. " \
225  "Use " new_opt " instead.\n"
226 
227 #define CLIENT_WARN_DEPRECATED_NO_REPLACEMENT(opt) \
228  printf("WARNING: " CLIENT_WARN_DEPRECATED_NO_REPLACEMENT_MSG(opt))
229 
230 #define CLIENT_WARN_DEPRECATED(opt, new_opt) \
231  printf("WARNING: " CLIENT_WARN_DEPRECATED_MSG(opt, new_opt))
232 #endif
options_client
Definition: client_priv.h:45
@ OPT_CREATE_SLAP_SCHEMA
Definition: client_priv.h:114
@ OPT_MYSQLDUMP_SLAVE_DATA_DEPRECATED
Definition: client_priv.h:181
@ OPT_MYSQLDUMP_REPLICA_DATA
Definition: client_priv.h:116
@ OPT_O_ENC
Definition: client_priv.h:60
@ OPT_SELECT_LIMIT
Definition: client_priv.h:71
@ OPT_AUTO_REPAIR
Definition: client_priv.h:51
@ OPT_SERVER_PUBLIC_KEY
Definition: client_priv.h:167
@ OPT_DROP_DATABASE
Definition: client_priv.h:112
@ OPT_BASE64_OUTPUT_MODE
Definition: client_priv.h:137
@ OPT_BINARY_MODE
Definition: client_priv.h:158
@ OPT_STOP_DATETIME
Definition: client_priv.h:98
@ OPT_ERROR_LOG_FILE
Definition: client_priv.h:146
@ OPT_FIX_DB_NAMES
Definition: client_priv.h:140
@ OPT_NET_BUFFER_LENGTH
Definition: client_priv.h:70
@ OPT_MYSQL_BINARY_AS_HEX
Definition: client_priv.h:175
@ OPT_SHUTDOWN_TIMEOUT
Definition: client_priv.h:79
@ OPT_IGN_LINES
Definition: client_priv.h:84
@ OPT_LTB
Definition: client_priv.h:58
@ OPT_MYSQLDUMP_INCLUDE_SOURCE_HOST_PORT
Definition: client_priv.h:117
@ OPT_ORDER_BY_PRIMARY
Definition: client_priv.h:101
@ OPT_SLAP_AUTO_GENERATE_UNIQUE_QUERY_NUM
Definition: client_priv.h:128
@ OPT_SSL_CIPHER
Definition: client_priv.h:78
@ OPT_IMPORT_USE_THREADS
Definition: client_priv.h:107
@ OPT_COMPATIBLE
Definition: client_priv.h:90
@ OPT_ESC
Definition: client_priv.h:61
@ OPT_SSL_CRL
Definition: client_priv.h:159
@ OPT_LOCAL_INFILE
Definition: client_priv.h:80
@ OPT_DUMP_DATE
Definition: client_priv.h:148
@ OPT_HEXBLOB
Definition: client_priv.h:100
@ OPT_MYSQL_LOCK_DIRECTORY
Definition: client_priv.h:105
@ OPT_MAX_CLIENT_OPTION
Definition: client_priv.h:184
@ OPT_MYSQLBINLOG_INCLUDE_GTIDS
Definition: client_priv.h:162
@ OPT_TZ_UTC
Definition: client_priv.h:113
@ OPT_SLAP_AUTO_GENERATE_ADD_AUTO
Definition: client_priv.h:123
@ OPT_PROMPT
Definition: client_priv.h:83
@ OPT_RAW_OUTPUT
Definition: client_priv.h:153
@ OPT_SSL_CERT
Definition: client_priv.h:75
@ OPT_SHOW_WARNINGS
Definition: client_priv.h:111
@ OPT_SSL_SSL
Definition: client_priv.h:73
@ OPT_DELETE_SOURCE_LOGS
Definition: client_priv.h:81
@ OPT_OPTIMIZE
Definition: client_priv.h:56
@ OPT_DELIMITER
Definition: client_priv.h:92
@ OPT_SIGINT_IGNORE
Definition: client_priv.h:99
@ OPT_COMPACT
Definition: client_priv.h:82
@ OPT_WRITE_BINLOG
Definition: client_priv.h:147
@ OPT_TLS_CIPHERSUITES
Definition: client_priv.h:174
@ OPT_SET_CHARSET
Definition: client_priv.h:94
@ OPT_SLAP_AUTO_GENERATE_GUID_PRIMARY
Definition: client_priv.h:124
@ OPT_SLAP_POST_SYSTEM
Definition: client_priv.h:132
@ OPT_DEFAULT_PLUGIN
Definition: client_priv.h:152
@ OPT_TABLES
Definition: client_priv.h:62
@ OPT_REWRITE_DB
Definition: client_priv.h:166
@ OPT_PLUGIN_DIR
Definition: client_priv.h:150
@ OPT_SLAP_PRE_QUERY
Definition: client_priv.h:129
@ OPT_DEFAULT_AUTH
Definition: client_priv.h:151
@ OPT_TLS_VERSION
Definition: client_priv.h:170
@ OPT_MYSQLBINLOG_EXCLUDE_GTIDS
Definition: client_priv.h:163
@ OPT_DEBUG_CHECK
Definition: client_priv.h:144
@ OPT_OPEN_FILES_LIMIT
Definition: client_priv.h:93
@ OPT_SLAP_PRE_SYSTEM
Definition: client_priv.h:131
@ OPT_SLAP_DETACH
Definition: client_priv.h:134
@ OPT_TRANSACTION
Definition: client_priv.h:85
@ OPT_TEE
Definition: client_priv.h:49
@ OPT_MYSQLDUMP_INCLUDE_MASTER_HOST_PORT_DEPRECATED
Definition: client_priv.h:182
@ OPT_DEBUG_INFO
Definition: client_priv.h:143
@ OPT_MYSQL_ONLY_PRINT
Definition: client_priv.h:104
@ OPT_USE_THREADS
Definition: client_priv.h:106
@ OPT_FRM
Definition: client_priv.h:88
@ OPT_START_DATETIME
Definition: client_priv.h:97
@ OPT_MYSQLDUMP_REPLICA_APPLY
Definition: client_priv.h:115
@ OPT_TRIGGERS
Definition: client_priv.h:103
@ OPT_ENC
Definition: client_priv.h:59
@ OPT_SLAP_AUTO_GENERATE_SECONDARY_INDEXES
Definition: client_priv.h:126
@ OPT_MYSQLBINLOG_SKIP_GTIDS
Definition: client_priv.h:161
@ OPT_SOURCE_DATA
Definition: client_priv.h:63
@ OPT_SLAP_AUTO_GENERATE_UNIQUE_WRITE_NUM
Definition: client_priv.h:127
@ OPT_MAX_JOIN_SIZE
Definition: client_priv.h:72
@ OPT_LINE_NUMBERS
Definition: client_priv.h:66
@ OPT_ENABLE_CLEARTEXT_PLUGIN
Definition: client_priv.h:168
@ OPT_RECONNECT
Definition: client_priv.h:91
@ OPT_MYSQL_NUMBER_OF_QUERY
Definition: client_priv.h:108
@ OPT_MYSQLDUMP_SLAVE_APPLY_DEPRECATED
Definition: client_priv.h:179
@ OPT_WAIT_SERVER_ID
Definition: client_priv.h:154
@ OPT_STOP_POSITION
Definition: client_priv.h:96
@ OPT_SSL_CRLPATH
Definition: client_priv.h:160
@ OPT_COLUMN_NAMES
Definition: client_priv.h:67
@ OPT_SLAP_AUTO_GENERATE_WRITE_NUM
Definition: client_priv.h:122
@ OPT_CONFIG_ALL
Definition: client_priv.h:165
@ OPT_MASTER_DATA_DEPRECATED
Definition: client_priv.h:178
@ OPT_COUNT
Definition: client_priv.h:102
@ OPT_SSL_MODE
Definition: client_priv.h:171
@ OPT_STOP_NEVER
Definition: client_priv.h:155
@ OPT_FTB
Definition: client_priv.h:57
@ OPT_LOAD_DATA_LOCAL_DIR
Definition: client_priv.h:176
@ OPT_READ_FROM_REMOTE_MASTER_DEPRECATED
Definition: client_priv.h:177
@ OPT_KEYWORDS
Definition: client_priv.h:55
@ OPT_CHARSETS_DIR
Definition: client_priv.h:46
@ OPT_AUTO_VERTICAL_OUTPUT
Definition: client_priv.h:142
@ OPT_MAX_ALLOWED_PACKET
Definition: client_priv.h:69
@ OPT_SLAP_COMMIT
Definition: client_priv.h:133
@ OPT_SSL_CAPATH
Definition: client_priv.h:77
@ OPT_DEFAULT_CHARSET
Definition: client_priv.h:47
@ OPT_SSL_VERIFY_SERVER_CERT
Definition: client_priv.h:141
@ OPT_BINLOG_ROWS_EVENT_MAX_SIZE
Definition: client_priv.h:156
@ OPT_SSL_FIPS_MODE
Definition: client_priv.h:173
@ OPT_LOW_PRIORITY
Definition: client_priv.h:50
@ OPT_MYSQL_PROTOCOL
Definition: client_priv.h:86
@ OPT_SLAP_NO_DROP
Definition: client_priv.h:135
@ OPT_LOCKS
Definition: client_priv.h:54
@ OPT_FIX_TABLE_NAMES
Definition: client_priv.h:139
@ OPT_CONNECTION_SERVER_ID
Definition: client_priv.h:169
@ OPT_SSL_KEY
Definition: client_priv.h:74
@ OPT_SSL_CA
Definition: client_priv.h:76
@ OPT_PRINT_TABLE_METADATA
Definition: client_priv.h:172
@ OPT_SLAP_AUTO_GENERATE_SQL_LOAD_TYPE
Definition: client_priv.h:121
@ OPT_AUTOCOMMIT
Definition: client_priv.h:64
@ OPT_DELETE_MASTER_LOGS_DEPRECATED
Definition: client_priv.h:180
@ OPT_IGNORE_TABLE
Definition: client_priv.h:109
@ OPT_SLAP_CSV
Definition: client_priv.h:119
@ OPT_SERVER_ID
Definition: client_priv.h:138
@ OPT_SLAP_CREATE_STRING
Definition: client_priv.h:120
@ OPT_MYSQL_REPLACE_INTO
Definition: client_priv.h:136
@ OPT_PAGER
Definition: client_priv.h:48
@ OPT_MYSQLDUMP_IGNORE_ERROR
Definition: client_priv.h:118
@ OPT_SLAP_AUTO_GENERATE_EXECUTE_QUERIES
Definition: client_priv.h:125
@ OPT_AUTO_REHASH
Definition: client_priv.h:65
@ OPT_REMOTE_PROTO
Definition: client_priv.h:164
@ OPT_INSERT_IGNORE
Definition: client_priv.h:110
@ OPT_INIT_COMMAND
Definition: client_priv.h:149
@ OPT_CONNECT_TIMEOUT
Definition: client_priv.h:68
@ OPT_HISTIGNORE
Definition: client_priv.h:157
@ OPT_SET_GTID_PURGED
Definition: client_priv.h:95
@ OPT_DROP
Definition: client_priv.h:53
@ OPT_COLUMN_TYPES
Definition: client_priv.h:145
@ OPT_SKIP_OPTIMIZATION
Definition: client_priv.h:89
@ OPT_SLAP_POST_QUERY
Definition: client_priv.h:130
@ OPT_SHARED_MEMORY_BASE_NAME
Definition: client_priv.h:87
@ OPT_COMPRESS
Definition: client_priv.h:52
Error messages for MySQL clients.
Common header for many mysys elements.
This file defines the client API to MySQL and also the ABI of the dynamically linked libmysqlclient.