| blob | e60e9a7e955b809d0a529e77955cd9d29902c36a |
1 '\" t
2 .\" Title: \fBmysqlslap\fR
3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
5 .\" Date: 11/04/2013
6 .\" Manual: MySQL Database System
7 .\" Source: MySQL 5.1
8 .\" Language: English
9 .\"
10 .TH "\FBMYSQLSLAP\FR" "1" "11/04/2013" "MySQL 5\&.1" "MySQL Database System"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .\" mysqlslap
31 .\" load emulation
32 .SH "NAME"
33 mysqlslap \- load emulation client
34 .SH "SYNOPSIS"
35 .HP \w'\fBmysqlslap\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
36 \fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR
37 .SH "DESCRIPTION"
38 .PP
39 \fBmysqlslap\fR
40 is a diagnostic program designed to emulate client load for a MySQL server and to report the timing of each stage\&. It works as if multiple clients are accessing the server\&.
41 \fBmysqlslap\fR
42 is available as of MySQL 5\&.1\&.4\&.
43 .PP
44 Invoke
45 \fBmysqlslap\fR
46 like this:
47 .sp
48 .if n \{\
49 .RS 4
50 .\}
51 .nf
52 shell> \fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR
53 .fi
54 .if n \{\
55 .RE
56 .\}
57 .PP
58 Some options such as
59 \fB\-\-create\fR
60 or
61 \fB\-\-query\fR
62 enable you to specify a string containing an SQL statement or a file containing statements\&. If you specify a file, by default it must contain one statement per line\&. (That is, the implicit statement delimiter is the newline character\&.) Use the
63 \fB\-\-delimiter\fR
64 option to specify a different delimiter, which enables you to specify statements that span multiple lines or place multiple statements on a single line\&. You cannot include comments in a file;
65 \fBmysqlslap\fR
66 does not understand them\&.
67 .PP
68 \fBmysqlslap\fR
69 runs in three stages:
70 .sp
71 .RS 4
72 .ie n \{\
73 \h'-04' 1.\h'+01'\c
74 .\}
75 .el \{\
76 .sp -1
77 .IP " 1." 4.2
78 .\}
79 Create schema, table, and optionally any stored programs or data to use for the test\&. This stage uses a single client connection\&.
80 .RE
81 .sp
82 .RS 4
83 .ie n \{\
84 \h'-04' 2.\h'+01'\c
85 .\}
86 .el \{\
87 .sp -1
88 .IP " 2." 4.2
89 .\}
90 Run the load test\&. This stage can use many client connections\&.
91 .RE
92 .sp
93 .RS 4
94 .ie n \{\
95 \h'-04' 3.\h'+01'\c
96 .\}
97 .el \{\
98 .sp -1
99 .IP " 3." 4.2
100 .\}
101 Clean up (disconnect, drop table if specified)\&. This stage uses a single client connection\&.
102 .RE
103 .PP
104 Examples:
105 .PP
106 Supply your own create and query SQL statements, with 50 clients querying and 200 selects for each (enter the command on a single line):
107 .sp
108 .if n \{\
109 .RS 4
110 .\}
111 .nf
112 mysqlslap \-\-delimiter=";"
113 \-\-create="CREATE TABLE a (b int);INSERT INTO a VALUES (23)"
114 \-\-query="SELECT * FROM a" \-\-concurrency=50 \-\-iterations=200
115 .fi
116 .if n \{\
117 .RE
118 .\}
119 .PP
120 Let
121 \fBmysqlslap\fR
122 build the query SQL statement with a table of two
123 INT
124 columns and three
125 VARCHAR
126 columns\&. Use five clients querying 20 times each\&. Do not create the table or insert the data (that is, use the previous test\*(Aqs schema and data):
127 .sp
128 .if n \{\
129 .RS 4
130 .\}
131 .nf
132 mysqlslap \-\-concurrency=5 \-\-iterations=20
133 \-\-number\-int\-cols=2 \-\-number\-char\-cols=3
134 \-\-auto\-generate\-sql
135 .fi
136 .if n \{\
137 .RE
138 .\}
139 .PP
140 Tell the program to load the create, insert, and query SQL statements from the specified files, where the
141 create\&.sql
142 file has multiple table creation statements delimited by
143 \*(Aq;\*(Aq
144 and multiple insert statements delimited by
145 \*(Aq;\*(Aq\&. The
146 \fB\-\-query\fR
147 file will have multiple queries delimited by
148 \*(Aq;\*(Aq\&. Run all the load statements, then run all the queries in the query file with five clients (five times each):
149 .sp
150 .if n \{\
151 .RS 4
152 .\}
153 .nf
154 mysqlslap \-\-concurrency=5
155 \-\-iterations=5 \-\-query=query\&.sql \-\-create=create\&.sql
156 \-\-delimiter=";"
157 .fi
158 .if n \{\
159 .RE
160 .\}
161 .PP
162 \fBmysqlslap\fR
163 supports the following options, which can be specified on the command line or in the
164 [mysqlslap]
165 and
166 [client]
167 groups of an option file\&.
168 \fBmysqlslap\fR
169 also supports the options for processing option files described at
170 Section\ \&4.2.3.4, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
171 .sp
172 .RS 4
173 .ie n \{\
174 \h'-04'\(bu\h'+03'\c
175 .\}
176 .el \{\
177 .sp -1
178 .IP \(bu 2.3
179 .\}
180 .\" mysqlslap: help option
181 .\" help option: mysqlslap
182 \fB\-\-help\fR,
183 \fB\-?\fR
184 .sp
185 Display a help message and exit\&.
186 .RE
187 .sp
188 .RS 4
189 .ie n \{\
190 \h'-04'\(bu\h'+03'\c
191 .\}
192 .el \{\
193 .sp -1
194 .IP \(bu 2.3
195 .\}
196 .\" mysqlslap: auto-generate-sql option
197 .\" auto-generate-sql option: mysqlslap
198 \fB\-\-auto\-generate\-sql\fR,
199 \fB\-a\fR
200 .sp
201 Generate SQL statements automatically when they are not supplied in files or using command options\&.
202 .RE
203 .sp
204 .RS 4
205 .ie n \{\
206 \h'-04'\(bu\h'+03'\c
207 .\}
208 .el \{\
209 .sp -1
210 .IP \(bu 2.3
211 .\}
212 .\" mysqlslap: auto-generate-sql-add-autoincrement option
213 .\" auto-generate-sql-add-autoincrement option: mysqlslap
214 \fB\-\-auto\-generate\-sql\-add\-autoincrement\fR
215 .sp
216 Add an
217 AUTO_INCREMENT
218 column to automatically generated tables\&. This option was added in MySQL 5\&.1\&.18\&.
219 .RE
220 .sp
221 .RS 4
222 .ie n \{\
223 \h'-04'\(bu\h'+03'\c
224 .\}
225 .el \{\
226 .sp -1
227 .IP \(bu 2.3
228 .\}
229 .\" mysqlslap: auto-generate-sql-execute-number option
230 .\" auto-generate-sql-execute-number option: mysqlslap
231 \fB\-\-auto\-generate\-sql\-execute\-number=\fR\fB\fIN\fR\fR
232 .sp
233 Specify how many queries to generate automatically\&. This option was added in MySQL 5\&.1\&.18\&.
234 .RE
235 .sp
236 .RS 4
237 .ie n \{\
238 \h'-04'\(bu\h'+03'\c
239 .\}
240 .el \{\
241 .sp -1
242 .IP \(bu 2.3
243 .\}
244 .\" mysqlslap: auto-generate-sql-guid-primary option
245 .\" auto-generate-sql-guid-primary option: mysqlslap
246 \fB\-\-auto\-generate\-sql\-guid\-primary\fR
247 .sp
248 Add a GUID\-based primary key to automatically generated tables\&. This option was added in MySQL 5\&.1\&.18\&.
249 .RE
250 .sp
251 .RS 4
252 .ie n \{\
253 \h'-04'\(bu\h'+03'\c
254 .\}
255 .el \{\
256 .sp -1
257 .IP \(bu 2.3
258 .\}
259 .\" mysqlslap: auto-generate-sql-load-type option
260 .\" auto-generate-sql-load-type option: mysqlslap
261 \fB\-\-auto\-generate\-sql\-load\-type=\fR\fB\fItype\fR\fR
262 .sp
263 Specify the test load type\&. The permissible values are
264 read
265 (scan tables),
266 write
267 (insert into tables),
268 key
269 (read primary keys),
270 update
271 (update primary keys), or
272 mixed
273 (half inserts, half scanning selects)\&. The default is
274 mixed\&. This option was added in MySQL 5\&.1\&.16\&.
275 .RE
276 .sp
277 .RS 4
278 .ie n \{\
279 \h'-04'\(bu\h'+03'\c
280 .\}
281 .el \{\
282 .sp -1
283 .IP \(bu 2.3
284 .\}
285 .\" mysqlslap: auto-generate-sql-secondary-indexes option
286 .\" auto-generate-sql-secondary-indexes option: mysqlslap
287 \fB\-\-auto\-generate\-sql\-secondary\-indexes=\fR\fB\fIN\fR\fR
288 .sp
289 Specify how many secondary indexes to add to automatically generated tables\&. By default, none are added\&. This option was added in MySQL 5\&.1\&.18\&.
290 .RE
291 .sp
292 .RS 4
293 .ie n \{\
294 \h'-04'\(bu\h'+03'\c
295 .\}
296 .el \{\
297 .sp -1
298 .IP \(bu 2.3
299 .\}
300 .\" mysqlslap: auto-generate-sql-unique-query-number option
301 .\" auto-generate-sql-unique-query-number option: mysqlslap
302 \fB\-\-auto\-generate\-sql\-unique\-query\-number=\fR\fB\fIN\fR\fR
303 .sp
304 How many different queries to generate for automatic tests\&. For example, if you run a
305 key
306 test that performs 1000 selects, you can use this option with a value of 1000 to run 1000 unique queries, or with a value of 50 to perform 50 different selects\&. The default is 10\&. This option was added in MySQL 5\&.1\&.18\&.
307 .RE
308 .sp
309 .RS 4
310 .ie n \{\
311 \h'-04'\(bu\h'+03'\c
312 .\}
313 .el \{\
314 .sp -1
315 .IP \(bu 2.3
316 .\}
317 .\" mysqlslap: auto-generate-sql-unique-write-number option
318 .\" auto-generate-sql-unique-write-number option: mysqlslap
319 \fB\-\-auto\-generate\-sql\-unique\-write\-number=\fR\fB\fIN\fR\fR
320 .sp
321 How many different queries to generate for
322 \fB\-\-auto\-generate\-sql\-write\-number\fR\&. The default is 10\&. This option was added in MySQL 5\&.1\&.18\&.
323 .RE
324 .sp
325 .RS 4
326 .ie n \{\
327 \h'-04'\(bu\h'+03'\c
328 .\}
329 .el \{\
330 .sp -1
331 .IP \(bu 2.3
332 .\}
333 .\" mysqlslap: auto-generate-sql-write-number option
334 .\" auto-generate-sql-write-number option: mysqlslap
335 \fB\-\-auto\-generate\-sql\-write\-number=\fR\fB\fIN\fR\fR
336 .sp
337 How many row inserts to perform on each thread\&. The default is 100\&. This option was added in MySQL 5\&.1\&.16\&.
338 .RE
339 .sp
340 .RS 4
341 .ie n \{\
342 \h'-04'\(bu\h'+03'\c
343 .\}
344 .el \{\
345 .sp -1
346 .IP \(bu 2.3
347 .\}
348 .\" mysqlslap: commit option
349 .\" commit option: mysqlslap
350 \fB\-\-commit=\fR\fB\fIN\fR\fR
351 .sp
352 How many statements to execute before committing\&. The default is 0 (no commits are done)\&. This option was added in MySQL 5\&.1\&.21\&.
353 .RE
354 .sp
355 .RS 4
356 .ie n \{\
357 \h'-04'\(bu\h'+03'\c
358 .\}
359 .el \{\
360 .sp -1
361 .IP \(bu 2.3
362 .\}
363 .\" mysqlslap: compress option
364 .\" compress option: mysqlslap
365 \fB\-\-compress\fR,
366 \fB\-C\fR
367 .sp
368 Compress all information sent between the client and the server if both support compression\&.
369 .RE
370 .sp
371 .RS 4
372 .ie n \{\
373 \h'-04'\(bu\h'+03'\c
374 .\}
375 .el \{\
376 .sp -1
377 .IP \(bu 2.3
378 .\}
379 .\" mysqlslap: concurrency option
380 .\" concurrency option: mysqlslap
381 \fB\-\-concurrency=\fR\fB\fIN\fR\fR,
382 \fB\-c \fR\fB\fIN\fR\fR
383 .sp
384 The number of clients to simulate when issuing the
385 SELECT
386 statement\&.
387 .RE
388 .sp
389 .RS 4
390 .ie n \{\
391 \h'-04'\(bu\h'+03'\c
392 .\}
393 .el \{\
394 .sp -1
395 .IP \(bu 2.3
396 .\}
397 .\" mysqlslap: create option
398 .\" create option: mysqlslap
399 \fB\-\-create=\fR\fB\fIvalue\fR\fR
400 .sp
401 The file or string containing the statement to use for creating the table\&.
402 .RE
403 .sp
404 .RS 4
405 .ie n \{\
406 \h'-04'\(bu\h'+03'\c
407 .\}
408 .el \{\
409 .sp -1
410 .IP \(bu 2.3
411 .\}
412 .\" mysqlslap: create-schema option
413 .\" create-schema option: mysqlslap
414 \fB\-\-create\-schema=\fR\fB\fIvalue\fR\fR
415 .sp
416 The schema in which to run the tests\&. This option was added in MySQL 5\&.1\&.5\&.
417 .if n \{\
418 .sp
419 .\}
420 .RS 4
421 .it 1 an-trap
422 .nr an-no-space-flag 1
423 .nr an-break-flag 1
424 .br
425 .ps +1
426 \fBNote\fR
427 .ps -1
428 .br
429 If the
430 \fB\-\-auto\-generate\-sql\fR
431 option is also given,
432 \fBmysqlslap\fR
433 drops the schema at the end of the test run\&. To avoid this, use the
434 \fB\-\-no\-drop\fR
435 option as well\&.
436 .sp .5v
437 .RE
438 .RE
439 .sp
440 .RS 4
441 .ie n \{\
442 \h'-04'\(bu\h'+03'\c
443 .\}
444 .el \{\
445 .sp -1
446 .IP \(bu 2.3
447 .\}
448 .\" mysqlslap: csv option
449 .\" csv option: mysqlslap
450 \fB\-\-csv[=\fR\fB\fIfile_name\fR\fR\fB]\fR
451 .sp
452 Generate output in comma\-separated values format\&. The output goes to the named file, or to the standard output if no file is given\&. This option was added in MySQL 5\&.1\&.5\&.
453 .RE
454 .sp
455 .RS 4
456 .ie n \{\
457 \h'-04'\(bu\h'+03'\c
458 .\}
459 .el \{\
460 .sp -1
461 .IP \(bu 2.3
462 .\}
463 .\" mysqlslap: debug option
464 .\" debug option: mysqlslap
465 \fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
466 \fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR
467 .sp
468 Write a debugging log\&. A typical
469 \fIdebug_options\fR
470 string is
471 \*(Aqd:t:o,\fIfile_name\fR\*(Aq\&. The default is
472 \*(Aqd:t:o,/tmp/mysqlslap\&.trace\*(Aq\&.
473 .RE
474 .sp
475 .RS 4
476 .ie n \{\
477 \h'-04'\(bu\h'+03'\c
478 .\}
479 .el \{\
480 .sp -1
481 .IP \(bu 2.3
482 .\}
483 .\" mysqlslap: debug-check option
484 .\" debug-check option: mysqlslap
485 \fB\-\-debug\-check\fR
486 .sp
487 Print some debugging information when the program exits\&. This option was added in MySQL 5\&.1\&.21\&.
488 .RE
489 .sp
490 .RS 4
491 .ie n \{\
492 \h'-04'\(bu\h'+03'\c
493 .\}
494 .el \{\
495 .sp -1
496 .IP \(bu 2.3
497 .\}
498 .\" mysqlslap: debug-info option
499 .\" debug-info option: mysqlslap
500 \fB\-\-debug\-info\fR,
501 \fB\-T\fR
502 .sp
503 Print debugging information and memory and CPU usage statistics when the program exits\&. This option was added in MySQL 5\&.1\&.21\&.
504 .RE
505 .sp
506 .RS 4
507 .ie n \{\
508 \h'-04'\(bu\h'+03'\c
509 .\}
510 .el \{\
511 .sp -1
512 .IP \(bu 2.3
513 .\}
514 .\" mysqlslap: delimiter option
515 .\" delimiter option: mysqlslap
516 \fB\-\-delimiter=\fR\fB\fIstr\fR\fR,
517 \fB\-F \fR\fB\fIstr\fR\fR
518 .sp
519 The delimiter to use in SQL statements supplied in files or using command options\&.
520 .RE
521 .sp
522 .RS 4
523 .ie n \{\
524 \h'-04'\(bu\h'+03'\c
525 .\}
526 .el \{\
527 .sp -1
528 .IP \(bu 2.3
529 .\}
530 .\" mysqlslap: detach option
531 .\" detach option: mysqlslap
532 \fB\-\-detach=\fR\fB\fIN\fR\fR
533 .sp
534 Detach (close and reopen) each connection after each
535 \fIN\fR
536 statements\&. The default is 0 (connections are not detached)\&. This option was added in MySQL 5\&.1\&.21\&.
537 .RE
538 .sp
539 .RS 4
540 .ie n \{\
541 \h'-04'\(bu\h'+03'\c
542 .\}
543 .el \{\
544 .sp -1
545 .IP \(bu 2.3
546 .\}
547 .\" mysqlslap: engine option
548 .\" engine option: mysqlslap
549 \fB\-\-engine=\fR\fB\fIengine_name\fR\fR,
550 \fB\-e \fR\fB\fIengine_name\fR\fR
551 .sp
552 The storage engine to use for creating tables\&.
553 .RE
554 .sp
555 .RS 4
556 .ie n \{\
557 \h'-04'\(bu\h'+03'\c
558 .\}
559 .el \{\
560 .sp -1
561 .IP \(bu 2.3
562 .\}
563 .\" mysqlslap: host option
564 .\" host option: mysqlslap
565 \fB\-\-host=\fR\fB\fIhost_name\fR\fR,
566 \fB\-h \fR\fB\fIhost_name\fR\fR
567 .sp
568 Connect to the MySQL server on the given host\&.
569 .RE
570 .sp
571 .RS 4
572 .ie n \{\
573 \h'-04'\(bu\h'+03'\c
574 .\}
575 .el \{\
576 .sp -1
577 .IP \(bu 2.3
578 .\}
579 .\" mysqlslap: iterations option
580 .\" iterations option: mysqlslap
581 \fB\-\-iterations=\fR\fB\fIN\fR\fR,
582 \fB\-i \fR\fB\fIN\fR\fR
583 .sp
584 The number of times to run the tests\&.
585 .RE
586 .sp
587 .RS 4
588 .ie n \{\
589 \h'-04'\(bu\h'+03'\c
590 .\}
591 .el \{\
592 .sp -1
593 .IP \(bu 2.3
594 .\}
595 .\" mysqlslap: lock-directory option
596 .\" lock-directory option: mysqlslap
597 \fB\-\-lock\-directory=\fR\fB\fIpath\fR\fR
598 .sp
599 The directory to use for storing locks\&. This option was added in MySQL 5\&.1\&.5 and removed in 5\&.1\&.18\&.
600 .RE
601 .sp
602 .RS 4
603 .ie n \{\
604 \h'-04'\(bu\h'+03'\c
605 .\}
606 .el \{\
607 .sp -1
608 .IP \(bu 2.3
609 .\}
610 .\" mysqlslap: no-drop option
611 .\" no-drop option: mysqlslap
612 \fB\-\-no\-drop\fR
613 .sp
614 Prevent
615 \fBmysqlslap\fR
616 from dropping any schema it creates during the test run\&. This option was added in MySQL 5\&.1\&.57\&.
617 .RE
618 .sp
619 .RS 4
620 .ie n \{\
621 \h'-04'\(bu\h'+03'\c
622 .\}
623 .el \{\
624 .sp -1
625 .IP \(bu 2.3
626 .\}
627 .\" mysqlslap: number-char-cols option
628 .\" number-char-cols option: mysqlslap
629 \fB\-\-number\-char\-cols=\fR\fB\fIN\fR\fR,
630 \fB\-x \fR\fB\fIN\fR\fR
631 .sp
632 The number of
633 VARCHAR
634 columns to use if
635 \fB\-\-auto\-generate\-sql\fR
636 is specified\&.
637 .RE
638 .sp
639 .RS 4
640 .ie n \{\
641 \h'-04'\(bu\h'+03'\c
642 .\}
643 .el \{\
644 .sp -1
645 .IP \(bu 2.3
646 .\}
647 .\" mysqlslap: number-int-cols option
648 .\" number-int-cols option: mysqlslap
649 \fB\-\-number\-int\-cols=\fR\fB\fIN\fR\fR,
650 \fB\-y \fR\fB\fIN\fR\fR
651 .sp
652 The number of
653 INT
654 columns to use if
655 \fB\-\-auto\-generate\-sql\fR
656 is specified\&.
657 .RE
658 .sp
659 .RS 4
660 .ie n \{\
661 \h'-04'\(bu\h'+03'\c
662 .\}
663 .el \{\
664 .sp -1
665 .IP \(bu 2.3
666 .\}
667 .\" mysqlslap: number-of-queries option
668 .\" number-of-queries option: mysqlslap
669 \fB\-\-number\-of\-queries=\fR\fB\fIN\fR\fR
670 .sp
671 Limit each client to approximately this many queries\&. Query counting takes into account the statement delimiter\&. For example, if you invoke
672 \fBmysqlslap\fR
673 as follows, the
674 ;
675 delimiter is recognized so that each instance of the query string counts as two queries\&. As a result, 5 rows (not 10) are inserted\&.
676 .sp
677 .if n \{\
678 .RS 4
679 .\}
680 .nf
681 shell> \fBmysqlslap \-\-delimiter=";" \-\-number\-of\-queries=10\fR
682 \fB\-\-query="use test;insert into t values(null)"\fR
683 .fi
684 .if n \{\
685 .RE
686 .\}
687 .sp
688 This option was added in MySQL 5\&.1\&.5\&.
689 .RE
690 .sp
691 .RS 4
692 .ie n \{\
693 \h'-04'\(bu\h'+03'\c
694 .\}
695 .el \{\
696 .sp -1
697 .IP \(bu 2.3
698 .\}
699 .\" mysqlslap: only-print option
700 .\" only-print option: mysqlslap
701 \fB\-\-only\-print\fR
702 .sp
703 Do not connect to databases\&.
704 \fBmysqlslap\fR
705 only prints what it would have done\&. This option was added in MySQL 5\&.1\&.5\&.
706 .RE
707 .sp
708 .RS 4
709 .ie n \{\
710 \h'-04'\(bu\h'+03'\c
711 .\}
712 .el \{\
713 .sp -1
714 .IP \(bu 2.3
715 .\}
716 .\" mysqlslap: password option
717 .\" password option: mysqlslap
718 \fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
719 \fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
720 .sp
721 The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you
722 \fIcannot\fR
723 have a space between the option and the password\&. If you omit the
724 \fIpassword\fR
725 value following the
726 \fB\-\-password\fR
727 or
728 \fB\-p\fR
729 option on the command line,
730 \fBmysqlslap\fR
731 prompts for one\&.
732 .sp
733 Specifying a password on the command line should be considered insecure\&. See
734 Section\ \&6.1.2.1, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
735 .RE
736 .sp
737 .RS 4
738 .ie n \{\
739 \h'-04'\(bu\h'+03'\c
740 .\}
741 .el \{\
742 .sp -1
743 .IP \(bu 2.3
744 .\}
745 .\" mysqlslap: pipe option
746 .\" pipe option: mysqlslap
747 \fB\-\-pipe\fR,
748 \fB\-W\fR
749 .sp
750 On Windows, connect to the server using a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
751 .RE
752 .sp
753 .RS 4
754 .ie n \{\
755 \h'-04'\(bu\h'+03'\c
756 .\}
757 .el \{\
758 .sp -1
759 .IP \(bu 2.3
760 .\}
761 .\" mysqlslap: port option
762 .\" port option: mysqlslap
763 \fB\-\-port=\fR\fB\fIport_num\fR\fR,
764 \fB\-P \fR\fB\fIport_num\fR\fR
765 .sp
766 The TCP/IP port number to use for the connection\&.
767 .RE
768 .sp
769 .RS 4
770 .ie n \{\
771 \h'-04'\(bu\h'+03'\c
772 .\}
773 .el \{\
774 .sp -1
775 .IP \(bu 2.3
776 .\}
777 .\" mysqlslap: post-query option
778 .\" post-query option: mysqlslap
779 \fB\-\-post\-query=\fR\fB\fIvalue\fR\fR
780 .sp
781 The file or string containing the statement to execute after the tests have completed\&. This execution is not counted for timing purposes\&. This option was added in MySQL 5\&.1\&.18\&.
782 .RE
783 .sp
784 .RS 4
785 .ie n \{\
786 \h'-04'\(bu\h'+03'\c
787 .\}
788 .el \{\
789 .sp -1
790 .IP \(bu 2.3
791 .\}
792 .\" mysqlslap: shared-memory-base-name option
793 .\" shared-memory-base-name option: mysqlslap
794 \fB\-\-shared\-memory\-base\-name=\fR\fB\fIname\fR\fR
795 .sp
796 On Windows, the shared\-memory name to use, for connections made using shared memory to a local server\&. This option applies only if the server supports shared\-memory connections\&.
797 .RE
798 .sp
799 .RS 4
800 .ie n \{\
801 \h'-04'\(bu\h'+03'\c
802 .\}
803 .el \{\
804 .sp -1
805 .IP \(bu 2.3
806 .\}
807 .\" mysqlslap: post-system option
808 .\" post-system option: mysqlslap
809 \fB\-\-post\-system=\fR\fB\fIstr\fR\fR
810 .sp
811 The string to execute using
812 system()
813 after the tests have completed\&. This execution is not counted for timing purposes\&. This option was added in MySQL 5\&.1\&.21\&.
814 .RE
815 .sp
816 .RS 4
817 .ie n \{\
818 \h'-04'\(bu\h'+03'\c
819 .\}
820 .el \{\
821 .sp -1
822 .IP \(bu 2.3
823 .\}
824 .\" mysqlslap: pre-query option
825 .\" pre-query option: mysqlslap
826 \fB\-\-pre\-query=\fR\fB\fIvalue\fR\fR
827 .sp
828 The file or string containing the statement to execute before running the tests\&. This execution is not counted for timing purposes\&. This option was added in MySQL 5\&.1\&.18\&.
829 .RE
830 .sp
831 .RS 4
832 .ie n \{\
833 \h'-04'\(bu\h'+03'\c
834 .\}
835 .el \{\
836 .sp -1
837 .IP \(bu 2.3
838 .\}
839 .\" mysqlslap: pre-system option
840 .\" pre-system option: mysqlslap
841 \fB\-\-pre\-system=\fR\fB\fIstr\fR\fR
842 .sp
843 The string to execute using
844 system()
845 before running the tests\&. This execution is not counted for timing purposes\&. This option was added in MySQL 5\&.1\&.21\&.
846 .RE
847 .sp
848 .RS 4
849 .ie n \{\
850 \h'-04'\(bu\h'+03'\c
851 .\}
852 .el \{\
853 .sp -1
854 .IP \(bu 2.3
855 .\}
856 .\" mysqlslap: preserve-schema option
857 .\" preserve-schema option: mysqlslap
858 \fB\-\-preserve\-schema\fR
859 .sp
860 Preserve the schema from the
861 \fBmysqlslap\fR
862 run\&. The
863 \fB\-\-auto\-generate\-sql\fR
864 and
865 \fB\-\-create\fR
866 options disable this option\&. This option was added in MySQL 5\&.1\&.5 and removed in MySQL 5\&.1\&.23\&.
867 .RE
868 .sp
869 .RS 4
870 .ie n \{\
871 \h'-04'\(bu\h'+03'\c
872 .\}
873 .el \{\
874 .sp -1
875 .IP \(bu 2.3
876 .\}
877 .\" mysqlslap: protocol option
878 .\" protocol option: mysqlslap
879 \fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
880 .sp
881 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\&. For details on the permissible values, see
882 Section\ \&4.2.2, \(lqConnecting to the MySQL Server\(rq\&.
883 .RE
884 .sp
885 .RS 4
886 .ie n \{\
887 \h'-04'\(bu\h'+03'\c
888 .\}
889 .el \{\
890 .sp -1
891 .IP \(bu 2.3
892 .\}
893 .\" mysqlslap: query option
894 .\" query option: mysqlslap
895 \fB\-\-query=\fR\fB\fIvalue\fR\fR,
896 \fB\-q \fR\fB\fIvalue\fR\fR
897 .sp
898 The file or string containing the
899 SELECT
900 statement to use for retrieving data\&.
901 .RE
902 .sp
903 .RS 4
904 .ie n \{\
905 \h'-04'\(bu\h'+03'\c
906 .\}
907 .el \{\
908 .sp -1
909 .IP \(bu 2.3
910 .\}
911 .\" mysqlslap: silent option
912 .\" silent option: mysqlslap
913 \fB\-\-silent\fR,
914 \fB\-s\fR
915 .sp
916 Silent mode\&. No output\&.
917 .RE
918 .sp
919 .RS 4
920 .ie n \{\
921 \h'-04'\(bu\h'+03'\c
922 .\}
923 .el \{\
924 .sp -1
925 .IP \(bu 2.3
926 .\}
927 .\" mysqlslap: slave option
928 .\" slave option: mysqlslap
929 \fB\-\-slave\fR
930 .sp
931 Follow master locks for other
932 \fBmysqlslap\fR
933 clients\&. Use this option if you are trying to synchronize around one master server with
934 \fB\-\-lock\-directory\fR
935 plus NFS\&. This option was added in MySQL 5\&.1\&.5 and removed in 5\&.1\&.18\&.
936 .RE
937 .sp
938 .RS 4
939 .ie n \{\
940 \h'-04'\(bu\h'+03'\c
941 .\}
942 .el \{\
943 .sp -1
944 .IP \(bu 2.3
945 .\}
946 .\" mysqlslap: socket option
947 .\" socket option: mysqlslap
948 \fB\-\-socket=\fR\fB\fIpath\fR\fR,
949 \fB\-S \fR\fB\fIpath\fR\fR
950 .sp
951 For connections to
952 localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&.
953 .RE
954 .sp
955 .RS 4
956 .ie n \{\
957 \h'-04'\(bu\h'+03'\c
958 .\}
959 .el \{\
960 .sp -1
961 .IP \(bu 2.3
962 .\}
963 .\" mysqlslap: SSL options
964 .\" SSL options: mysqlslap
965 \fB\-\-ssl*\fR
966 .sp
967 Options that begin with
968 \fB\-\-ssl\fR
969 specify whether to connect to the server using SSL and indicate where to find SSL keys and certificates\&. See
970 Section\ \&6.3.6.4, \(lqSSL Command Options\(rq\&.
971 .RE
972 .sp
973 .RS 4
974 .ie n \{\
975 \h'-04'\(bu\h'+03'\c
976 .\}
977 .el \{\
978 .sp -1
979 .IP \(bu 2.3
980 .\}
981 .\" mysqlslap: use-threads option
982 .\" use-threads option: mysqlslap
983 \fB\-\-use\-threads\fR
984 .sp
985 On Unix, the default is to use
986 fork()
987 calls and this option causes
988 \fBpthread\fR
989 calls to be used instead\&. (On Windows, the default is to use
990 pthread
991 calls and the option has no effect\&.) This option was added in MySQL 5\&.1\&.6 and removed in 5\&.1\&.18\&.
992 .RE
993 .sp
994 .RS 4
995 .ie n \{\
996 \h'-04'\(bu\h'+03'\c
997 .\}
998 .el \{\
999 .sp -1
1000 .IP \(bu 2.3
1001 .\}
1002 .\" mysqlslap: user option
1003 .\" user option: mysqlslap
1004 \fB\-\-user=\fR\fB\fIuser_name\fR\fR,
1005 \fB\-u \fR\fB\fIuser_name\fR\fR
1006 .sp
1007 The MySQL user name to use when connecting to the server\&.
1008 .RE
1009 .sp
1010 .RS 4
1011 .ie n \{\
1012 \h'-04'\(bu\h'+03'\c
1013 .\}
1014 .el \{\
1015 .sp -1
1016 .IP \(bu 2.3
1017 .\}
1018 .\" mysqlslap: verbose option
1019 .\" verbose option: mysqlslap
1020 \fB\-\-verbose\fR,
1021 \fB\-v\fR
1022 .sp
1023 Verbose mode\&. Print more information about what the program does\&. This option can be used multiple times to increase the amount of information\&.
1024 .RE
1025 .sp
1026 .RS 4
1027 .ie n \{\
1028 \h'-04'\(bu\h'+03'\c
1029 .\}
1030 .el \{\
1031 .sp -1
1032 .IP \(bu 2.3
1033 .\}
1034 .\" mysqlslap: version option
1035 .\" version option: mysqlslap
1036 \fB\-\-version\fR,
1037 \fB\-V\fR
1038 .sp
1039 Display version information and exit\&.
1040 .RE
1041 .SH "COPYRIGHT"
1042 .br
1043 .PP
1044 Copyright \(co 1997, 2013, Oracle and/or its affiliates. All rights reserved.
1045 .PP
1046 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.
1047 .PP
1048 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.
1049 .PP
1050 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/.
1051 .sp
1052 .SH "SEE ALSO"
1053 For more information, please refer to the MySQL Reference Manual,
1054 which may already be installed locally and which is also available
1055 online at http://dev.mysql.com/doc/.
1056 .SH AUTHOR
1057 Oracle Corporation (http://dev.mysql.com/).