Author: paul
Date: 2008-02-20 20:47:10 +0100 (Wed, 20 Feb 2008)
New Revision: 9946
Log:
r29378@frost: paul | 2008-02-20 13:27:08 -0600
Add the remaining new-in-6.0 mysqlslap options.
Modified:
trunk/dynamic-docs/command-optvars/mysqlslap.xml
trunk/refman-6.0/programs-client-core.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:34985
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:29375
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:29465
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:34985
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:29378
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:29465
Modified: trunk/dynamic-docs/command-optvars/mysqlslap.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/mysqlslap.xml 2008-02-20 19:38:01 UTC (rev 9945)
+++ trunk/dynamic-docs/command-optvars/mysqlslap.xml 2008-02-20 19:47:10 UTC (rev 9946)
Changed blocks: 17, Lines Added: 402, Lines Deleted: 298; 34834 bytes
@@ -410,6 +410,110 @@
</mysqloption>
+ <mysqloption id="concurrency">
+
+ <xrefto id="option_mysqlslap_concurrency"/>
+
+ <name>concurrency</name>
+
+ <shortdescription lang="en">
+ The number of clients to simulate when issuing the SELECT
+ statement
+ </shortdescription>
+
+ <types>
+ <optype class="cmdline" format="--concurrency=#"/>
+ <optype class="cmdline" format="-c N"/>
+ <optype class="mycnf"/>
+ </types>
+
+ <values vartype="numeric" platform="all"/>
+
+ <versions>
+ <manual version="5.1"/>
+ <manual version="5.2"/>
+ <manual version="6.0"/>
+ </versions>
+
+ </mysqloption>
+
+ <mysqloption id="create">
+
+ <xrefto id="option_mysqlslap_create"/>
+
+ <name>create</name>
+
+ <shortdescription lang="en">
+ The file or string containing the statement to use for creating
+ the table
+ </shortdescription>
+
+ <types>
+ <optype class="cmdline" format="--create=value"/>
+ <optype class="mycnf"/>
+ </types>
+
+ <values vartype="string" platform="all"/>
+
+ <versions>
+ <manual version="5.1"/>
+ <manual version="5.2"/>
+ <manual version="6.0"/>
+ </versions>
+
+ </mysqloption>
+
+ <mysqloption id="create-schema">
+
+ <xrefto id="option_mysqlslap_create-schema"/>
+
+ <name>create</name>
+
+ <shortdescription lang="en">
+ The schema in which to run the tests
+ </shortdescription>
+
+ <types>
+ <optype class="cmdline" format="--create-schema=value" inversion="5.1.5"/>
+ <optype class="mycnf"/>
+ </types>
+
+ <values vartype="string" platform="all"/>
+
+ <versions>
+ <manual version="5.1"/>
+ <introduced version="5.1.5"/>
+ <manual version="5.2"/>
+ <manual version="6.0"/>
+ </versions>
+
+ </mysqloption>
+
+ <mysqloption id="csv">
+
+ <xrefto id="option_mysqlslap_csv"/>
+
+ <name>csv</name>
+
+ <shortdescription lang="en">
+ Generate output in comma-separated values format
+ </shortdescription>
+
+ <types>
+ <optype class="cmdline" format="--csv=[file]" inversion="5.1.5"/>
+ <optype class="mycnf"/>
+ </types>
+
+ <values vartype="filename" platform="all"/>
+
+ <versions>
+ <manual version="5.1"/>
+ <manual version="5.2"/>
+ <manual version="6.0"/>
+ </versions>
+
+ </mysqloption>
+
<mysqloption id="debug">
<xrefto id="option_mysqlslap_debug"/>
@@ -508,18 +612,19 @@
</mysqloption>
- <mysqloption id="detach">
+ <mysqloption id="delayed-start">
- <xrefto id="option-mysqlslap_detach"/>
+ <xrefto id="option-mysqlslap_delayed-start"/>
- <name>detach</name>
+ <name>delayed-start</name>
<shortdescription lang="en">
- Detach (close and reopen) each connection after each N statements
+ Delay each thread start by random number of microseconds up to
+ this maximum
</shortdescription>
<types>
- <optype class="cmdline" format="--detach=#"/>
+ <optype class="cmdline" format="--delayed-start=#"/>
<optype class="mycnf"/>
</types>
@@ -530,36 +635,30 @@
</values>
<versions>
- <manual version="5.1"/>
- <introduced version="5.1.21"/>
- <manual version="5.2"/>
<manual version="6.0"/>
+ <introduced version="6.0.3"/>
</versions>
</mysqloption>
- <mysqloption id="host">
+ <mysqloption id="delimiter">
- <xrefto id="option_mysqlslap_host"/>
+ <xrefto id="option_mysqlslap_delimiter"/>
- <name>host</name>
+ <name>delimiter</name>
<shortdescription lang="en">
- Connect to the MySQL server on the given host
+ The delimiter to use in SQL statements
</shortdescription>
<types>
- <optype class="cmdline" format="--host=host_name"/>
- <optype class="cmdline" format="-h host_name"/>
+ <optype class="cmdline" format="--delimiter=str"/>
+ <optype class="cmdline" format="-F str"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all">
+ <values vartype="string" platform="all"/>
- <value default="localhost"/>
-
- </values>
-
<versions>
<manual version="5.1"/>
<manual version="5.2"/>
@@ -568,54 +667,53 @@
</mysqloption>
- <mysqloption id="password">
+ <mysqloption id="detach">
- <xrefto id="option_mysqlslap_password"/>
+ <xrefto id="option-mysqlslap_detach"/>
- <name>password</name>
+ <name>detach</name>
<shortdescription lang="en">
- The password to use when connecting to the server
+ Detach (close and reopen) each connection after each N statements
</shortdescription>
<types>
- <optype class="cmdline" format="--password[=password]"/>
- <optype class="cmdline" format="-p[password]"/>
+ <optype class="cmdline" format="--detach=#"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all"/>
+ <values vartype="numeric" platform="all">
+ <value default="0"/>
+
+ </values>
+
<versions>
<manual version="5.1"/>
+ <introduced version="5.1.21"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="port">
+ <mysqloption id="engine">
- <xrefto id="option_mysqlslap_port"/>
+ <xrefto id="option_mysqlslap_engine"/>
- <name>port</name>
+ <name>engine</name>
<shortdescription lang="en">
- The TCP/IP port number to use for the connection
+ The storage engine to use for creating the table
</shortdescription>
<types>
- <optype class="cmdline" format="--port=port_num"/>
- <optype class="cmdline" format="-P port_num"/>
+ <optype class="cmdline" format="--engine=engine_name"/>
<optype class="mycnf"/>
</types>
- <values vartype="numeric" platform="all">
+ <values vartype="string" platform="all"/>
- <value default="3306"/>
-
- </values>
-
<versions>
<manual version="5.1"/>
<manual version="5.2"/>
@@ -624,27 +722,25 @@
</mysqloption>
- <mysqloption id="protocol">
+ <mysqloption id="host">
- <xrefto id="option_mysqlslap_protocol"/>
+ <xrefto id="option_mysqlslap_host"/>
- <name>protocol</name>
+ <name>host</name>
<shortdescription lang="en">
- The connection protocol to use
+ Connect to the MySQL server on the given host
</shortdescription>
<types>
- <optype class="cmdline" format="--protocol={TCP|SOCKET|PIPE|MEMORY}"/>
+ <optype class="cmdline" format="--host=host_name"/>
+ <optype class="cmdline" format="-h host_name"/>
<optype class="mycnf"/>
</types>
<values vartype="string" platform="all">
- <choice value="TCP"/>
- <choice value="SOCKET"/>
- <choice value="PIPE"/>
- <choice value="MEMORY"/>
+ <value default="localhost"/>
</values>
@@ -656,47 +752,52 @@
</mysqloption>
- <mysqloption id="set-random-seed">
+ <mysqloption id="ignore-sql-errors">
- <xrefto id="option_mysqlslap_set-random-seed"/>
+ <xrefto id="option_mysqlslap_ignore-sql-errors"/>
- <name>set-random-seed</name>
+ <name>ignore-sql-errors</name>
<shortdescription lang="en">
- The seed value for the randomizer
+ Ignore SQL errors during the test run
</shortdescription>
<types>
- <optype class="cmdline" format="--set-random-seed=#"/>
+ <optype class="cmdline" format="--ignore-sql-errors"/>
<optype class="mycnf"/>
</types>
- <values vartype="numeric" platform="all"/>
+ <values vartype="boolean" platform="all">
+ <value default="FALSE"/>
+
+ </values>
+
<versions>
- <manual version="5.2"/>
- <introduced version="5.2.6"/>
<manual version="6.0"/>
+ <introduced version="6.0.4"/>
</versions>
</mysqloption>
- <mysqloption id="silent">
+ <mysqloption id="iterations">
- <xrefto id="option_mysqlslap_silent"/>
+ <xrefto id="option_mysqlslap_iterations"/>
- <name>silent</name>
+ <name>iterations</name>
<shortdescription lang="en">
- Silent mode
+ The number of times to run the tests
</shortdescription>
<types>
- <optype class="cmdline" format="--silent"/>
- <optype class="cmdline" format="-s"/>
+ <optype class="cmdline" format="--iterations=#"/>
+ <optype class="cmdline" format="-i N"/>
<optype class="mycnf"/>
</types>
+ <values vartype="numeric" platform="all"/>
+
<versions>
<manual version="5.1"/>
<manual version="5.2"/>
@@ -705,96 +806,99 @@
</mysqloption>
- <mysqloption id="socket">
+ <mysqloption id="label">
- <xrefto id="option_mysqlslap_socket"/>
+ <xrefto id="option_mysqlslap_label"/>
- <name>socket</name>
+ <name>label</name>
<shortdescription lang="en">
- For connections to localhost
+ The label to use in SQL statements
</shortdescription>
<types>
- <optype class="cmdline" format="--socket=path"/>
- <optype class="cmdline" format="-S path"/>
+ <optype class="cmdline" format="--label=str"/>
<optype class="mycnf"/>
</types>
<values vartype="string" platform="all"/>
<versions>
- <manual version="5.1"/>
- <manual version="5.2"/>
<manual version="6.0"/>
+ <introduced version="6.0.3"/>
</versions>
</mysqloption>
- <mysqloption id="user">
+ <mysqloption id="lock-directory">
- <xrefto id="option_mysqlslap_user"/>
+ <xrefto id="option_mysqlslap_lock-directory"/>
- <name>user</name>
+ <name>lock-directory</name>
<shortdescription lang="en">
- The MySQL username to use when connecting to the server
+ The directory to use for storing locks
</shortdescription>
<types>
- <optype class="cmdline" format="--user=user_name,"/>
- <optype class="cmdline" format="-u user_name"/>
+ <optype class="cmdline" format="--lock-directory=path" inversion="5.1.5"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all"/>
+ <values vartype="filename" platform="all"/>
<versions>
<manual version="5.1"/>
- <manual version="5.2"/>
- <manual version="6.0"/>
+ <introduced version="5.1.5"/>
+ <removed version="5.1.18"/>
</versions>
</mysqloption>
- <mysqloption id="verbose">
+ <mysqloption id="number-blob-cols">
- <xrefto id="option_mysqlslap_verbose"/>
+ <xrefto id="option_mysqlslap_number-blob-cols"/>
- <name>verbose</name>
+ <name>number-blob-cols</name>
<shortdescription lang="en">
- Verbose mode
+ The number of BLOB columns to use if --auto-generate-sql is
+ specified
</shortdescription>
<types>
- <optype class="cmdline" format="--verbose"/>
- <optype class="cmdline" format="-v"/>
+ <optype class="cmdline" format="--number-blob-cols=#"/>
+ <optype class="mycnf"/>
</types>
+ <values vartype="string" platform="all"/>
+
<versions>
- <manual version="5.1"/>
- <manual version="5.2"/>
<manual version="6.0"/>
+ <introduced version="6.0.3"/>
</versions>
</mysqloption>
- <mysqloption id="version">
+ <mysqloption id="number-char-cols">
- <xrefto id="option_mysqlslap_version"/>
+ <xrefto id="option_mysqlslap_number-char-cols"/>
- <name>version</name>
+ <name>number-char-cols</name>
<shortdescription lang="en">
- Display version information and exit
+ The number of VARCHAR columns to use if --auto-generate-sql is
+ specified
</shortdescription>
<types>
- <optype class="cmdline" format="--version"/>
- <optype class="cmdline" format="-V"/>
+ <optype class="cmdline" format="--number-char-cols=#"/>
+ <optype class="cmdline" format="-x N"/>
+ <optype class="mycnf"/>
</types>
+ <values vartype="numeric" platform="all"/>
+
<versions>
<manual version="5.1"/>
<manual version="5.2"/>
@@ -803,24 +907,24 @@
</mysqloption>
- <mysqloption section="ssl" id="ssl-ca">
+ <mysqloption id="number-int-cols">
-<!--xref for ssl vars may not be accurate-->
+ <xrefto id="option_mysqlslap_number-int-cols"/>
- <xrefto id="option_mysqlslap_ssl"/>
+ <name>number-int-cols</name>
- <name>ssl-ca</name>
-
<shortdescription lang="en">
- The path to a file that contains a list of trusted SSL CAs
+ The number of INT columns to use if --auto-generate-sql is
+ specified
</shortdescription>
<types>
- <optype class="cmdline" format="--ssl-ca=file_name"/>
+ <optype class="cmdline" format="--number-int-cols=#"/>
+ <optype class="cmdline" format="-y N"/>
<optype class="mycnf"/>
</types>
- <values vartype="filename" platform="all"/>
+ <values vartype="numeric" platform="all"/>
<versions>
<manual version="5.1"/>
@@ -830,74 +934,80 @@
</mysqloption>
- <mysqloption section="ssl" id="ssl-capath">
+ <mysqloption id="number-of-queries">
- <xrefto id="option_mysqlslap_ssl"/>
+ <xrefto id="option_mysqlslap_number-of-queries"/>
- <name>ssl-capath</name>
+ <name>number-of-queries</name>
<shortdescription lang="en">
- The path to a directory that contains trusted SSL CA certificates
- in PEM format
+ Limit each client to approximately this number of queries
</shortdescription>
<types>
- <optype class="cmdline" format="--ssl-capath=directory_name"/>
+ <optype class="cmdline" format="--number-of-queries=#" inversion="5.1.5"/>
<optype class="mycnf"/>
</types>
- <values vartype="filename" platform="all"/>
+ <values vartype="numeric" platform="all"/>
<versions>
<manual version="5.1"/>
+ <introduced version="5.1.5"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption section="ssl" id="ssl-cert">
+ <mysqloption id="only-print">
- <xrefto id="option_mysqlslap_ssl"/>
+ <xrefto id="option_mysqlslap_only-print"/>
- <name>ssl-cert</name>
+ <name>only-print</name>
<shortdescription lang="en">
- The name of the SSL certificate file to use for establishing a
- secure connection
+ Do not connect to databases. mysqlslap only prints what it would
+ have done
</shortdescription>
<types>
- <optype class="cmdline" format="--ssl-cert=file_name"/>
+ <optype class="cmdline" format="--only-print"/>
<optype class="mycnf"/>
</types>
- <values vartype="filename" platform="all"/>
+ <values vartype="boolean" platform="all">
+ <value default="FALSE"/>
+
+ </values>
+
<versions>
<manual version="5.1"/>
+ <introduced version="5.1.5"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption section="ssl" id="ssl-cipher">
+ <mysqloption id="password">
- <xrefto id="option_mysqlslap_ssl"/>
+ <xrefto id="option_mysqlslap_password"/>
- <name>ssl-cipher</name>
+ <name>password</name>
<shortdescription lang="en">
- A list of allowable ciphers to use for SSL encryption
+ The password to use when connecting to the server
</shortdescription>
<types>
- <optype class="cmdline" format="--ssl-cipher=cipher_list"/>
+ <optype class="cmdline" format="--password[=password]"/>
+ <optype class="cmdline" format="-p[password]"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all"></values>
+ <values vartype="string" platform="all"/>
<versions>
<manual version="5.1"/>
@@ -907,24 +1017,28 @@
</mysqloption>
- <mysqloption section="ssl" id="ssl-key">
+ <mysqloption id="port">
- <xrefto id="option_mysqlslap_ssl"/>
+ <xrefto id="option_mysqlslap_port"/>
- <name>ssl-key</name>
+ <name>port</name>
<shortdescription lang="en">
- The name of the SSL key file to use for establishing a secure
- connection
+ The TCP/IP port number to use for the connection
</shortdescription>
<types>
- <optype class="cmdline" format="--ssl-key=file_name"/>
+ <optype class="cmdline" format="--port=port_num"/>
+ <optype class="cmdline" format="-P port_num"/>
<optype class="mycnf"/>
</types>
- <values vartype="filename" platform="all"/>
+ <values vartype="numeric" platform="all">
+ <value default="3306"/>
+
+ </values>
+
<versions>
<manual version="5.1"/>
<manual version="5.2"/>
@@ -933,76 +1047,72 @@
</mysqloption>
- <mysqloption section="ssl" id="ssl-verify-server-cert">
+ <mysqloption id="post-query">
- <xrefto id="option_mysqlslap_ssl-verify-server-cert"/>
+ <xrefto id="option_mysqlslap_post-query"/>
- <name>ssl-verify-server-cert</name>
+ <name>post-query</name>
<shortdescription lang="en">
- The server's Common Name value in its certificate is verified
- against the hostname used when connecting to the server
+ The file or string containing the statement to execute after the
+ tests have completed
</shortdescription>
<types>
- <optype class="cmdline" format="--ssl-verify-server-cert"/>
+ <optype class="cmdline" format="--post-query=value"/>
<optype class="mycnf"/>
</types>
- <values vartype="boolean" platform="all">
+ <values vartype="string" platform="all"/>
- <value default="FALSE"/>
-
- </values>
-
<versions>
<manual version="5.1"/>
+ <introduced version="5.1.18"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="concurrency">
+ <mysqloption id="post-system">
- <xrefto id="option_mysqlslap_concurrency"/>
+ <xrefto id="option_mysqlslap_post-system"/>
- <name>concurrency</name>
+ <name>post-system</name>
<shortdescription lang="en">
- The number of clients to simulate when issuing the SELECT
- statement
+ The string to execute via system() after the tests have completed
</shortdescription>
<types>
- <optype class="cmdline" format="--concurrency=#"/>
- <optype class="cmdline" format="-c N"/>
+ <optype class="cmdline" format="--post-system=str"/>
<optype class="mycnf"/>
</types>
- <values vartype="numeric" platform="all"/>
+ <values vartype="string" platform="all"/>
<versions>
<manual version="5.1"/>
+ <introduced version="5.1.21"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="create">
+ <mysqloption id="pre-query">
- <xrefto id="option_mysqlslap_create"/>
+ <xrefto id="option_mysqlslap_pre-query"/>
- <name>create</name>
+ <name>pre-query</name>
<shortdescription lang="en">
- The file or string containing the statement to use for creating
- the table
+ The file or string containing the statement to execute before
+ running the tests
</shortdescription>
<types>
- <optype class="cmdline" format="--create=value"/>
+ <optype class="cmdline" format="--pre-query=value"/>
<optype class="mycnf"/>
</types>
@@ -1010,24 +1120,25 @@
<versions>
<manual version="5.1"/>
+ <introduced version="5.1.18"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="create-schema">
+ <mysqloption id="pre-system">
- <xrefto id="option_mysqlslap_create-schema"/>
+ <xrefto id="option_mysqlslap_pre-system"/>
- <name>create</name>
+ <name>pre-system</name>
<shortdescription lang="en">
- The schema in which to run the tests
+ The string to execute via system()> before running the tests
</shortdescription>
<types>
- <optype class="cmdline" format="--create-schema=value" inversion="5.1.5"/>
+ <optype class="cmdline" format="--pre-system=str"/>
<optype class="mycnf"/>
</types>
@@ -1035,56 +1146,61 @@
<versions>
<manual version="5.1"/>
- <introduced version="5.1.5"/>
+ <introduced version="5.1.21"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="csv">
+ <mysqloption id="preserve-schema">
- <xrefto id="option_mysqlslap_csv"/>
+ <xrefto id="option_mysqlslap_preserve-schema"/>
- <name>csv</name>
+ <name>preserve-schema</name>
<shortdescription lang="en">
- Generate output in comma-separated values format
+ Preserve the schema from the mysqlslap run
</shortdescription>
<types>
- <optype class="cmdline" format="--csv=[file]" inversion="5.1.5"/>
+ <optype class="cmdline" format="--preserve-schema" inversion="5.1.5"/>
<optype class="mycnf"/>
</types>
- <values vartype="filename" platform="all"/>
-
<versions>
<manual version="5.1"/>
+ <introduced version="5.1.5"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="delimiter">
+ <mysqloption id="protocol">
- <xrefto id="option_mysqlslap_delimiter"/>
+ <xrefto id="option_mysqlslap_protocol"/>
- <name>delimiter</name>
+ <name>protocol</name>
<shortdescription lang="en">
- The delimiter to use in SQL statements
+ The connection protocol to use
</shortdescription>
<types>
- <optype class="cmdline" format="--delimiter=str"/>
- <optype class="cmdline" format="-F str"/>
+ <optype class="cmdline" format="--protocol={TCP|SOCKET|PIPE|MEMORY}"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all"/>
+ <values vartype="string" platform="all">
+ <choice value="TCP"/>
+ <choice value="SOCKET"/>
+ <choice value="PIPE"/>
+ <choice value="MEMORY"/>
+
+ </values>
+
<versions>
<manual version="5.1"/>
<manual version="5.2"/>
@@ -1093,128 +1209,120 @@
</mysqloption>
- <mysqloption id="engine">
+ <mysqloption id="set-random-seed">
- <xrefto id="option_mysqlslap_engine"/>
+ <xrefto id="option_mysqlslap_set-random-seed"/>
- <name>engine</name>
+ <name>set-random-seed</name>
<shortdescription lang="en">
- The storage engine to use for creating the table
+ The seed value for the randomizer
</shortdescription>
<types>
- <optype class="cmdline" format="--engine=engine_name"/>
+ <optype class="cmdline" format="--set-random-seed=#"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all"/>
+ <values vartype="numeric" platform="all"/>
<versions>
- <manual version="5.1"/>
<manual version="5.2"/>
+ <introduced version="5.2.6"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="ignore-sql-errors">
+ <mysqloption id="silent">
- <xrefto id="option_mysqlslap_ignore-sql-errors"/>
+ <xrefto id="option_mysqlslap_silent"/>
- <name>ignore-sql-errors</name>
+ <name>silent</name>
<shortdescription lang="en">
- Ignore SQL errors during the test run
+ Silent mode
</shortdescription>
<types>
- <optype class="cmdline" format="--ignore-sql-errors"/>
+ <optype class="cmdline" format="--silent"/>
+ <optype class="cmdline" format="-s"/>
<optype class="mycnf"/>
</types>
- <values vartype="boolean" platform="all">
-
- <value default="FALSE"/>
-
- </values>
-
<versions>
+ <manual version="5.1"/>
+ <manual version="5.2"/>
<manual version="6.0"/>
- <introduced version="6.0.4"/>
</versions>
</mysqloption>
- <mysqloption id="iterations">
+ <mysqloption section="replication" id="slave">
- <xrefto id="option_mysqlslap_iterations"/>
+ <xrefto id="option_mysqlslap_slave"/>
- <name>iterations</name>
+ <name>slave</name>
<shortdescription lang="en">
- The number of times to run the tests
+ Follow master locks for other mysqlslap clients
</shortdescription>
<types>
- <optype class="cmdline" format="--iterations=#"/>
- <optype class="cmdline" format="-i N"/>
+ <optype class="cmdline" format="--slave"/>
<optype class="mycnf"/>
</types>
- <values vartype="numeric" platform="all"/>
-
<versions>
<manual version="5.1"/>
- <manual version="5.2"/>
- <manual version="6.0"/>
+ <introduced version="5.1.5"/>
+ <removed version="5.1.18"/>
</versions>
</mysqloption>
- <mysqloption id="lock-directory">
+ <mysqloption id="socket">
- <xrefto id="option_mysqlslap_lock-directory"/>
+ <xrefto id="option_mysqlslap_socket"/>
- <name>lock-directory</name>
+ <name>socket</name>
<shortdescription lang="en">
- The directory to use for storing locks
+ For connections to localhost
</shortdescription>
<types>
- <optype class="cmdline" format="--lock-directory=path" inversion="5.1.5"/>
+ <optype class="cmdline" format="--socket=path"/>
+ <optype class="cmdline" format="-S path"/>
<optype class="mycnf"/>
</types>
- <values vartype="filename" platform="all"/>
+ <values vartype="string" platform="all"/>
<versions>
<manual version="5.1"/>
- <introduced version="5.1.5"/>
- <removed version="5.1.18"/>
+ <manual version="5.2"/>
+ <manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="number-char-cols">
+ <mysqloption section="ssl" id="ssl-ca">
- <xrefto id="option_mysqlslap_number-char-cols"/>
+ <xrefto id="option_mysqlslap_ssl"/>
- <name>number-char-cols</name>
+ <name>ssl-ca</name>
<shortdescription lang="en">
- The number of VARCHAR columns to use if --auto-generate-sql is
- specified
+ The path to a file that contains a list of trusted SSL CAs
</shortdescription>
<types>
- <optype class="cmdline" format="--number-char-cols=#"/>
- <optype class="cmdline" format="-x N"/>
+ <optype class="cmdline" format="--ssl-ca=file_name"/>
<optype class="mycnf"/>
</types>
- <values vartype="numeric" platform="all"/>
+ <values vartype="filename" platform="all"/>
<versions>
<manual version="5.1"/>
@@ -1224,24 +1332,23 @@
</mysqloption>
- <mysqloption id="number-int-cols">
+ <mysqloption section="ssl" id="ssl-capath">
- <xrefto id="option_mysqlslap_number-int-cols"/>
+ <xrefto id="option_mysqlslap_ssl"/>
- <name>number-int-cols</name>
+ <name>ssl-capath</name>
<shortdescription lang="en">
- The number of INT columns to use if --auto-generate-sql is
- specified
+ The path to a directory that contains trusted SSL CA certificates
+ in PEM format
</shortdescription>
<types>
- <optype class="cmdline" format="--number-int-cols=#"/>
- <optype class="cmdline" format="-y N"/>
+ <optype class="cmdline" format="--ssl-capath=directory_name"/>
<optype class="mycnf"/>
</types>
- <values vartype="numeric" platform="all"/>
+ <values vartype="filename" platform="all"/>
<versions>
<manual version="5.1"/>
@@ -1251,155 +1358,154 @@
</mysqloption>
- <mysqloption id="number-of-queries">
+ <mysqloption section="ssl" id="ssl-cert">
- <xrefto id="option_mysqlslap_number-of-queries"/>
+ <xrefto id="option_mysqlslap_ssl"/>
- <name>number-of-queries</name>
+ <name>ssl-cert</name>
<shortdescription lang="en">
- Limit each client to approximately this number of queries
+ The name of the SSL certificate file to use for establishing a
+ secure connection
</shortdescription>
<types>
- <optype class="cmdline" format="--number-of-queries=#" inversion="5.1.5"/>
+ <optype class="cmdline" format="--ssl-cert=file_name"/>
<optype class="mycnf"/>
</types>
- <values vartype="numeric" platform="all"/>
+ <values vartype="filename" platform="all"/>
<versions>
<manual version="5.1"/>
- <introduced version="5.1.5"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="only-print">
+ <mysqloption section="ssl" id="ssl-cipher">
- <xrefto id="option_mysqlslap_only-print"/>
+ <xrefto id="option_mysqlslap_ssl"/>
- <name>only-print</name>
+ <name>ssl-cipher</name>
<shortdescription lang="en">
- Do not connect to databases. mysqlslap only prints what it would
- have done
+ A list of allowable ciphers to use for SSL encryption
</shortdescription>
<types>
- <optype class="cmdline" format="--only-print"/>
+ <optype class="cmdline" format="--ssl-cipher=cipher_list"/>
<optype class="mycnf"/>
</types>
- <values vartype="boolean" platform="all">
+ <values vartype="string" platform="all"></values>
- <value default="FALSE"/>
-
- </values>
-
<versions>
<manual version="5.1"/>
- <introduced version="5.1.5"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="post-query">
+ <mysqloption section="ssl" id="ssl-key">
- <xrefto id="option_mysqlslap_post-query"/>
+ <xrefto id="option_mysqlslap_ssl"/>
- <name>post-query</name>
+ <name>ssl-key</name>
<shortdescription lang="en">
- The file or string containing the statement to execute after the
- tests have completed
+ The name of the SSL key file to use for establishing a secure
+ connection
</shortdescription>
<types>
- <optype class="cmdline" format="--post-query=value"/>
+ <optype class="cmdline" format="--ssl-key=file_name"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all"/>
+ <values vartype="filename" platform="all"/>
<versions>
<manual version="5.1"/>
- <introduced version="5.1.18"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="post-system">
+ <mysqloption section="ssl" id="ssl-verify-server-cert">
- <xrefto id="option_mysqlslap_post-system"/>
+ <xrefto id="option_mysqlslap_ssl-verify-server-cert"/>
- <name>post-system</name>
+ <name>ssl-verify-server-cert</name>
<shortdescription lang="en">
- The string to execute via system() after the tests have completed
+ The server's Common Name value in its certificate is verified
+ against the hostname used when connecting to the server
</shortdescription>
<types>
- <optype class="cmdline" format="--post-system=str"/>
+ <optype class="cmdline" format="--ssl-verify-server-cert"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all"/>
+ <values vartype="boolean" platform="all">
+ <value default="FALSE"/>
+
+ </values>
+
<versions>
<manual version="5.1"/>
- <introduced version="5.1.21"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="pre-query">
+ <mysqloption id="timer-length">
- <xrefto id="option_mysqlslap_pre-query"/>
+ <xrefto id="option-mysqlslap_timer-length"/>
- <name>pre-query</name>
+ <name>timer-length</name>
<shortdescription lang="en">
- The file or string containing the statement to execute before
- running the tests
+ The duration in seconds to run each test
</shortdescription>
<types>
- <optype class="cmdline" format="--pre-query=value"/>
+ <optype class="cmdline" format="--timer-length=#"/>
<optype class="mycnf"/>
</types>
- <values vartype="string" platform="all"/>
+ <values vartype="numeric" platform="all">
+ <value default="0"/>
+
+ </values>
+
<versions>
- <manual version="5.1"/>
- <introduced version="5.1.18"/>
- <manual version="5.2"/>
<manual version="6.0"/>
+ <introduced version="6.0.3"/>
</versions>
</mysqloption>
- <mysqloption id="pre-system">
+ <mysqloption id="user">
- <xrefto id="option_mysqlslap_pre-system"/>
+ <xrefto id="option_mysqlslap_user"/>
- <name>pre-system</name>
+ <name>user</name>
<shortdescription lang="en">
- The string to execute via system()> before running the tests
+ The MySQL username to use when connecting to the server
</shortdescription>
<types>
- <optype class="cmdline" format="--pre-system=str"/>
+ <optype class="cmdline" format="--user=user_name,"/>
+ <optype class="cmdline" format="-u user_name"/>
<optype class="mycnf"/>
</types>
@@ -1407,79 +1513,77 @@
<versions>
<manual version="5.1"/>
- <introduced version="5.1.21"/>
<manual version="5.2"/>
<manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="preserve-schema">
+ <mysqloption id="use-threads">
- <xrefto id="option_mysqlslap_preserve-schema"/>
+ <xrefto id="option_mysqlslap_use-threads"/>
- <name>preserve-schema</name>
+ <name>use-threads</name>
<shortdescription lang="en">
- Preserve the schema from the mysqlslap run
+ On Unix, the default is to use fork() calls
</shortdescription>
<types>
- <optype class="cmdline" format="--preserve-schema" inversion="5.1.5"/>
+ <optype class="cmdline" format="--use-threads"/>
<optype class="mycnf"/>
</types>
<versions>
<manual version="5.1"/>
- <introduced version="5.1.5"/>
- <manual version="5.2"/>
- <manual version="6.0"/>
+ <introduced version="5.1.6"/>
+ <removed version="5.1.18"/>
</versions>
</mysqloption>
- <mysqloption section="replication" id="slave">
+ <mysqloption id="verbose">
- <xrefto id="option_mysqlslap_slave"/>
+ <xrefto id="option_mysqlslap_verbose"/>
- <name>slave</name>
+ <name>verbose</name>
<shortdescription lang="en">
- Follow master locks for other mysqlslap clients
+ Verbose mode
</shortdescription>
<types>
- <optype class="cmdline" format="--slave"/>
- <optype class="mycnf"/>
+ <optype class="cmdline" format="--verbose"/>
+ <optype class="cmdline" format="-v"/>
</types>
<versions>
<manual version="5.1"/>
- <introduced version="5.1.5"/>
- <removed version="5.1.18"/>
+ <manual version="5.2"/>
+ <manual version="6.0"/>
</versions>
</mysqloption>
- <mysqloption id="use-threads">
+ <mysqloption id="version">
- <xrefto id="option_mysqlslap_use-threads"/>
+ <xrefto id="option_mysqlslap_version"/>
- <name>use-threads</name>
+ <name>version</name>
<shortdescription lang="en">
- On Unix, the default is to use fork() calls
+ Display version information and exit
</shortdescription>
<types>
- <optype class="cmdline" format="--use-threads"/>
- <optype class="mycnf"/>
+ <optype class="cmdline" format="--version"/>
+ <optype class="cmdline" format="-V"/>
</types>
<versions>
<manual version="5.1"/>
- <introduced version="5.1.6"/>
- <removed version="5.1.18"/>
+ <manual version="5.2"/>
+ <manual version="6.0"/>
</versions>
</mysqloption>
Modified: trunk/refman-6.0/programs-client-core.xml
===================================================================
--- trunk/refman-6.0/programs-client-core.xml 2008-02-20 19:38:01 UTC (rev 9945)
+++ trunk/refman-6.0/programs-client-core.xml 2008-02-20 19:47:10 UTC (rev 9946)
Changed blocks: 6, Lines Added: 89, Lines Deleted: 19; 6960 bytes
@@ -8601,7 +8601,9 @@
<para>
The string to use for the select columns used in automatic
- tests. This option was added in MySQL 6.0.3.
+ tests. You can use this to determine the effect on
+ performance of selecting or excluding particular columns.
+ This option was added in MySQL 6.0.3.
</para>
</listitem>
@@ -8908,6 +8910,29 @@
</listitem>
<listitem>
+ <para id="option_mysqlslap_delayed-start">
+ <indexterm>
+ <primary>mysqlslap</primary>
+ <secondary>delayed-start option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>delayed-start option</primary>
+ <secondary>mysqlslap</secondary>
+ </indexterm>
+
+ <option>--delayed-start=<replaceable>N</replaceable></option>
+ </para>
+
+ <para>
+ The maximum delay in microseconds. Startup of each thread is
+ delayed by a random number of microseconds up to this
+ maximum. The default is 0. This option was added in MySQL
+ 6.0.3.
+ </para>
+ </listitem>
+
+ <listitem>
<para id="option_mysqlslap_detach">
<indexterm>
<primary>mysqlslap</primary>
@@ -8946,7 +8971,7 @@
</para>
<para>
- The storage engine to use for creating the table.
+ The storage engine to use for creating tables.
</para>
</listitem>
@@ -8987,7 +9012,8 @@
</para>
<para>
- Ignore SQL errors during the test run. This option was
+ Ignore SQL errors during the test run. By default, errors
+ cause <command>mysqlslap</command> to exit. This option was
added in MySQL 6.0.4.
</para>
</listitem>
@@ -9014,67 +9040,90 @@
</listitem>
<listitem>
- <para id="option_mysqlslap_number-char-cols">
+ <para id="option_mysqlslap_label">
<indexterm>
<primary>mysqlslap</primary>
- <secondary>number-char-cols option</secondary>
+ <secondary>label option</secondary>
</indexterm>
<indexterm>
- <primary>number-char-cols option</primary>
+ <primary>label option</primary>
<secondary>mysqlslap</secondary>
</indexterm>
- <option>--number-char-cols=<replaceable>N</replaceable></option>,
- <option>-x <replaceable>N</replaceable></option>
+ <option>--label=<replaceable>str</replaceable></option>
</para>
<para>
- The number of <literal>VARCHAR</literal> columns to use if
+ The label to use in printed and CSV output. This option was
+ added in MySQL 6.0.3.
+ </para>
+ </listitem>
+ <listitem>
+ <para id="option_mysqlslap_number-blob-cols">
<indexterm>
<primary>mysqlslap</primary>
- <secondary>auto-generate-sql option</secondary>
+ <secondary>number-blob-cols option</secondary>
</indexterm>
<indexterm>
- <primary>auto-generate-sql option</primary>
+ <primary>number-blob-cols option</primary>
<secondary>mysqlslap</secondary>
</indexterm>
+ <option>--number-blob-cols=<replaceable>str</replaceable></option>,
+ </para>
+
+ <para>
+ The number of <literal>BLOB</literal> columns to use if
<option>--auto-generate-sql</option> is specified.
+ <option>--number-blob-cols=3:1024/2048</option> would give
+ you 3 <literal>BLOB</literal> columns with a random size
+ between 1024 and 2048. This option was added in MySQL 6.0.3.
</para>
</listitem>
<listitem>
- <para id="option_mysqlslap_number-int-cols">
+ <para id="option_mysqlslap_number-char-cols">
<indexterm>
<primary>mysqlslap</primary>
- <secondary>number-int-cols option</secondary>
+ <secondary>number-char-cols option</secondary>
</indexterm>
<indexterm>
- <primary>number-int-cols option</primary>
+ <primary>number-char-cols option</primary>
<secondary>mysqlslap</secondary>
</indexterm>
- <option>--number-int-cols=<replaceable>N</replaceable></option>,
- <option>-y <replaceable>N</replaceable></option>
+ <option>--number-char-cols=<replaceable>N</replaceable></option>,
+ <option>-x <replaceable>N</replaceable></option>
</para>
<para>
- The number of <literal>INT</literal> columns to use if
+ The number of <literal>VARCHAR</literal> columns to use if
+ <option>--auto-generate-sql</option> is specified.
+ </para>
+ </listitem>
+ <listitem>
+ <para id="option_mysqlslap_number-int-cols">
<indexterm>
<primary>mysqlslap</primary>
- <secondary>auto-generate-sql option</secondary>
+ <secondary>number-int-cols option</secondary>
</indexterm>
<indexterm>
- <primary>auto-generate-sql option</primary>
+ <primary>number-int-cols option</primary>
<secondary>mysqlslap</secondary>
</indexterm>
+ <option>--number-int-cols=<replaceable>N</replaceable></option>,
+ <option>-y <replaceable>N</replaceable></option>
+ </para>
+
+ <para>
+ The number of <literal>INT</literal> columns to use if
<option>--auto-generate-sql</option> is specified.
</para>
</listitem>
@@ -9447,6 +9496,27 @@
</listitem>
<listitem>
+ <para id="option_mysqlslap_timer-length">
+ <indexterm>
+ <primary>mysqlslap</primary>
+ <secondary>timer-length option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>timer-length option</primary>
+ <secondary>mysqlslap</secondary>
+ </indexterm>
+
+ <option>--timer-length=<replaceable>N</replaceable></option>
+ </para>
+
+ <para>
+ The duration in seconds to run each test. Tests that run
+ longer are terminated. This option was added in MySQL 6.0.3.
+ </para>
+ </listitem>
+
+ <listitem>
<para id="option_mysqlslap_user">
<indexterm>
<primary>mysqlslap</primary>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9946 - in trunk: . dynamic-docs/command-optvars refman-6.0 | paul | 20 Feb |
