.\"     Title: \fBmysqlimport\fR
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
.\"      Date: 01/11/2008
.\"    Manual: MySQL Database System
.\"    Source: MySQL 5.0
.\"
.TH "\fBMYSQLIMPORT\fR" "1" "01/11/2008" "MySQL 5.0" "MySQL Database System"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
mysqlimport \- a data import program
.SH "SYNOPSIS"
.HP 44
\fBmysqlimport [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB \fR\fB\fItextfile1\fR\fR\fB ...\fR
.SH "DESCRIPTION"
.PP
The
\fBmysqlimport\fR
client provides a command\-line interface to the
LOAD DATA INFILE
SQL statement. Most options to
\fBmysqlimport\fR
correspond directly to clauses of
LOAD DATA INFILE
syntax. See
Section\ 2.5, \(lqLOAD DATA INFILE Syntax\(rq.
.PP
Invoke
\fBmysqlimport\fR
like this:
.sp
.RS 3n
.nf
shell> \fBmysqlimport [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB \fR\fB\fItextfile1\fR\fR\fB [\fR\fB\fItextfile2\fR\fR\fB ...]\fR
.fi
.RE
.PP
For each text file named on the command line,
\fBmysqlimport\fR
strips any extension from the filename and uses the result to determine the name of the table into which to import the file's contents. For example, files named
\fIpatient.txt\fR,
\fIpatient.text\fR, and
\fIpatient\fR
all would be imported into a table named
patient.
.PP
\fBmysqlimport\fR
supports the following options:
.PP
.B Table\ 4.6.\ \fBmysqlimport\fR Option Reference
.sp -1n
.TS
allbox tab(:);
lB lB lB lB.
T{
\fBFormat\fR
T}:T{
\fBConfig File\fR
T}:T{
\fBDescription\fR
T}:T{
\fBIntroduced\fR
T}
.T&
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l
l l ^ l
l l l l
l l ^ l
l l l l
l l ^ l
l l ^ l
l l l l
l l ^ l
l l l l
l l l l
l l l l
l l ^ l
l l l l
l l ^ l
l l l l
l l l l
l l l l
l l ^ l
l l l l
l l ^ l
l l l l
l l l l
l l l l
l l ^ l
l l l l
l l ^ l
l l l l
l l ^ l
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l
l l ^ l
l l l l
l l ^ l
l l l l
l l l l
l l ^ l
l l ^ l
l l l l
l l l l
l l ^ l.
T{
\-\-columns=column_list
T}:T{
columns
T}:T{
This option takes a comma\-separated list of column names as its  value
T}:T{
\ 
T}
T{
\-\-fields\-enclosed\-by=string
T}:T{
fields\-enclosed\-by
T}:T{
This option has the same meaning as the corresponding clause for  LOAD DATA INFILE
T}:T{
\ 
T}
T{
\-\-fields\-escaped\-by
T}:T{
fields\-escaped\-by
T}:T{
This option has the same meaning as the corresponding clause for  LOAD DATA INFILE
T}:T{
\ 
T}
T{
\-\-fields\-optionally\-enclosed\-by=string
T}:T{
fields\-optionally\-enclosed\-by
T}:T{
This option has the same meaning as the corresponding clause for  LOAD DATA INFILE
T}:T{
\ 
T}
T{
\-\-fields\-terminated\-by=string
T}:T{
fields\-terminated\-by
T}:T{
\-\- This option has the same meaning as the corresponding clause  for LOAD DATA INFILE
T}:T{
\ 
T}
T{
\-\-force
T}:T{
force
T}:T{
Continue even if an SQL error occurs
T}:T{
\ 
T}
T{
\-f
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-help
T}:T{
\ 
T}:T{
Display help message and exit
T}:T{
\ 
T}
T{
\-?
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-host=host_name
T}:T{
host
T}:T{
Connect to the MySQL server on the given host
T}:T{
\ 
T}
T{
\-h host_name
T}:T{
\ 
T}::T{
\ 
T}
T{
\-c columns_list
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-ignore
T}:T{
ignore
T}:T{
See the description for the \-\-replace option
T}:T{
\ 
T}
T{
\-i
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-ignore\-lines=N
T}:T{
ignore\-lines
T}:T{
Ignore the first N lines of the data file
T}:T{
\ 
T}
T{
\-\-lines\-terminated\-by=string
T}:T{
lines\-terminated\-by
T}:T{
This option has the same meaning as the corresponding clause for  LOAD DATA INFILE
T}:T{
\ 
T}
T{
\-\-local
T}:T{
local
T}:T{
Read input files locally from the client host
T}:T{
\ 
T}
T{
\-L
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-lock\-tables
T}:T{
lock\-tables
T}:T{
Lock all tables for writing before processing any text files
T}:T{
\ 
T}
T{
\-l
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-low\-priority
T}:T{
low\-priority
T}:T{
Use LOW_PRIORITY when loading the table.
T}:T{
\ 
T}
T{
\-\-password[=password]
T}:T{
password
T}:T{
The password to use when connecting to the server
T}:T{
\ 
T}
T{
\-\-compress
T}:T{
compress
T}:T{
Compress all information sent between the client and the server
T}:T{
\ 
T}
T{
\-p[password]
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-port=port_num
T}:T{
port
T}:T{
The TCP/IP port number to use for the connection
T}:T{
\ 
T}
T{
\-P port_num
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-protocol={TCP|SOCKET|PIPE|MEMORY}
T}:T{
protocol
T}:T{
The connection protocol to use
T}:T{
\ 
T}
T{
\-\-replace
T}:T{
replace
T}:T{
The \-\-replace and \-\-ignore options control handling of input rows  that duplicate existing rows on unique key values
T}:T{
\ 
T}
T{
\-\-silent
T}:T{
silent
T}:T{
Produce output only when errors occur
T}:T{
\ 
T}
T{
\-s
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-socket=path
T}:T{
socket
T}:T{
For connections to localhost
T}:T{
\ 
T}
T{
\-S path
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-ssl\-ca=file_name
T}:T{
ssl\-ca
T}:T{
The path to a file that contains a list of trusted SSL CAs
T}:T{
\ 
T}
T{
\-C
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-ssl\-capath=directory_name
T}:T{
ssl\-capath
T}:T{
The path to a directory that contains trusted SSL CA certificates  in PEM format
T}:T{
\ 
T}
T{
\-\-ssl\-cert=file_name
T}:T{
ssl\-cert
T}:T{
The name of the SSL certificate file to use for establishing a  secure connection
T}:T{
\ 
T}
T{
\-\-ssl\-cipher=cipher_list
T}:T{
ssl\-cipher
T}:T{
A list of allowable ciphers to use for SSL encryption
T}:T{
\ 
T}
T{
\-\-ssl\-key=file_name
T}:T{
ssl\-key
T}:T{
The name of the SSL key file to use for establishing a secure  connection
T}:T{
\ 
T}
T{
\-\-ssl\-verify\-server\-cert
T}:T{
ssl\-verify\-server\-cert
T}:T{
The server's Common Name value in its certificate is verified  against the hostname used when connecting to the server
T}:T{
\ 
T}
T{
\-\-user=user_name,
T}:T{
user
T}:T{
The MySQL username to use when connecting to the server
T}:T{
\ 
T}
T{
\-u user_name
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-verbose
T}:T{
\ 
T}:T{
Verbose mode
T}:T{
\ 
T}
T{
\-v
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-version
T}:T{
\ 
T}:T{
Display version information and exit
T}:T{
\ 
T}
T{
\-# [debug_options]
T}:T{
debug
T}:T{
Write a debugging log
T}:T{
\ 
T}
T{
\-V
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-debug[=debug_options]
T}:T{
\ 
T}::T{
\ 
T}
T{
\-\-default\-character\-set=charset_name
T}:T{
default\-character\-set
T}:T{
Use charset_name as the default character set
T}:T{
\ 
T}
T{
\-\-delete
T}:T{
delete
T}:T{
Empty the table before importing the text file
T}:T{
\ 
T}
T{
\-D
T}:T{
\ 
T}::T{
\ 
T}
.TE
.sp
.TP 3n
\(bu
\fB\-\-help\fR,
\fB\-?\fR
.sp
Display a help message and exit.
.TP 3n
\(bu
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed. See
Section\ 2, \(lqThe Character Set Used for Data and Sorting\(rq.
.TP 3n
\(bu
\fB\-\-columns=\fR\fB\fIcolumn_list\fR\fR,
\fB\-c \fR\fB\fIcolumn_list\fR\fR
.sp
This option takes a comma\-separated list of column names as its value. The order of the column names indicates how to match data file columns with table columns.
.TP 3n
\(bu
\fB\-\-compress\fR,
\fB\-C\fR
.sp
Compress all information sent between the client and the server if both support compression.
.TP 3n
\(bu
\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR
.sp
Write a debugging log. The
\fIdebug_options\fR
string often is
\'d:t:o,\fIfile_name\fR'.
.TP 3n
\(bu
\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR
.sp
Use
\fIcharset_name\fR
as the default character set. See
Section\ 2, \(lqThe Character Set Used for Data and Sorting\(rq.
.TP 3n
\(bu
\fB\-\-delete\fR,
\fB\-D\fR
.sp
Empty the table before importing the text file.
.TP 3n
\(bu
\fB\-\-fields\-terminated\-by=...\fR,
\fB\-\-fields\-enclosed\-by=...\fR,
\fB\-\-fields\-optionally\-enclosed\-by=...\fR,
\fB\-\-fields\-escaped\-by=...\fR
.sp
These options have the same meaning as the corresponding clauses for
LOAD DATA INFILE. See
Section\ 2.5, \(lqLOAD DATA INFILE Syntax\(rq.
.TP 3n
\(bu
\fB\-\-force\fR,
\fB\-f\fR
.sp
Ignore errors. For example, if a table for a text file does not exist, continue processing any remaining files. Without
\fB\-\-force\fR,
\fBmysqlimport\fR
exits if a table does not exist.
.TP 3n
\(bu
\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
\fB\-h \fR\fB\fIhost_name\fR\fR
.sp
Import data to the MySQL server on the given host. The default host is
localhost.
.TP 3n
\(bu
\fB\-\-ignore\fR,
\fB\-i\fR
.sp
See the description for the
\fB\-\-replace\fR
option.
.TP 3n
\(bu
\fB\-\-ignore\-lines=\fR\fB\fIN\fR\fR
.sp
Ignore the first
\fIN\fR
lines of the data file.
.TP 3n
\(bu
\fB\-\-lines\-terminated\-by=...\fR
.sp
This option has the same meaning as the corresponding clause for
LOAD DATA INFILE. For example, to import Windows files that have lines terminated with carriage return/linefeed pairs, use
\fB\-\-lines\-terminated\-by="\\r\\n"\fR. (You might have to double the backslashes, depending on the escaping conventions of your command interpreter.) See
Section\ 2.5, \(lqLOAD DATA INFILE Syntax\(rq.
.TP 3n
\(bu
\fB\-\-local\fR,
\fB\-L\fR
.sp
Read input files locally from the client host.
.TP 3n
\(bu
\fB\-\-lock\-tables\fR,
\fB\-l\fR
.sp
Lock
\fIall\fR
tables for writing before processing any text files. This ensures that all tables are synchronized on the server.
.TP 3n
\(bu
\fB\-\-low\-priority\fR
.sp
Use
LOW_PRIORITY
when loading the table. This affects only storage engines that use only table\-level locking (MyISAM,
MEMORY,
MERGE).
.TP 3n
\(bu
\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
.sp
The password to use when connecting to the server. If you use the short option form (\fB\-p\fR), you
\fIcannot\fR
have a space between the option and the password. If you omit the
\fIpassword\fR
value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one.
.sp
Specifying a password on the command line should be considered insecure. See
Section\ 5.6, \(lqKeeping Your Password Secure\(rq.
.TP 3n
\(bu
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
\fB\-P \fR\fB\fIport_num\fR\fR
.sp
The TCP/IP port number to use for the connection.
.TP 3n
\(bu
\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
.sp
The connection protocol to use.
.TP 3n
\(bu
\fB\-\-replace\fR,
\fB\-r\fR
.sp
The
\fB\-\-replace\fR
and
\fB\-\-ignore\fR
options control handling of input rows that duplicate existing rows on unique key values. If you specify
\fB\-\-replace\fR, new rows replace existing rows that have the same unique key value. If you specify
\fB\-\-ignore\fR, input rows that duplicate an existing row on a unique key value are skipped. If you do not specify either option, an error occurs when a duplicate key value is found, and the rest of the text file is ignored.
.TP 3n
\(bu
\fB\-\-silent\fR,
\fB\-s\fR
.sp
Silent mode. Produce output only when errors occur.
.TP 3n
\(bu
\fB\-\-socket=\fR\fB\fIpath\fR\fR,
\fB\-S \fR\fB\fIpath\fR\fR
.sp
For connections to
localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.
.TP 3n
\(bu
\fB\-\-ssl*\fR
.sp
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See
Section\ 5.7.3, \(lqSSL Command Options\(rq.
.TP 3n
\(bu
\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
\fB\-u \fR\fB\fIuser_name\fR\fR
.sp
The MySQL username to use when connecting to the server.
.TP 3n
\(bu
\fB\-\-verbose\fR,
\fB\-v\fR
.sp
Verbose mode. Print more information about what the program does.
.TP 3n
\(bu
\fB\-\-version\fR,
\fB\-V\fR
.sp
Display version information and exit.
.sp
.RE
.PP
Here is a sample session that demonstrates use of
\fBmysqlimport\fR:
.sp
.RS 3n
.nf
shell> \fBmysql \-e 'CREATE TABLE imptest(id INT, n VARCHAR(30))' test\fR
shell> \fBed\fR
a
100     Max Sydow
101     Count Dracula
.
w imptest.txt
32
q
shell> \fBod \-c imptest.txt\fR
0000000   1   0   0  \\t   M   a   x       S   y   d   o   w  \\n   1   0
0000020   1  \\t   C   o   u   n   t       D   r   a   c   u   l   a  \\n
0000040
shell> \fBmysqlimport \-\-local test imptest.txt\fR
test.imptest: Records: 2  Deleted: 0  Skipped: 0  Warnings: 0
shell> \fBmysql \-e 'SELECT * FROM imptest' test\fR
+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| id   | n             |
+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
|  100 | Max Sydow     |
|  101 | Count Dracula |
+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
.fi
.RE
.SH "COPYRIGHT"
.PP
Copyright 2007\-2008 MySQL AB
.PP
This documentation is free software; you can redistribute it and/or modify it 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
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/.
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
which may already be installed locally and which is also available
online at http://dev.mysql.com/doc/.
.SH AUTHOR
MySQL AB (http://www.mysql.com/).