You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

232 lines
5.7 KiB

  1. '\" t
  2. .\" Title: \fBmysql_convert_table_format\fR
  3. .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
  5. .\" Date: 04/06/2010
  6. .\" Manual: MySQL Database System
  7. .\" Source: MySQL 5.1
  8. .\" Language: English
  9. .\"
  10. .TH "\FBMYSQL_CONVERT_TAB" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System"
  11. .\" -----------------------------------------------------------------
  12. .\" * set default formatting
  13. .\" -----------------------------------------------------------------
  14. .\" disable hyphenation
  15. .nh
  16. .\" disable justification (adjust text to left margin only)
  17. .ad l
  18. .\" -----------------------------------------------------------------
  19. .\" * MAIN CONTENT STARTS HERE *
  20. .\" -----------------------------------------------------------------
  21. .\" mysql_convert_table_format
  22. .SH "NAME"
  23. mysql_convert_table_format \- convert tables to use a given storage engine
  24. .SH "SYNOPSIS"
  25. .HP \w'\fBmysql_convert_table_format\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIdb_name\fR\fR\ 'u
  26. \fBmysql_convert_table_format [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR
  27. .SH "DESCRIPTION"
  28. .PP
  29. \fBmysql_convert_table_format\fR
  30. converts the tables in a database to use a particular storage engine (MyISAM
  31. by default)\&.
  32. \fBmysql_convert_table_format\fR
  33. is written in Perl and requires that the
  34. DBI
  35. and
  36. DBD::mysql
  37. Perl modules be installed (see
  38. Section\ \&2.15, \(lqPerl Installation Notes\(rq)\&.
  39. .PP
  40. Invoke
  41. \fBmysql_convert_table_format\fR
  42. like this:
  43. .sp
  44. .if n \{\
  45. .RS 4
  46. .\}
  47. .nf
  48. shell> \fBmysql_convert_table_format [\fR\fB\fIoptions\fR\fR\fB]\fR\fB\fIdb_name\fR\fR
  49. .fi
  50. .if n \{\
  51. .RE
  52. .\}
  53. .PP
  54. The
  55. \fIdb_name\fR
  56. argument indicates the database containing the tables to be converted\&.
  57. .PP
  58. \fBmysql_convert_table_format\fR
  59. supports the options described in the following list\&.
  60. .sp
  61. .RS 4
  62. .ie n \{\
  63. \h'-04'\(bu\h'+03'\c
  64. .\}
  65. .el \{\
  66. .sp -1
  67. .IP \(bu 2.3
  68. .\}
  69. .\" mysql_convert_table_format: help option
  70. .\" help option: mysql_convert_table_format
  71. \fB\-\-help\fR
  72. .sp
  73. Display a help message and exit\&.
  74. .RE
  75. .sp
  76. .RS 4
  77. .ie n \{\
  78. \h'-04'\(bu\h'+03'\c
  79. .\}
  80. .el \{\
  81. .sp -1
  82. .IP \(bu 2.3
  83. .\}
  84. .\" mysql_convert_table_format: force option
  85. .\" force option: mysql_convert_table_format
  86. \fB\-\-force\fR
  87. .sp
  88. Continue even if errors occur\&.
  89. .RE
  90. .sp
  91. .RS 4
  92. .ie n \{\
  93. \h'-04'\(bu\h'+03'\c
  94. .\}
  95. .el \{\
  96. .sp -1
  97. .IP \(bu 2.3
  98. .\}
  99. .\" mysql_convert_table_format: host option
  100. .\" host option: mysql_convert_table_format
  101. \fB\-\-host=\fR\fB\fIhost_name\fR\fR
  102. .sp
  103. Connect to the MySQL server on the given host\&.
  104. .RE
  105. .sp
  106. .RS 4
  107. .ie n \{\
  108. \h'-04'\(bu\h'+03'\c
  109. .\}
  110. .el \{\
  111. .sp -1
  112. .IP \(bu 2.3
  113. .\}
  114. .\" mysql_convert_table_format: password option
  115. .\" password option: mysql_convert_table_format
  116. \fB\-\-password=\fR\fB\fIpassword\fR\fR
  117. .sp
  118. The password to use when connecting to the server\&. Note that the password value is not optional for this option, unlike for other MySQL programs\&.
  119. .sp
  120. Specifying a password on the command line should be considered insecure\&. See
  121. Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
  122. .RE
  123. .sp
  124. .RS 4
  125. .ie n \{\
  126. \h'-04'\(bu\h'+03'\c
  127. .\}
  128. .el \{\
  129. .sp -1
  130. .IP \(bu 2.3
  131. .\}
  132. .\" mysql_convert_table_format: port option
  133. .\" port option: mysql_convert_table_format
  134. \fB\-\-port=\fR\fB\fIport_num\fR\fR
  135. .sp
  136. The TCP/IP port number to use for the connection\&.
  137. .RE
  138. .sp
  139. .RS 4
  140. .ie n \{\
  141. \h'-04'\(bu\h'+03'\c
  142. .\}
  143. .el \{\
  144. .sp -1
  145. .IP \(bu 2.3
  146. .\}
  147. .\" mysql_convert_table_format: socket option
  148. .\" socket option: mysql_convert_table_format
  149. \fB\-\-socket=\fR\fB\fIpath\fR\fR
  150. .sp
  151. For connections to
  152. localhost, the Unix socket file to use\&.
  153. .RE
  154. .sp
  155. .RS 4
  156. .ie n \{\
  157. \h'-04'\(bu\h'+03'\c
  158. .\}
  159. .el \{\
  160. .sp -1
  161. .IP \(bu 2.3
  162. .\}
  163. .\" mysql_convert_table_format: type option
  164. .\" type option: mysql_convert_table_format
  165. \fB\-\-type=\fR\fB\fIengine_name\fR\fR
  166. .sp
  167. Specify the storage engine that the tables should be converted to use\&. The default is
  168. MyISAM
  169. if this option is not given\&.
  170. .RE
  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. .\" mysql_convert_table_format: user option
  181. .\" user option: mysql_convert_table_format
  182. \fB\-\-user=\fR\fB\fIuser_name\fR\fR
  183. .sp
  184. The MySQL user name to use when connecting to the server\&.
  185. .RE
  186. .sp
  187. .RS 4
  188. .ie n \{\
  189. \h'-04'\(bu\h'+03'\c
  190. .\}
  191. .el \{\
  192. .sp -1
  193. .IP \(bu 2.3
  194. .\}
  195. .\" mysql_convert_table_format: verbose option
  196. .\" verbose option: mysql_convert_table_format
  197. \fB\-\-verbose\fR
  198. .sp
  199. Verbose mode\&. Print more information about what the program does\&.
  200. .RE
  201. .sp
  202. .RS 4
  203. .ie n \{\
  204. \h'-04'\(bu\h'+03'\c
  205. .\}
  206. .el \{\
  207. .sp -1
  208. .IP \(bu 2.3
  209. .\}
  210. .\" mysql_convert_table_format: version option
  211. .\" version option: mysql_convert_table_format
  212. \fB\-\-version\fR
  213. .sp
  214. Display version information and exit\&.
  215. .RE
  216. .SH "COPYRIGHT"
  217. .br
  218. .PP
  219. Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
  220. .PP
  221. 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.
  222. .PP
  223. 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.
  224. .PP
  225. 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/.
  226. .sp
  227. .SH "SEE ALSO"
  228. For more information, please refer to the MySQL Reference Manual,
  229. which may already be installed locally and which is also available
  230. online at http://dev.mysql.com/doc/.
  231. .SH AUTHOR
  232. Sun Microsystems, Inc. (http://www.mysql.com/).