mysqltest.1 20.2 KB
Newer Older
1
'\" t
2
.\"
=Ian Gilfillan's avatar
=Ian Gilfillan committed
3
.TH "\FBMYSQLTEST\FR" "1" "9 May 2017" "MariaDB 10\&.3" "MariaDB Database System"
4 5 6
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
7 8 9 10
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
11 12 13 14 15
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.\" mysqltest
.\" mysqltest_embedded
16 17 18 19 20
.SH "NAME"
mysqltest \- program to run test cases
.br
mysqltest_embedded \- program to run embedded test cases
.SH "SYNOPSIS"
21
.HP \w'\fBmysqltest\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB]\fR\ 'u
22
\fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR
23
.HP \w'\fBmysqltest_embedded\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB]\fR\ 'u
24 25 26 27 28
\fBmysqltest_embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR
.SH "DESCRIPTION"
.PP
The
\fBmysqltest\fR
iangilfillan's avatar
iangilfillan committed
29
program runs a test case against a MariaDB server and optionally compares the output with a result file\&. This program reads input written in a special test language\&. Typically, you invoke
30 31
\fBmysqltest\fR
via
32 33
\fBmysql\-test\-run\&.pl\fR
rather than invoking it directly\&.
34 35 36 37
.PP
\fBmysqltest_embedded\fR
is similar but is built with support for the
libmysqld
38
embedded server\&.
39 40 41
.PP
Features of
\fBmysqltest\fR:
42 43 44 45 46 47 48 49 50
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
iangilfillan's avatar
iangilfillan committed
51
Can send SQL statements to MariaDB servers for execution
52 53 54 55 56 57 58 59 60 61
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
62
Can execute external shell commands
63 64 65 66 67 68 69 70 71 72
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
73
Can test whether the result from an SQL statement or shell command is as expected
74 75 76 77 78 79 80 81 82 83
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
84 85 86
Can connect to one or more standalone
\fBmysqld\fR
servers and switch between connections
87 88 89 90 91 92 93 94 95 96
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
iangilfillan's avatar
iangilfillan committed
97
Can connect to an embedded server (libmysqld), if MariaDB is compiled with support for
98
libmysqld\&. (In this case, the executable is named
99 100
\fBmysqltest_embedded\fR
rather than
101
\fBmysqltest\fR\&.)
102 103 104 105
.RE
.PP
By default,
\fBmysqltest\fR
106
reads the test case on the standard input\&. To run
107 108 109
\fBmysqltest\fR
this way, you normally invoke it like this:
.sp
110 111 112
.if n \{\
.RS 4
.\}
113 114 115
.nf
shell> \fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB] < \fR\fB\fItest_file\fR\fR
.fi
116
.if n \{\
117
.RE
118
.\}
119 120 121
.PP
You can also name the test case file with a
\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR
122
option\&.
123 124 125
.PP
The exit value from
\fBmysqltest\fR
126
is 0 for success, 1 for failure, and 62 if it skips the test case (for example, if after checking some preconditions it decides not to run the test)\&.
127 128 129
.PP
\fBmysqltest\fR
supports the following options:
130 131 132 133 134 135 136 137 138 139 140
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: help option
.\" help option: mysqltest
141 142 143
\fB\-\-help\fR,
\fB\-?\fR
.sp
144 145 146 147 148 149 150 151 152 153 154 155 156
Display a help message and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: basedir option
.\" basedir option: mysqltest
157 158 159
\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR,
\fB\-b \fR\fB\fIdir_name\fR\fR
.sp
160 161 162 163 164 165 166 167 168 169 170 171 172
The base directory for tests\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: character-sets-dir option
.\" character-sets-dir option: mysqltest
173 174
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
175
The directory where character sets are installed\&.
176 177 178 179 180 181 182 183 184 185 186 187
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: compress option
.\" compress option: mysqltest
188 189 190
\fB\-\-compress\fR,
\fB\-C\fR
.sp
191 192 193 194 195 196 197 198 199 200 201
Compress all information sent between the client and the server if both support compression\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
iangilfillan's avatar
iangilfillan committed
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
.\" mysqltest: connect-timeout option
.\" connect-timeout option: mysqltest
\fB\-\-connect\-timeout=\fInum\fR
.sp
This can be used to set the MYSQL_OPT_CONNECT_TIMEOUT parameter of mysql_options to change the number of seconds before an unsuccessful connection attempt times out\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: continue-on-error option
.\" continue-on-error option: mysqltest
\fB\-\-continue\-on\-error\fR
.sp
Continue test even if we got an error\&. This is mostly 
useful when testing a storage engine to see what from a 
test file it can execute, or to find all syntax errors in 
a newly created big test file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: cursor-protocol option
236
.\" cursor-protocol option: mysqltest
237 238
\fB\-\-cursor\-protocol\fR
.sp
239
Use cursors for prepared statements\&.
240 241 242 243 244 245 246 247 248 249 250 251
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: database option
.\" database option: mysqltest
252 253 254
\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
\fB\-D \fR\fB\fIdb_name\fR\fR
.sp
255 256 257 258 259 260 261 262 263 264 265 266 267
The default database to use\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: debug option
.\" debug option: mysqltest
268 269 270
\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
\fB\-#[\fR\fB\fIdebug_options\fR\fR\fB]\fR
.sp
iangilfillan's avatar
iangilfillan committed
271
Write a debugging log if MariaDB is built with debugging support\&. The default
272 273
\fIdebug_options\fR
value is
274 275 276 277 278 279 280 281 282 283 284 285 286
\'d:t:S:i:O,/tmp/mysqltest\&.trace\'\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: debug-check option
.\" debug-check option: mysqltest
287 288
\fB\-\-debug\-check\fR
.sp
289
Print some debugging information when the program exits\&.
290 291 292 293 294 295 296 297 298 299 300 301
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: debug-info option
.\" debug-info option: mysqltest
302 303
\fB\-\-debug\-info\fR
.sp
304
Print debugging information and memory and CPU usage statistics when the program exits\&.
305 306 307 308 309 310 311 312 313 314 315 316
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: host option
.\" host option: mysqltest
317 318 319
\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
\fB\-h \fR\fB\fIhost_name\fR\fR
.sp
iangilfillan's avatar
iangilfillan committed
320
Connect to the MariaDB server on the given host\&.
321 322 323 324 325 326 327 328 329 330 331 332
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: logdir option
.\" logdir option: mysqltest
333 334
\fB\-\-logdir=\fR\fB\fIdir_name\fR\fR
.sp
335
The directory to use for log files\&.
336 337 338 339 340 341 342 343 344 345 346 347
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: mark-progress option
.\" mark-progress option: mysqltest
348 349 350
\fB\-\-mark\-progress\fR
.sp
Write the line number and elapsed time to
351
\fItest_file\fR\&.progress\&.
352 353 354 355 356 357 358 359 360 361 362 363
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: max-connect-retries option
.\" max-connect-retries option: mysqltest
364 365
\fB\-\-max\-connect\-retries=\fR\fB\fInum\fR\fR
.sp
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
The maximum number of connection attempts when connecting to server\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: max-connections option
.\" max-connections option: mysqltest
\fB\-\-max\-connections=\fR\fB\fInum\fR\fR
.sp
The maximum number of simultaneous server connections per client (that is, per test)\&. If not set, the maximum is 128\&. Minimum allowed limit is 8, maximum is 5120\&.
382 383 384 385 386 387 388 389 390 391 392 393
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: no-defaults option
.\" no-defaults option: mysqltest
394 395
\fB\-\-no\-defaults\fR
.sp
396
Do not read default options from any option files\&. If used, this must be the first option\&.
397 398 399 400 401 402 403 404 405 406
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
iangilfillan's avatar
iangilfillan committed
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
.\" mysqltest: non-blocking-api option
.\" non-blocking-api option: mysqltest
\fB\-\-non\-blocking\-api\fR
.sp
Use the non-blocking client API for communication\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: overlay-dir option
.\" overlay-dir option: mysqltest
\fB\-\-overlay\-dir=\fIdir_name\fR
.sp
Overlay directory\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
437 438
.\" mysqltest: password option
.\" password option: mysqltest
439 440 441
\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
.sp
442
The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you
443
\fIcannot\fR
444
have a space between the option and the password\&. If you omit the
445 446 447 448 449
\fIpassword\fR
value following the
\fB\-\-password\fR
or
\fB\-p\fR
450 451 452 453 454 455 456 457 458 459 460
option on the command line, you are prompted for one\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
iangilfillan's avatar
iangilfillan committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
.\" mysqltest: plugin-dir option
.\" plugin-dir option: mysqltest
\fB\-\-plugin\-dir=\fIdir_name\fR
.sp
Directory for client-side plugins\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
476 477
.\" mysqltest: port option
.\" port option: mysqltest
478 479 480
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
\fB\-P \fR\fB\fIport_num\fR\fR
.sp
iangilfillan's avatar
iangilfillan committed
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
The TCP/IP port number to use for the connection or 0 for default to, in order of preference, 
my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: prologue option
.\" prologue option: mysqltest
\fB\-\-prologue=\fR\fB\fIname\fR\fR
.sp
Include the contents of the given file before processing the contents of the test file\&. The included file should have the same format as other
\fBmysqltest\fR
test files\&. This option has the same effect as putting a
\-\-source \fIfile_name\fR
command as the first line of the test file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: protocol option
.\" protocol option: mysqltest
\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
.sp
The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&.
517 518 519 520 521 522 523 524 525 526 527 528
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: ps-protocol option
.\" ps-protocol option: mysqltest
529 530
\fB\-\-ps\-protocol\fR
.sp
531 532 533 534 535 536 537 538 539 540 541 542 543
Use the prepared\-statement protocol for communication\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: quiet option
.\" quiet option: mysqltest
544 545
\fB\-\-quiet\fR
.sp
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
Suppress all normal output\&. This is a synonym for
.\" mysqltest: silent option
.\" silent option: mysqltest
\fB\-\-silent\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: record option
.\" record option: mysqltest
562 563 564 565 566
\fB\-\-record\fR,
\fB\-r\fR
.sp
Record the output that results from running the test file into the file named by the
\fB\-\-result\-file\fR
567 568
option, if that option is given\&. It is an error to use this option without also using
\fB\-\-result\-file\fR\&.
569 570 571 572 573 574 575 576 577 578 579 580
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: result-file option
.\" result-file option: mysqltest
581 582 583
\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR,
\fB\-R \fR\fB\fIfile_name\fR\fR
.sp
584
This option specifies the file for test case expected results\&.
585 586 587 588
\fB\-\-result\-file\fR, together with
\fB\-\-record\fR, determines how
\fBmysqltest\fR
treats the test actual and expected results for a test case:
589 590 591 592 593 594 595 596 597
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
598 599
If the test produces no results,
\fBmysqltest\fR
600 601 602
exits with an error message to that effect, unless
\fB\-\-result\-file\fR
is given and the named file is an empty file\&.
603 604 605 606 607 608 609 610 611 612
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
613 614 615 616
Otherwise, if
\fB\-\-result\-file\fR
is not given,
\fBmysqltest\fR
617 618 619 620 621 622 623 624 625 626 627
sends test results to the standard output\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
628 629 630 631 632
With
\fB\-\-result\-file\fR
but not
\fB\-\-record\fR,
\fBmysqltest\fR
633
reads the expected results from the given file and compares them with the actual results\&. If the results do not match,
634 635
\fBmysqltest\fR
writes a
636
\&.reject
637
file in the same directory as the result file, outputs a diff of the two files, and exits with an error\&.
638 639 640 641 642 643 644 645 646 647
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
648 649 650 651 652
With both
\fB\-\-result\-file\fR
and
\fB\-\-record\fR,
\fBmysqltest\fR
653 654
updates the given file by writing the actual test results to it\&.
.RE
655
.RE
656 657 658 659 660 661 662 663 664
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
iangilfillan's avatar
iangilfillan committed
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
.\" mysqltest: result-format-version option
.\" result-format-version option: mysqltest
\fB\-\-result\-format\-version=\fI#\fR
.sp
Version of the result file format to use\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
680 681
.\" mysqltest: server-arg option
.\" server-arg option: mysqltest
682 683 684
\fB\-\-server\-arg=\fR\fB\fIvalue\fR\fR,
\fB\-A \fR\fB\fIvalue\fR\fR
.sp
685
Pass the argument as an argument to the embedded server\&. For example,
686 687
\fB\-\-server\-arg=\-\-tmpdir=/tmp\fR
or
688 689 690 691 692 693 694 695 696 697 698 699 700
\fB\-\-server\-arg=\-\-core\fR\&. Up to 64 arguments can be given\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: server-file option
.\" server-file option: mysqltest
701 702 703
\fB\-\-server\-file=\fR\fB\fIfile_name\fR\fR,
\fB\-F \fR\fB\fIfile_name\fR\fR
.sp
704 705 706 707 708 709 710 711 712 713 714 715 716
Read arguments for the embedded server from the given file\&. The file should contain one argument per line\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: silent option
.\" silent option: mysqltest
717 718 719
\fB\-\-silent\fR,
\fB\-s\fR
.sp
720 721 722 723 724 725 726 727 728 729 730 731 732
Suppress all normal output\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: sleep option
.\" sleep option: mysqltest
733 734 735 736 737 738 739
\fB\-\-sleep=\fR\fB\fInum\fR\fR,
\fB\-T \fR\fB\fInum\fR\fR
.sp
Cause all
sleep
commands in the test case file to sleep
\fInum\fR
740
seconds\&. This option does not affect
741
real_sleep
742
commands\&.
743
.sp
iangilfillan's avatar
iangilfillan committed
744
An option value of 0 can be used, which effectively disables sleep
745 746 747 748 749 750 751 752 753 754 755 756 757
commands in the test case\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: socket option
.\" socket option: mysqltest
758 759 760 761 762
\fB\-\-socket=\fR\fB\fIpath\fR\fR,
\fB\-S \fR\fB\fIpath\fR\fR
.sp
The socket file to use when connecting to
localhost
763 764 765 766 767 768 769 770 771 772 773 774 775
(which is the default host)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: sp-protocol option
.\" sp-protocol option: mysqltest
776 777
\fB\-\-sp\-protocol\fR
.sp
778
Execute DML statements within a stored procedure\&. For every DML statement,
779
\fBmysqltest\fR
780 781 782 783 784 785 786 787 788 789 790
creates and invokes a stored procedure that executes the statement rather than executing the statement directly\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
iangilfillan's avatar
iangilfillan committed
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
.\" mysqltest: SSL options
.\" SSL options: mysqltest
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with 
\fB\-\-skip-ssl\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: SSL CA option
.\" SSL CA option: mysqltest
\fB\-\-ssl\-ca=\fIname\fR
.sp
CA file in PEM format (check OpenSSL docs, implies
\fB\-\-ssl\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: SSL CA Path option
.\" SSL CA Path option: mysqltest
\fB\-\-ssl\-capath=\fIname\fR
.sp
CA directory (check OpenSSL docs, implies
\fB\-\-ssl\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: SSL Cert option
.\" SSL Cert option: mysqltest
\fB\-\-ssl\-cert=\fIname\fR
.sp
X509 cert in PEM format (check OpenSSL docs, implies
\fB\-\-ssl\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: SSL Cipher option
.\" SSL Cipher option: mysqltest
\fB\-\-ssl\-cipher=\fIname\fR
.sp
SSL cipher to use (check OpenSSL docs, implies
\fB\-\-ssl\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: SSL Key option
.\" SSL Key option: mysqltest
\fB\-\-ssl\-key=\fIname\fR
.sp
X509 key in PEM format (check OpenSSL docs, implies
\fB\-\-ssl\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: SSL Crl option
.\" SSL CRL option: mysqltest
\fB\-\-ssl\-crl=\fIname\fR
.sp
Certificate revocation list (check OpenSSL docs, implies
\fB\-\-ssl\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: SSL Crlpath option
.\" SSL Crlpath option: mysqltest
\fB\-\-ssl\-crlpath=\fIname\fR
.sp
Certificate revocation list path (check OpenSSL docs, implies
\fB\-\-ssl\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: SSL Verify Server Cert option
.\" SSL Verify Server Cert option: mysqltest
\fB\-\-ssl\-verify\-server\-cert\fR
.sp
Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: suite-dir option
.\" suite-dir option: mysqltest
\fB\-\-suite\-dir=\fIdir_name\fR
.sp
Suite directory\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
949 950 951 952 953
.\" mysqltest: tail-lines option
.\" tail-lines option: mysqltest
\fB\-\-tail\-lines=\fR\fB\fInn\fR\fR
.sp
Specify how many lines of the result to include in the output if the test fails because an SQL statement fails\&. The default is 0, meaning no lines of result printed\&.
954 955 956 957 958 959 960 961 962 963 964 965
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: test-file option
.\" test-file option: mysqltest
966 967 968
\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR,
\fB\-x \fR\fB\fIfile_name\fR\fR
.sp
969 970 971 972 973 974 975 976 977 978 979 980 981
Read test input from this file\&. The default is to read from the standard input\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: timer-file option
.\" timer-file option: mysqltest
982 983 984
\fB\-\-timer\-file=\fR\fB\fIfile_name\fR\fR,
\fB\-m \fR\fB\fIfile_name\fR\fR
.sp
iangilfillan's avatar
iangilfillan committed
985
If given, the number of microseconds spent running the test will be written to this file\&. This is used by
986 987
\fBmysql\-test\-run\&.pl\fR
for its reporting\&.
988 989 990 991 992 993 994 995 996 997 998 999
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: tmpdir option
.\" tmpdir option: mysqltest
1000 1001 1002
\fB\-\-tmpdir=\fR\fB\fIdir_name\fR\fR,
\fB\-t \fR\fB\fIdir_name\fR\fR
.sp
1003
The temporary directory where socket files are created\&.
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: user option
.\" user option: mysqltest
1016 1017 1018
\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
\fB\-u \fR\fB\fIuser_name\fR\fR
.sp
iangilfillan's avatar
iangilfillan committed
1019
The MariaDB user name to use when connecting to the server\&.
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: verbose option
.\" verbose option: mysqltest
1032 1033 1034
\fB\-\-verbose\fR,
\fB\-v\fR
.sp
1035
Verbose mode\&. Print out more information about what the program does\&.
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: version option
.\" version option: mysqltest
1048 1049 1050
\fB\-\-version\fR,
\fB\-V\fR
.sp
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
Display version information and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: view-protocol option
.\" view-protocol option: mysqltest
1064 1065 1066 1067
\fB\-\-view\-protocol\fR
.sp
Every
SELECT
iangilfillan's avatar
iangilfillan committed
1068
statement is wrapped inside a view\&.
1069
.RE
1070
.SH "COPYRIGHT"
1071
.br
1072
.PP
iangilfillan's avatar
iangilfillan committed
1073
Copyright \(co 2007, 2010, Oracle and/or its affiliates, 2010-2015 MariaDB Foundation
1074 1075 1076 1077 1078
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
This documentation 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 for more details.
.PP
1079 1080
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
.sp
1081
.SH "SEE ALSO"
iangilfillan's avatar
iangilfillan committed
1082
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
1083
.SH AUTHOR
iangilfillan's avatar
iangilfillan committed
1084
MariaDB Foundation (http://www.mariadb.org/).