Debian Codegraph @

mysql-test/suite/x/r/mysqlxtest_help.result

raw
1
2 ############################################################
3 ## Test mysqlxtest executable help printout
4 ##
5
6 Copyright DATE Oracle and/or its affiliates.
7
8 Oracle is a registered trademark of Oracle Corporation and/or its
9 affiliates. Other names may be trademarks of their respective
10 owners.
11
12 mysqlxtest <options> [SCHEMA]
13 Options:
14 -f, --file=<file> Reads input from file
15 -I, --import=<dir> Reads macro files from dir; required by -->import
16 --sql=<SQL> Use SQL as input and execute it like in -->sql block
17 -e=<SQL>, --execute=<SQL> Aliases for "--sql" option
18 -n, --no-auth Skip authentication which is required by -->sql block (run mode)
19 --no-connect-attrs Skip send session connection attributes
20 --plain-auth Use PLAIN text authentication mechanism
21 --cached-auth Use SHA256_MEMORY authentication mechanism
22 --mysql41-auth Use MYSQL41 authentication mechanism
23 --using-cap-auth Get capabilities to check which
24 authentication mechanism are supported
25 --mysql57-compatible Use features that are 5.7 compatible:
26 * limit auth-mechanisms
27 -u, --user=<user> Connection user
28 -p, --password=<pass> Connection password
29 -h, --host=<host> Connection host
30 -P, --port=<port> Connection port (default:33060)
31 --ipv=<mode> Force internet protocol (default:4):
32 0 - allow system to resolve IPv6 and IPv4, for example
33 resolving of 'localhost' can return both '::1' and '127.0.0.1'
34 4 - allow system to resolve only IPv4, for example
35 resolving of 'localhost' is going to return '127.0.0.1'
36 6 - allow system to resolve only IPv6, for example
37 resolving of 'localhost' is going to return '::1'
38 -t, --timeout=<ms> I/O timeouts in milliseconds
39 --close-no-sync Do not wait for connection to be closed by server(disconnect first)
40 --schema=<schema> Default schema to connect to
41 --uri=<uri> Connection URI
42 URI takes precedence before options like: user, host, password, port
43 --socket=<file> Connection through UNIX socket
44 --use-socket Connection through UNIX socket, using default file name 'SOCK'
45 --use-socket* options take precedence before options like: uri, user,
46 host, password, port
47 --compression-mode=<mode> Enable/disable compression negotiation algorithm (default: "DISABLED")
48 "DISABLED" - do not negotiate compression
49 "PREFERRED" - if server doesn't support selected compression, continue without compression.
50 "REQUIRED" - if server doesn't support selected compression, fail the connection.
51 --compression-algorithm=<algo[,algo...]> Try to negotiate specified compression algorithm with the server (default:"DEFLATE_STREAM,LZ4_MESSAGE,ZSTD_STREAM")
52 "" - compression not enabled
53 "DEFLATE_STREAM" - zlib compression enabled
54 "LZ4_MESSAGE" - lz4f compression enabled
55 "ZSTD_STREAM" - zstd compression enabled
56 --compression-combine-mixed-messages=<0/1> If 1, server is allowed to combine different message types into a compressed message (default: 1)
57 --compression-max-combine-messages=<N> If set, the server MUST not store more than N uncompressed messages into a compressed message (default: no limit)
58 --compression-level=<N> If set, the server MUST compress messages with given level N; otherwise the server use default level (depend on compression algorithm)
59 --ssl-mode SSL configuration (default: "")
60 "" - require encryption when at last one ssl option is set, otherwise is should be disabled.
61 "PREFERRED" - encryption is optional, client tries to set it up
62 "DISABLED" - encryption is disabled
63 "REQUIRED" - encryption is required
64 "VERIFY_CA" - verify server certificate
65 "VERIFY_IDENTITY" - verify certificate issuer
66 --ssl-key X509 key in PEM format
67 --ssl-ca CA file in PEM format
68 --ssl-ca_path CA directory
69 --ssl-cert X509 cert in PEM format
70 --ssl-cipher SSL cipher to use
71 --tls-version TLS version to use
72 --ssl-fips-mode Fips mode to use
73 --connect-expired-password Allow expired password
74 --client-interactive Connect in interactive mode
75 --quiet Don't print out messages sent
76 -vVARIABLE_NAME=VALUE Set variable VARIABLE_NAME from command line
77 --fatal-errors=<0|1> Mysqlxtest is started with ignoring or stopping on fatal error (default: 1)
78 --expect-error=<error_code> Default connection must fail with specified code (default: OFF)
79 -B, --bindump Dump binary representation of messages sent, in format suitable for
80 --trace-protocol Enable X Protocol tracing
81 --history-protocol=<0|1|true|false>
82 Enable/disable X Protocol message tracing into
83 history buffer, which is printed at test failure
84 --verbose Enable extra verbose messages
85 --daemon Work as a daemon (unix only)
86 --help Show command line help
87 --help-commands Show help for input commands
88 -V, --version Show version of mysqlxtest
89
90 Only one option that changes run mode is allowed.
91
92 ############################################################
93 ## Test mysqlxtest executable help-command printout
94 ##
95 Input may be a file (or if no --file is specified, it stdin will be used)
96 The following commands may appear in the input script:
97 -->echo <text>
98 Prints the text (allows variables)
99 -->title <c><text>
100 Prints the text with an underline, using the character <c>
101 -->sql
102 Begins SQL block. SQL statements that appear will be executed and results printed (allows variables).
103 -->endsql
104 End SQL block. End a block of SQL started by -->sql
105 -->begin_compress
106 Begins block of protobuf messages to compress and
107 encapsulate inside single 'Compressed' message.
108 -->end_compress
109 End compressed message block. End a block started by -->begin_compress
110 -->macro <macroname> <argname1> ...
111 Start a block of text to be defined as a macro. Must be terminated with -->endmacro
112 -->endmacro
113 Ends a macro block
114 -->callmacro <macro> <argvalue1> ...
115 Executes the macro text, substituting argument values with the provided ones (args separated by tabs).
116 -->import <macrofile>
117 Loads macros from the specified file. The file must be in the directory specified by --import option in command line.
118 -->macro_delimiter_compress TRUE|FALSE|0|1
119 Enable/disable grouping of adjacent delimiters into
120 single one at "callmacro" command.
121 -->do_ssl_handshake
122 Execute SSL handshake, enables SSL on current connection
123 <protomsg>
124 Encodes the text format protobuf message and sends it to the server (allows variables).
125 -->enable_compression deflate_stream|lz4_message|zstd_stream [#level]
126 Enable compression
127 -->recv [quiet|<FIELD PATH>]
128 quiet - received message isn't printed
129 <FIELD PATH> - print only selected part of the message using
130 "field-path" filter:
131 * field_name1
132 * field_name1.field_name2
133 * repeated_field_name1[1].field_name1
134 -->recvresult [print-columnsinfo] [be-quiet]
135 Read and print one resultset from the server; if print-columnsinfo is present also print short columns status
136 -->recvtovar <varname> [COLUMN_NAME]
137 Read first row and first column (or column with name COLUMN_NAME) of resultset
138 and set the variable <varname>
139 -->recverror <errno>
140 Read a message and ensure that it's an error of the expected type
141 -->recvtype (<msgtype> [<msg_fied>] [<expected_field_value>] [be-quiet])|<msgid>
142 - In case when user specified <msgtype> - read one message and print it,
143 checks if its type is <msgtype>, additionally its fields may be matched.
144 Compressed messages are decompressed, thus user will receive inner X Protocol messages.
145 - In case when user specified <msgid> - read one message and print the ID,
146 checks the RAW message ID if its match <msgid>.
147 Compressed messages are not decompressed, thus their IDs may be matched against <msgid>.
148 -->recvok
149 Expect to receive 'Mysqlx.Ok' message. Works with 'expecterror' command.
150 -->recvuntil <msgtype> [do_not_show_intermediate]
151 Read messages and print them, until a msg of the specified type (or Error) is received
152 do_not_show_intermediate - if this argument is present then printing of intermediate message should be omitted
153 -->repeat <N> [<VARIABLE_NAME>]
154 Begin block of instructions that should be repeated N times
155 -->endrepeat
156 End block of instructions that should be repeated - next iteration
157 -->stmtsql <CMD>
158 Send StmtExecute with sql command
159 -->env <XVARIABLE> <ENV>
160 Assign environment variable to X variable.
161 -->stmtadmin <CMD> [json_string]
162 Send StmtExecute with admin command with given aguments (formated as json object)
163 -->system_in_background <CMD>
164 Execute application or script.
165 -->system <CMD>
166 Execute application or script
167 -->exit
168 Stops reading commands, disconnects and exits (same as <eof>/^D)
169 -->abort
170 Exit immediately, without performing cleanup
171 -->shutdown_server [timeout]
172 Kills the server associated with current session.
173 -->nowarnings/-->yeswarnings
174 Whether to print warnings generated by the statement (default no)
175 -->recvuntildisc [show-received, keep-session]...
176 Receive all messages until server drops current connection.
177 show-received - received messages are printed to standard output.
178 keep-session - session descriptor is not released in mysqlxtest, user may execute 'reconnect'.
179 -->peerdisc <MILLISECONDS> [TOLERANCE]
180 Expect that xplugin disconnects after given number of milliseconds and tolerance
181 -->sleep <SECONDS>
182 Stops execution of mysqlxtest for given number of seconds (may be fractional)
183 -->login <user> <pass> <db> <mysql41|plain|sha256_memory>]
184 Performs authentication steps (use with --no-auth)
185 -->loginerror <errno> <user> <pass> <db>
186 Performs authentication steps expecting an error (use with --no-auth)
187 -->fatalerrors/nofatalerrors
188 Whether to immediately exit on MySQL errors.
189 All expected errors are ignored.
190 -->fatalwarnings [yes|no|true|false|1|0]
191 Whether to immediately exit on MySQL warnings.
192 All expected warnings are ignored.
193 -->expectwarnings <errno>[,<errno>[,<errno>...]]
194 Expect a specific warning for the next command. Fails if warning other than specified occurred.
195 When this command was not used then all warnings are expected.
196 Works for: recvresult, SQL
197 -->expecterror <errno>[,<errno>[,<errno>...]]
198 Expect a specific error for the next command. Fails if error other than specified occurred
199 Works for: newsession, closesession, recvresult, recvok, SQL
200 -->newsession <name> <user> <pass> <db>
201 Create a new connection which is going to be authenticate using sequence of mechanisms (AUTO). Use '-' in place of the user for raw connection.
202 -->newsession_mysql41 <name> <user> <pass> <db>
203 Create a new connection which is going to be authenticate using MYSQL41 mechanism.
204 -->newsession_memory <name> <user> <pass> <db>
205 Create a new connection which is going to be authenticate using SHA256_MEMORY mechanism.
206 -->newsession_plain <name> <user> <pass> <db>
207 Create a new connection which is going to be authenticate using PLAIN mechanism.
208 -->reconnect
209 Try to restore the connection/session. Default connection is restored or session established by '-->newsession*'.
210 -->setsession <name>
211 Activate the named session
212 -->closesession [abort]
213 Close the active session (unless its the default session)
214 -->wait_for <VALUE_EXPECTED> <SQL QUERY>
215 Wait until SQL query returns value matches expected value (time limit 30 second)
216 -->assert <VALUE_EXPECTED> <OP> <VALUE_TESTED>
217 Ensure that expression described by argument parameters is true
218 <OP> can take following values:
219 "==" ensures that expected value and tested value are equal
220 "!=" ensures that expected value and tested value are not equal
221 ">=" ensures that expected value is greater or equal to tested value
222 "<=" ensures that expected value is less or equal to tested value
223 "<" ensures that expected value is less than tested value
224 ">" ensures that expected value is grater than tested value
225
226 For example: -->assert 1 < %SOME_VARIABLE%
227 -->assert %V1% == %V2%
228 -->assert_eq <VALUE_EXPECTED> <VALUE_TESTED>
229 Ensure that 'TESTED' value equals 'EXPECTED' by comparing strings lexicographically
230 -->assert_ne <VALUE_EXPECTED> <VALUE_TESTED>
231 Ensure that 'TESTED' value doesn't equals 'EXPECTED' by comparing strings lexicographically
232 -->assert_gt <VALUE_EXPECTED> <VALUE_TESTED>
233 Ensure that 'TESTED' value is greater than 'EXPECTED' (only when the both are numeric values)
234 -->assert_ge <VALUE_EXPECTED> <VALUE_TESTED>
235 Ensure that 'TESTED' value is greater or equal to 'EXPECTED' (only when the both are numeric values)
236 -->varfile <varname> <datafile>
237 Assigns the contents of the file to the named variable
238 -->varlet <varname> <value>
239 Assign the value (can be another variable) to the variable
240 -->varinc <varname> <n>
241 Increment the value of varname by n (assuming both convert to integral)
242 -->varsub <varname>
243 Add a variable to the list of variables to replace for the next recv or sql command (value is replaced by the name)
244 -->varreplace <varname> <old_txt> <new_txt>
245 Replace all occurrence of <old_txt> with <new_txt> in <varname> value.
246 -->varescape <varname>
247 Escape end-line and backslash characters.
248 -->compress_bin <VAR> <bindump>
249 Compress <bindump> using output-compression context
250 and put the output to <VAR> encoded using bindump
251 (compatible with protobuf text format).
252 -->compress_hex <VAR> <hexdump>
253 Compress <hexdump> using output-compression context
254 and put the output to <VAR> encoded using hexdecimal string.
255 -->binsend <bindump>[<bindump>...]
256 Sends one or more binary message dumps to the server (generate those with --bindump)
257 -->binsendoffset <srcvar> [offset-begin[percent]> [offset-end[percent]]]
258 Same as binsend with begin and end offset of data to be send
259 -->binparse <VAR_NAME> MESSAGE.NAME {
260 MESSAGE.DATA
261 }
262 Dump given message to variable <VAR_NAME>, encoded as
263 binary string (compatible with protobuf text format).
264 -->hexparse <VAR_NAME> MESSAGE.NAME {
265 MESSAGE.DATA
266 }
267 Dump given message to variable <VAR_NAME>, encoded as
268 hexdecimal string.
269 -->quiet/noquiet
270 Toggle verbose messages
271 -->query_result/noquery_result
272 Toggle visibility for query results
273 -->received <msgtype> <varname>
274 Assigns number of received messages of indicated type (in active session) to a variable
275 -->clear_received
276 Clear number of received messages.
277 -->recvresult_store_metadata <METADATA_TAG> [print-columnsinfo] [be-quiet]
278 Receive result and store metadata for future use; if print-columnsinfo is present also print short columns status
279 -->recv_with_stored_metadata <METADATA_TAG>
280 Receive a message using a previously stored metadata
281 -->clear_stored_metadata
282 Clear metadata information stored by the recvresult_store_metadata
283 # comment