forked from mysql/mysql-server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmysql_com.h
1306 lines (1043 loc) · 41.1 KB
/
mysql_com.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright (c) 2000, 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 C Driver for MySQL (Connector/C), is also subject to the
Universal FOSS Exception, version 1.0, a copy of which can be found at
http://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 */
/**
@file include/mysql_com.h
Common definition between mysql server & client.
*/
#ifndef _mysql_com_h
#define _mysql_com_h
#ifndef MYSQL_ABI_CHECK
#include <stdbool.h>
#include <stdint.h>
#endif
#include "my_command.h"
#include "my_compress.h"
/*
We need a definition for my_socket. On the client, <mysql.h> already provides
it, but on the server side, we need to get it from a header.
*/
#ifndef my_socket_defined
#include "my_io.h"
#include "mysql/components/services/bits/my_io_bits.h"
#endif
#ifndef MYSQL_ABI_CHECK
#include <stdbool.h>
#endif
#define SYSTEM_CHARSET_MBMAXLEN 3
#define FILENAME_CHARSET_MBMAXLEN 5
#define NAME_CHAR_LEN 64 /**< Field/table name length */
#define PARTITION_EXPR_CHAR_LEN \
2048 /**< Maximum expression length in chars \
*/
#define USERNAME_CHAR_LENGTH 32
#define USERNAME_CHAR_LENGTH_STR "32"
#ifndef NAME_LEN
#define NAME_LEN (NAME_CHAR_LEN * SYSTEM_CHARSET_MBMAXLEN)
#endif
#define USERNAME_LENGTH (USERNAME_CHAR_LENGTH * SYSTEM_CHARSET_MBMAXLEN)
#define CONNECT_STRING_MAXLEN 1024
#define MYSQL_AUTODETECT_CHARSET_NAME "auto"
#define SERVER_VERSION_LENGTH 60
#define SQLSTATE_LENGTH 5
/*
In FIDO terminology, relying party is the server where required services are
running. Relying party ID is unique name given to server.
*/
#define RELYING_PARTY_ID_LENGTH 255
/* Length of random salt sent during fido registration */
#define CHALLENGE_LENGTH 32
/* Maximum authentication factors server supports */
#define MAX_AUTH_FACTORS 3
/**
Maximum length of comments
pre 5.6: 60 characters
*/
#define TABLE_COMMENT_INLINE_MAXLEN 180
#define TABLE_COMMENT_MAXLEN 2048
#define COLUMN_COMMENT_MAXLEN 1024
#define INDEX_COMMENT_MAXLEN 1024
#define TABLE_PARTITION_COMMENT_MAXLEN 1024
#define TABLESPACE_COMMENT_MAXLEN 2048
/**
Maximum length of protocol packet.
@ref page_protocol_basic_ok_packet length limit also restricted to this value
as any length greater than this value will have first byte of
@ref page_protocol_basic_ok_packet to be 254 thus does not
provide a means to identify if this is @ref page_protocol_basic_ok_packet or
@ref page_protocol_basic_eof_packet.
*/
#define MAX_PACKET_LENGTH (256L * 256L * 256L - 1)
#define LOCAL_HOST "localhost"
#define LOCAL_HOST_NAMEDPIPE "."
#if defined(_WIN32)
#define MYSQL_NAMEDPIPE "MySQL"
#define MYSQL_SERVICENAME "MySQL"
#endif /* _WIN32 */
/** The length of the header part for each generated column in the .frm file.*/
#define FRM_GCOL_HEADER_SIZE 4
/**
Maximum length of the expression statement defined for generated columns.
*/
#define GENERATED_COLUMN_EXPRESSION_MAXLEN 65535 - FRM_GCOL_HEADER_SIZE
/**
Length of random string sent by server on handshake; this is also length of
obfuscated password, received from client
*/
#define SCRAMBLE_LENGTH 20
#define AUTH_PLUGIN_DATA_PART_1_LENGTH 8
/** length of password stored in the db: new passwords are preceded with '*'*/
#define SCRAMBLED_PASSWORD_CHAR_LENGTH (SCRAMBLE_LENGTH * 2 + 1)
/**
@defgroup group_cs_column_definition_flags Column Definition Flags
@ingroup group_cs
@brief Values for the flags bitmask used by ::Send_field:flags
Currently need to fit into 32 bits.
Each bit represents an optional feature of the protocol.
Both the client and the server are sending these.
The intersection of the two determines what optional parts of the
protocol will be used.
*/
/**
@addtogroup group_cs_column_definition_flags
@{
*/
#define NOT_NULL_FLAG 1 /**< Field can't be NULL */
#define PRI_KEY_FLAG 2 /**< Field is part of a primary key */
#define UNIQUE_KEY_FLAG 4 /**< Field is part of a unique key */
#define MULTIPLE_KEY_FLAG 8 /**< Field is part of a key */
#define BLOB_FLAG 16 /**< Field is a blob */
#define UNSIGNED_FLAG 32 /**< Field is unsigned */
#define ZEROFILL_FLAG 64 /**< Field is zerofill */
#define BINARY_FLAG 128 /**< Field is binary */
/* The following are only sent to new clients */
#define ENUM_FLAG 256 /**< field is an enum */
#define AUTO_INCREMENT_FLAG 512 /**< field is a autoincrement field */
#define TIMESTAMP_FLAG 1024 /**< Field is a timestamp */
#define SET_FLAG 2048 /**< field is a set */
#define NO_DEFAULT_VALUE_FLAG 4096 /**< Field doesn't have default value */
#define ON_UPDATE_NOW_FLAG 8192 /**< Field is set to NOW on UPDATE */
#define PART_KEY_FLAG 16384 /**< Intern; Part of some key */
#define NUM_FLAG 32768 /**< Field is num (for clients) */
#define UNIQUE_FLAG 65536 /**< Intern: Used by sql_yacc */
#define BINCMP_FLAG 131072 /**< Intern: Used by sql_yacc */
#define GET_FIXED_FIELDS_FLAG \
(1 << 18) /**< Used to get fields in item tree \
*/
#define FIELD_IN_PART_FUNC_FLAG (1 << 19) /**< Field part of partition func */
/**
Intern: Field in TABLE object for new version of altered table,
which participates in a newly added index.
*/
#define FIELD_IN_ADD_INDEX (1 << 20)
#define FIELD_IS_RENAMED (1 << 21) /**< Intern: Field is being renamed */
#define FIELD_FLAGS_STORAGE_MEDIA 22 /**< Field storage media, bit 22-23 */
#define FIELD_FLAGS_STORAGE_MEDIA_MASK (3 << FIELD_FLAGS_STORAGE_MEDIA)
#define FIELD_FLAGS_COLUMN_FORMAT 24 /**< Field column format, bit 24-25 */
#define FIELD_FLAGS_COLUMN_FORMAT_MASK (3 << FIELD_FLAGS_COLUMN_FORMAT)
#define FIELD_IS_DROPPED (1 << 26) /**< Intern: Field is being dropped */
#define EXPLICIT_NULL_FLAG \
(1 << 27) /**< Field is explicitly specified as \
NULL by the user */
#define GROUP_FLAG \
(1 << 28) /**< Intern: Group field. Transient use in \
create_tmp_table */
/** Field will not be loaded in secondary engine. */
#define NOT_SECONDARY_FLAG (1 << 29)
/** Field is explicitly marked as invisible by the user. */
#define FIELD_IS_INVISIBLE (1 << 30)
/** @}*/
/**
@defgroup group_cs_com_refresh_flags COM_REFRESH Flags
@ingroup group_cs
@brief Values for the `sub_command` in ::COM_REFRESH
Currently the protocol carries only 8 bits of these flags.
The rest (8-end) are used only internally in the server.
*/
/**
@addtogroup group_cs_com_refresh_flags
@{
*/
#define REFRESH_GRANT 1 /**< Refresh grant tables, FLUSH PRIVILEGES */
#define REFRESH_LOG 2 /**< Start on new log file, FLUSH LOGS */
#define REFRESH_TABLES 4 /**< close all tables, FLUSH TABLES */
#define UNUSED_8 \
8 /**< Previously REFRESH_HOSTS but not used anymore. Use TRUNCATE TABLE \
performance_schema.host_cache instead */
#define REFRESH_STATUS 16 /**< Flush status variables, FLUSH STATUS */
#define UNUSED_32 32 /**< Removed. Used to be flush thread cache */
#define REFRESH_REPLICA \
64 /**< Reset source info and restart replica \
thread, RESET REPLICA */
#define REFRESH_SOURCE \
128 /**< Remove all bin logs in the index \
and truncate the index. Also resets \
GTID information. Command: \
RESET BINARY LOGS AND GTIDS */
#define REFRESH_ERROR_LOG 256 /**< Rotate only the error log */
#define REFRESH_ENGINE_LOG 512 /**< Flush all storage engine logs */
#define REFRESH_BINARY_LOG 1024 /**< Flush the binary log */
#define REFRESH_RELAY_LOG 2048 /**< Flush the relay log */
#define REFRESH_GENERAL_LOG 4096 /**< Flush the general log */
#define REFRESH_SLOW_LOG 8192 /**< Flush the slow query log */
#define REFRESH_READ_LOCK 16384 /**< Lock tables for read. */
/**
Wait for an impending flush before closing the tables.
@sa REFRESH_READ_LOCK, handle_reload_request, close_cached_tables
*/
#define REFRESH_FAST 32768
#define REFRESH_USER_RESOURCES \
0x80000L /** FLUSH RESOURCES. @sa ::reset_mqh \
*/
#define REFRESH_FOR_EXPORT 0x100000L /** FLUSH TABLES ... FOR EXPORT */
#define REFRESH_OPTIMIZER_COSTS 0x200000L /** FLUSH OPTIMIZER_COSTS */
#define REFRESH_PERSIST 0x400000L /** RESET PERSIST */
/** @}*/
/**
@defgroup group_cs_capabilities_flags Capabilities Flags
@ingroup group_cs
@brief Values for the capabilities flag bitmask used by the MySQL protocol
Currently need to fit into 32 bits.
Each bit represents an optional feature of the protocol.
Both the client and the server are sending these.
The intersection of the two determines whast optional parts of the
protocol will be used.
*/
/**
@addtogroup group_cs_capabilities_flags
@{
*/
/**
Use the improved version of Old Password Authentication.
Not used.
@note Assumed to be set since 4.1.1.
*/
#define CLIENT_LONG_PASSWORD 1
/**
Send found rows instead of affected rows in @ref
page_protocol_basic_eof_packet
*/
#define CLIENT_FOUND_ROWS 2
/**
@brief Get all column flags
Longer flags in Protocol::ColumnDefinition320.
@todo Reference Protocol::ColumnDefinition320
Server
------
Supports longer flags.
Client
------
Expects longer flags.
*/
#define CLIENT_LONG_FLAG 4
/**
Database (schema) name can be specified on connect in Handshake Response
Packet.
@todo Reference Handshake Response Packet.
Server
------
Supports schema-name in Handshake Response Packet.
Client
------
Handshake Response Packet contains a schema-name.
@sa send_client_reply_packet()
*/
#define CLIENT_CONNECT_WITH_DB 8
#define CLIENT_NO_SCHEMA \
16 /**< DEPRECATED: Don't allow database.table.column */
/**
Compression protocol supported.
@todo Reference Compression
Server
------
Supports compression.
Client
------
Switches to Compression compressed protocol after successful authentication.
*/
#define CLIENT_COMPRESS 32
/**
Special handling of ODBC behavior.
@note No special behavior since 3.22.
*/
#define CLIENT_ODBC 64
/**
Can use LOAD DATA LOCAL.
Server
------
Enables the LOCAL INFILE request of LOAD DATA|XML.
Client
------
Will handle LOCAL INFILE request.
*/
#define CLIENT_LOCAL_FILES 128
/**
Ignore spaces before '('
Server
------
Parser can ignore spaces before '('.
Client
------
Let the parser ignore spaces before '('.
*/
#define CLIENT_IGNORE_SPACE 256
/**
New 4.1 protocol
@todo Reference the new 4.1 protocol
Server
------
Supports the 4.1 protocol.
Client
------
Uses the 4.1 protocol.
@note this value was CLIENT_CHANGE_USER in 3.22, unused in 4.0
*/
#define CLIENT_PROTOCOL_41 512
/**
This is an interactive client
Use @ref System_variables::net_wait_timeout
versus @ref System_variables::net_interactive_timeout.
Server
------
Supports interactive and noninteractive clients.
Client
------
Client is interactive.
@sa mysql_real_connect()
*/
#define CLIENT_INTERACTIVE 1024
/**
Use SSL encryption for the session
@todo Reference SSL
Server
------
Supports SSL
Client
------
Switch to SSL after sending the capability-flags.
*/
#define CLIENT_SSL 2048
/**
Client only flag. Not used.
Client
------
Do not issue SIGPIPE if network failures occur (libmysqlclient only).
@sa mysql_real_connect()
*/
#define CLIENT_IGNORE_SIGPIPE 4096
/**
Client knows about transactions
Server
------
Can send status flags in @ref page_protocol_basic_ok_packet /
@ref page_protocol_basic_eof_packet.
Client
------
Expects status flags in @ref page_protocol_basic_ok_packet /
@ref page_protocol_basic_eof_packet.
@note This flag is optional in 3.23, but always set by the server since 4.0.
@sa send_server_handshake_packet(), parse_client_handshake_packet(),
net_send_ok(), net_send_eof()
*/
#define CLIENT_TRANSACTIONS 8192
#define CLIENT_RESERVED 16384 /**< DEPRECATED: Old flag for 4.1 protocol */
#define CLIENT_RESERVED2 \
32768 /**< DEPRECATED: Old flag for 4.1 authentication \
CLIENT_SECURE_CONNECTION */
/**
Enable/disable multi-stmt support
Also sets @ref CLIENT_MULTI_RESULTS. Currently not checked anywhere.
Server
------
Can handle multiple statements per COM_QUERY and COM_STMT_PREPARE.
Client
-------
May send multiple statements per COM_QUERY and COM_STMT_PREPARE.
@note Was named ::CLIENT_MULTI_QUERIES in 4.1.0, renamed later.
Requires
--------
::CLIENT_PROTOCOL_41
@todo Reference COM_QUERY and COM_STMT_PREPARE
*/
#define CLIENT_MULTI_STATEMENTS (1UL << 16)
/**
Enable/disable multi-results
Server
------
Can send multiple resultsets for COM_QUERY.
Error if the server needs to send them and client
does not support them.
Client
-------
Can handle multiple resultsets for COM_QUERY.
Requires
--------
::CLIENT_PROTOCOL_41
@sa mysql_execute_command(), sp_head::MULTI_RESULTS
*/
#define CLIENT_MULTI_RESULTS (1UL << 17)
/**
Multi-results and OUT parameters in PS-protocol.
Server
------
Can send multiple resultsets for COM_STMT_EXECUTE.
Client
------
Can handle multiple resultsets for COM_STMT_EXECUTE.
Requires
--------
::CLIENT_PROTOCOL_41
@todo Reference COM_STMT_EXECUTE and PS-protocol
@sa Protocol_binary::send_out_parameters
*/
#define CLIENT_PS_MULTI_RESULTS (1UL << 18)
/**
Client supports plugin authentication
Server
------
Sends extra data in Initial Handshake Packet and supports the pluggable
authentication protocol.
Client
------
Supports authentication plugins.
Requires
--------
::CLIENT_PROTOCOL_41
@todo Reference plugin authentication, Initial Handshake Packet,
Authentication plugins
@sa send_change_user_packet(), send_client_reply_packet(), run_plugin_auth(),
parse_com_change_user_packet(), parse_client_handshake_packet()
*/
#define CLIENT_PLUGIN_AUTH (1UL << 19)
/**
Client supports connection attributes
Server
------
Permits connection attributes in Protocol::HandshakeResponse41.
Client
------
Sends connection attributes in Protocol::HandshakeResponse41.
@todo Reference Protocol::HandshakeResponse41
@sa send_client_connect_attrs(), read_client_connect_attrs()
*/
#define CLIENT_CONNECT_ATTRS (1UL << 20)
/**
Enable authentication response packet to be larger than 255 bytes.
When the ability to change default plugin require that the initial password
field in the Protocol::HandshakeResponse41 paclet can be of arbitrary size.
However, the 4.1 client-server protocol limits the length of the
auth-data-field sent from client to server to 255 bytes.
The solution is to change the type of the field to a true length encoded
string and indicate the protocol change
with this client capability flag.
Server
------
Understands length-encoded integer for auth response data in
Protocol::HandshakeResponse41.
Client
------
Length of auth response data in Protocol::HandshakeResponse41
is a length-encoded integer.
@todo Reference Protocol::HandshakeResponse41
@note The flag was introduced in 5.6.6, but had the wrong value.
@sa send_client_reply_packet(), parse_client_handshake_packet(),
get_56_lenc_string(), get_41_lenc_string()
*/
#define CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA (1UL << 21)
/**
Don't close the connection for a user account with expired password.
Server
------
Announces support for expired password extension.
Client
------
Can handle expired passwords.
@todo Reference expired password
@sa MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS, disconnect_on_expired_password
ACL_USER::password_expired, check_password_lifetime(), acl_authenticate()
*/
#define CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS (1UL << 22)
/**
Capable of handling server state change information. Its a hint to the
server to include the state change information in
@ref page_protocol_basic_ok_packet.
Server
------
Can set ::SERVER_SESSION_STATE_CHANGED in the ::SERVER_STATUS_flags_enum
and send @ref sect_protocol_basic_ok_packet_sessinfo in a
@ref page_protocol_basic_ok_packet.
Client
------
Expects the server to send @ref sect_protocol_basic_ok_packet_sessinfo in
a @ref page_protocol_basic_ok_packet.
@sa enum_session_state_type, read_ok_ex(), net_send_ok(), Session_tracker,
State_tracker
*/
#define CLIENT_SESSION_TRACK (1UL << 23)
/**
Client no longer needs @ref page_protocol_basic_eof_packet and will
use @ref page_protocol_basic_ok_packet instead.
@sa net_send_ok()
Server
------
Can send OK after a Text Resultset.
Client
------
Expects an @ref page_protocol_basic_ok_packet (instead of
@ref page_protocol_basic_eof_packet) after the resultset rows of a
Text Resultset.
Background
----------
To support ::CLIENT_SESSION_TRACK, additional information must be sent after
all successful commands. Although the @ref page_protocol_basic_ok_packet is
extensible, the @ref page_protocol_basic_eof_packet is not due to the overlap
of its bytes with the content of the Text Resultset Row.
Therefore, the @ref page_protocol_basic_eof_packet in the
Text Resultset is replaced with an @ref page_protocol_basic_ok_packet.
@ref page_protocol_basic_eof_packet is deprecated as of MySQL 5.7.5.
@todo Reference Text Resultset
@sa cli_safe_read_with_ok(), read_ok_ex(), net_send_ok(), net_send_eof()
*/
#define CLIENT_DEPRECATE_EOF (1UL << 24)
/**
The client can handle optional metadata information in the resultset.
*/
#define CLIENT_OPTIONAL_RESULTSET_METADATA (1UL << 25)
/**
Compression protocol extended to support zstd compression method
This capability flag is used to send zstd compression level between
client and server provided both client and server are enabled with
this flag.
Server
------
Server sets this flag when global variable protocol-compression-algorithms
has zstd in its list of supported values.
Client
------
Client sets this flag when it is configured to use zstd compression method.
*/
#define CLIENT_ZSTD_COMPRESSION_ALGORITHM (1UL << 26)
/**
Support optional extension for query parameters into the @ref
page_protocol_com_query and @ref page_protocol_com_stmt_execute packets.
Server
------
Expects an optional part containing the query parameter set(s). Executes the
query for each set of parameters or returns an error if more than 1 set of
parameters is sent and the server can't execute it.
Client
------
Can send the optional part containing the query parameter set(s).
*/
#define CLIENT_QUERY_ATTRIBUTES (1UL << 27)
/**
Support Multi factor authentication.
Server
------
Server sends AuthNextFactor packet after every nth factor authentication
method succeeds, except the last factor authentication.
Client
------
Client reads AuthNextFactor packet sent by server and initiates next factor
authentication method.
*/
#define MULTI_FACTOR_AUTHENTICATION (1UL << 28)
/**
This flag will be reserved to extend the 32bit capabilities structure to
64bits.
*/
#define CLIENT_CAPABILITY_EXTENSION (1UL << 29)
/**
Verify server certificate.
Client only flag.
@deprecated in favor of --ssl-mode.
*/
#define CLIENT_SSL_VERIFY_SERVER_CERT (1UL << 30)
/**
Don't reset the options after an unsuccessful connect
Client only flag.
Typically passed via ::mysql_real_connect() 's client_flag parameter.
@sa mysql_real_connect()
*/
#define CLIENT_REMEMBER_OPTIONS (1UL << 31)
/** @}*/
/** a compatibility alias for CLIENT_COMPRESS */
#define CAN_CLIENT_COMPRESS CLIENT_COMPRESS
/** Gather all possible capabilities (flags) supported by the server */
#define CLIENT_ALL_FLAGS \
(CLIENT_LONG_PASSWORD | CLIENT_FOUND_ROWS | CLIENT_LONG_FLAG | \
CLIENT_CONNECT_WITH_DB | CLIENT_NO_SCHEMA | CLIENT_COMPRESS | CLIENT_ODBC | \
CLIENT_LOCAL_FILES | CLIENT_IGNORE_SPACE | CLIENT_PROTOCOL_41 | \
CLIENT_INTERACTIVE | CLIENT_SSL | CLIENT_IGNORE_SIGPIPE | \
CLIENT_TRANSACTIONS | CLIENT_RESERVED | CLIENT_RESERVED2 | \
CLIENT_MULTI_STATEMENTS | CLIENT_MULTI_RESULTS | CLIENT_PS_MULTI_RESULTS | \
CLIENT_SSL_VERIFY_SERVER_CERT | CLIENT_REMEMBER_OPTIONS | \
CLIENT_PLUGIN_AUTH | CLIENT_CONNECT_ATTRS | \
CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA | \
CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS | CLIENT_SESSION_TRACK | \
CLIENT_DEPRECATE_EOF | CLIENT_OPTIONAL_RESULTSET_METADATA | \
CLIENT_ZSTD_COMPRESSION_ALGORITHM | CLIENT_QUERY_ATTRIBUTES | \
MULTI_FACTOR_AUTHENTICATION)
/**
Switch off from ::CLIENT_ALL_FLAGS the flags that are optional and
depending on build flags.
If any of the optional flags is supported by the build it will be switched
on before sending to the client during the connection handshake.
*/
#define CLIENT_BASIC_FLAGS \
(CLIENT_ALL_FLAGS & \
~(CLIENT_SSL | CLIENT_COMPRESS | CLIENT_SSL_VERIFY_SERVER_CERT | \
CLIENT_ZSTD_COMPRESSION_ALGORITHM))
/** The status flags are a bit-field */
enum SERVER_STATUS_flags_enum {
/**
Is raised when a multi-statement transaction
has been started, either explicitly, by means
of BEGIN or COMMIT AND CHAIN, or
implicitly, by the first transactional
statement, when autocommit=off.
*/
SERVER_STATUS_IN_TRANS = 1,
SERVER_STATUS_AUTOCOMMIT = 2, /**< Server in auto_commit mode */
SERVER_MORE_RESULTS_EXISTS = 8, /**< Multi query - next query exists */
SERVER_QUERY_NO_GOOD_INDEX_USED = 16,
SERVER_QUERY_NO_INDEX_USED = 32,
/**
The server was able to fulfill the clients request and opened a
read-only non-scrollable cursor for a query. This flag comes
in reply to COM_STMT_EXECUTE and COM_STMT_FETCH commands.
Used by Binary Protocol Resultset to signal that COM_STMT_FETCH
must be used to fetch the row-data.
@todo Refify "Binary Protocol Resultset" and "COM_STMT_FETCH".
*/
SERVER_STATUS_CURSOR_EXISTS = 64,
/**
This flag is sent when a read-only cursor is exhausted, in reply to
COM_STMT_FETCH command.
*/
SERVER_STATUS_LAST_ROW_SENT = 128,
SERVER_STATUS_DB_DROPPED = 256, /**< A database was dropped */
SERVER_STATUS_NO_BACKSLASH_ESCAPES = 512,
/**
Sent to the client if after a prepared statement reprepare
we discovered that the new statement returns a different
number of result set columns.
*/
SERVER_STATUS_METADATA_CHANGED = 1024,
SERVER_QUERY_WAS_SLOW = 2048,
/**
To mark ResultSet containing output parameter values.
*/
SERVER_PS_OUT_PARAMS = 4096,
/**
Set at the same time as SERVER_STATUS_IN_TRANS if the started
multi-statement transaction is a read-only transaction. Cleared
when the transaction commits or aborts. Since this flag is sent
to clients in OK and EOF packets, the flag indicates the
transaction status at the end of command execution.
*/
SERVER_STATUS_IN_TRANS_READONLY = 8192,
/**
This status flag, when on, implies that one of the state information has
changed on the server because of the execution of the last statement.
*/
SERVER_SESSION_STATE_CHANGED = (1UL << 14)
};
/**
Server status flags that must be cleared when starting
execution of a new SQL statement.
Flags from this set are only added to the
current server status by the execution engine, but
never removed -- the execution engine expects them
to disappear automagically by the next command.
*/
#define SERVER_STATUS_CLEAR_SET \
(SERVER_QUERY_NO_GOOD_INDEX_USED | SERVER_QUERY_NO_INDEX_USED | \
SERVER_MORE_RESULTS_EXISTS | SERVER_STATUS_METADATA_CHANGED | \
SERVER_QUERY_WAS_SLOW | SERVER_STATUS_DB_DROPPED | \
SERVER_STATUS_CURSOR_EXISTS | SERVER_STATUS_LAST_ROW_SENT | \
SERVER_SESSION_STATE_CHANGED)
/** Max length of a error message. Should be kept in sync with ::ERRMSGSIZE. */
#define MYSQL_ERRMSG_SIZE 512
#define NET_READ_TIMEOUT 30 /**< Timeout on read */
#define NET_WRITE_TIMEOUT 60 /**< Timeout on write */
#define NET_WAIT_TIMEOUT 8 * 60 * 60 /**< Wait for new query */
/**
Flag used by the parser. Kill only the query and not the connection.
@sa SQLCOM_KILL, sql_kill(), LEX::type
*/
#define ONLY_KILL_QUERY 1
#ifndef MYSQL_VIO
struct Vio;
#define MYSQL_VIO struct Vio *
#endif
#define MAX_TINYINT_WIDTH 3 /**< Max width for a TINY w.o. sign */
#define MAX_SMALLINT_WIDTH 5 /**< Max width for a SHORT w.o. sign */
#define MAX_MEDIUMINT_WIDTH 8 /**< Max width for a INT24 w.o. sign */
#define MAX_INT_WIDTH 10 /**< Max width for a LONG w.o. sign */
#define MAX_BIGINT_WIDTH 20 /**< Max width for a LONGLONG */
/// Max width for a CHAR column, in number of characters
#define MAX_CHAR_WIDTH 255
/// Default width for blob in bytes @todo - align this with sizes from field.h
#define MAX_BLOB_WIDTH 16777216
#define NET_ERROR_UNSET 0 /**< No error has occurred yet */
#define NET_ERROR_SOCKET_RECOVERABLE 1 /**< Socket still usable */
#define NET_ERROR_SOCKET_UNUSABLE 2 /**< Do not use the socket */
#define NET_ERROR_SOCKET_NOT_READABLE 3 /**< Try write and close socket */
#define NET_ERROR_SOCKET_NOT_WRITABLE 4 /**< Try read and close socket */
typedef struct NET {
MYSQL_VIO vio;
unsigned char *buff, *buff_end, *write_pos, *read_pos;
my_socket fd; /* For Perl DBI/dbd */
/**
Set if we are doing several queries in one
command ( as in LOAD TABLE ... FROM MASTER ),
and do not want to confuse the client with OK at the wrong time
*/
unsigned long remain_in_buf, length, buf_length, where_b;
unsigned long max_packet, max_packet_size;
unsigned int pkt_nr, compress_pkt_nr;
unsigned int write_timeout, read_timeout, retry_count;
int fcntl;
unsigned int *return_status;
unsigned char reading_or_writing;
unsigned char save_char;
bool compress;
unsigned int last_errno;
unsigned char error;
/** Client library error message buffer. Actually belongs to struct MYSQL. */
char last_error[MYSQL_ERRMSG_SIZE];
/** Client library sqlstate buffer. Set along with the error message. */
char sqlstate[SQLSTATE_LENGTH + 1];
/**
Extension pointer, for the caller private use.
Any program linking with the networking library can use this pointer,
which is handy when private connection specific data needs to be
maintained.
The mysqld server process uses this pointer internally,
to maintain the server internal instrumentation for the connection.
*/
void *extension;
} NET;
#define packet_error (~(unsigned long)0)
/**
@addtogroup group_cs_backward_compatibility Backward compatibility
@ingroup group_cs
@{
*/
#define CLIENT_MULTI_QUERIES CLIENT_MULTI_STATEMENTS
#define FIELD_TYPE_DECIMAL MYSQL_TYPE_DECIMAL
#define FIELD_TYPE_NEWDECIMAL MYSQL_TYPE_NEWDECIMAL
#define FIELD_TYPE_TINY MYSQL_TYPE_TINY
#define FIELD_TYPE_SHORT MYSQL_TYPE_SHORT
#define FIELD_TYPE_LONG MYSQL_TYPE_LONG
#define FIELD_TYPE_FLOAT MYSQL_TYPE_FLOAT
#define FIELD_TYPE_DOUBLE MYSQL_TYPE_DOUBLE
#define FIELD_TYPE_NULL MYSQL_TYPE_NULL
#define FIELD_TYPE_TIMESTAMP MYSQL_TYPE_TIMESTAMP
#define FIELD_TYPE_LONGLONG MYSQL_TYPE_LONGLONG
#define FIELD_TYPE_INT24 MYSQL_TYPE_INT24
#define FIELD_TYPE_DATE MYSQL_TYPE_DATE
#define FIELD_TYPE_TIME MYSQL_TYPE_TIME
#define FIELD_TYPE_DATETIME MYSQL_TYPE_DATETIME
#define FIELD_TYPE_YEAR MYSQL_TYPE_YEAR
#define FIELD_TYPE_NEWDATE MYSQL_TYPE_NEWDATE
#define FIELD_TYPE_ENUM MYSQL_TYPE_ENUM
#define FIELD_TYPE_SET MYSQL_TYPE_SET
#define FIELD_TYPE_TINY_BLOB MYSQL_TYPE_TINY_BLOB
#define FIELD_TYPE_MEDIUM_BLOB MYSQL_TYPE_MEDIUM_BLOB
#define FIELD_TYPE_LONG_BLOB MYSQL_TYPE_LONG_BLOB
#define FIELD_TYPE_BLOB MYSQL_TYPE_BLOB
#define FIELD_TYPE_VAR_STRING MYSQL_TYPE_VAR_STRING
#define FIELD_TYPE_STRING MYSQL_TYPE_STRING
#define FIELD_TYPE_CHAR MYSQL_TYPE_TINY
#define FIELD_TYPE_INTERVAL MYSQL_TYPE_ENUM
#define FIELD_TYPE_GEOMETRY MYSQL_TYPE_GEOMETRY
#define FIELD_TYPE_BIT MYSQL_TYPE_BIT
/** @}*/
/**
@addtogroup group_cs_shutdown_kill_constants Shutdown/kill enums and constants
@ingroup group_cs
@sa THD::is_killable
@{
*/
#define MYSQL_SHUTDOWN_KILLABLE_CONNECT (unsigned char)(1 << 0)
#define MYSQL_SHUTDOWN_KILLABLE_TRANS (unsigned char)(1 << 1)
#define MYSQL_SHUTDOWN_KILLABLE_LOCK_TABLE (unsigned char)(1 << 2)
#define MYSQL_SHUTDOWN_KILLABLE_UPDATE (unsigned char)(1 << 3)