MySQL 8.0 Reference Manual Including MySQL NDB Cluster 8.0
The mysqlimport client provides a
command-line interface to the LOAD
DATA
SQL statement. Most options to
mysqlimport correspond directly to clauses of
LOAD DATA
syntax. See
Section 13.2.9, “LOAD DATA Statement”.
Invoke mysqlimport like this:
mysqlimport [options
]db_name
textfile1
[textfile2
...]
For each text file named on the command line,
mysqlimport strips any extension from the
file name and uses the result to determine the name of the table
into which to import the file's contents. For example, files
named patient.txt
,
patient.text
, and
patient
all would be imported into a table
named patient
.
mysqlimport supports the following options,
which can be specified on the command line or in the
[mysqlimport]
and [client]
groups of an option file. For information about option files
used by MySQL programs, see Section 4.2.2.2, “Using Option Files”.
Table 4.15 mysqlimport Options
Option Name | Description | Introduced | Deprecated |
---|---|---|---|
--bind-address | Use specified network interface to connect to MySQL Server | ||
--columns | This option takes a comma-separated list of column names as its value | ||
--compress | Compress all information sent between client and server | 8.0.18 | |
--compression-algorithms | Permitted compression algorithms for connections to server | 8.0.18 | |
--debug | Write debugging log | ||
--debug-check | Print debugging information when program exits | ||
--debug-info | Print debugging information, memory, and CPU statistics when program exits | ||
--default-auth | Authentication plugin to use | ||
--default-character-set | Specify default character set | ||
--defaults-extra-file | Read named option file in addition to usual option files | ||
--defaults-file | Read only named option file | ||
--defaults-group-suffix | Option group suffix value | ||
--delete | Empty the table before importing the text file | ||
--enable-cleartext-plugin | Enable cleartext authentication plugin | ||
--fields-enclosed-by | This option has the same meaning as the corresponding clause for LOAD DATA | ||
--fields-escaped-by | This option has the same meaning as the corresponding clause for LOAD DATA | ||
--fields-optionally-enclosed-by | This option has the same meaning as the corresponding clause for LOAD DATA | ||
--fields-terminated-by | This option has the same meaning as the corresponding clause for LOAD DATA | ||
--force | Continue even if an SQL error occurs | ||
--get-server-public-key | Request RSA public key from server | ||
--help | Display help message and exit | ||
--host | Host on which MySQL server is located | ||
--ignore | See the description for the --replace option | ||
--ignore-lines | Ignore the first N lines of the data file | ||
--lines-terminated-by | This option has the same meaning as the corresponding clause for LOAD DATA | ||
--local | Read input files locally from the client host | ||
--lock-tables | Lock all tables for writing before processing any text files | ||
--login-path | Read login path options from .mylogin.cnf | ||
--low-priority | Use LOW_PRIORITY when loading the table | ||
--no-defaults | Read no option files | ||
--password | Password to use when connecting to server | ||
--password1 | First multifactor authentication password to use when connecting to server | 8.0.27 | |
--password2 | Second multifactor authentication password to use when connecting to server | 8.0.27 | |
--password3 | Third multifactor authentication password to use when connecting to server | 8.0.27 | |
--pipe | Connect to server using named pipe (Windows only) | ||
--plugin-dir | Directory where plugins are installed | ||
--port | TCP/IP port number for connection | ||
--print-defaults | Print default options | ||
--protocol | Transport protocol to use | ||
--replace | The --replace and --ignore options control handling of input rows that duplicate existing rows on unique key values | ||
--server-public-key-path | Path name to file containing RSA public key | ||
--shared-memory-base-name | Shared-memory name for shared-memory connections (Windows only) | ||
--silent | Produce output only when errors occur | ||
--socket | Unix socket file or Windows named pipe to use | ||
--ssl-ca | File that contains list of trusted SSL Certificate Authorities | ||
--ssl-capath | Directory that contains trusted SSL Certificate Authority certificate files | ||
--ssl-cert | File that contains X.509 certificate | ||
--ssl-cipher | Permissible ciphers for connection encryption | ||
--ssl-crl | File that contains certificate revocation lists | ||
--ssl-crlpath | Directory that contains certificate revocation-list files | ||
--ssl-fips-mode | Whether to enable FIPS mode on client side | 8.0.34 | |
--ssl-key | File that contains X.509 key | ||
--ssl-mode | Desired security state of connection to server | ||
--ssl-session-data | File that contains SSL session data | 8.0.29 | |
--ssl-session-data-continue-on-failed-reuse | Whether to establish connections if session reuse fails | 8.0.29 | |
--tls-ciphersuites | Permissible TLSv1.3 ciphersuites for encrypted connections | 8.0.16 | |
--tls-version | Permissible TLS protocols for encrypted connections | ||
--use-threads | Number of threads for parallel file-loading | ||
--user | MySQL user name to use when connecting to server | ||
--verbose | Verbose mode | ||
--version | Display version information and exit | ||
--zstd-compression-level | Compression level for connections to server that use zstd compression | 8.0.18 |
--help
,
-?
Display a help message and exit.
On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server.
The directory where character sets are installed. See Section 10.15, “Character Set Configuration”.
--columns=
,
column_list
-c
column_list
This option takes a list of comma-separated column names as its value. The order of the column names indicates how to match data file columns with table columns.
--compress
,
-C
Compress all information sent between the client and the server if possible. See Section 4.2.8, “Connection Compression Control”.
As of MySQL 8.0.18, this option is deprecated. Expect it to be removed in a future version of MySQL. See Configuring Legacy Connection Compression.
--compression-algorithms=
value
The permitted compression algorithms for connections to the
server. The available algorithms are the same as for the
protocol_compression_algorithms
system variable. The default value is
uncompressed
.
For more information, see Section 4.2.8, “Connection Compression Control”.
This option was added in MySQL 8.0.18.
--debug[=
,
debug_options
]-#
[
debug_options
]
Write a debugging log. A typical
debug_options
string is
d:t:o,
.
The default is file_name
d:t:o
.
This option is available only if MySQL was built using
WITH_DEBUG
. MySQL release
binaries provided by Oracle are not
built using this option.
Print some debugging information when the program exits.
This option is available only if MySQL was built using
WITH_DEBUG
. MySQL release
binaries provided by Oracle are not
built using this option.
Print debugging information and memory and CPU usage statistics when the program exits.
This option is available only if MySQL was built using
WITH_DEBUG
. MySQL release
binaries provided by Oracle are not
built using this option.
--default-character-set=
charset_name
Use charset_name
as the default
character set. See Section 10.15, “Character Set Configuration”.
A hint about which client-side authentication plugin to use. See Section 6.2.17, “Pluggable Authentication”.
--defaults-extra-file=
file_name
Read this option file after the global option file but (on
Unix) before the user option file. If the file does not
exist or is otherwise inaccessible, an error occurs. If
file_name
is not an absolute path
name, it is interpreted relative to the current directory.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
Use only the given option file. If the file does not exist
or is otherwise inaccessible, an error occurs. If
file_name
is not an absolute path
name, it is interpreted relative to the current directory.
Exception: Even with
--defaults-file
, client
programs read .mylogin.cnf
.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
Read not only the usual option groups, but also groups with
the usual names and a suffix of
str
. For example,
mysqlimport normally reads the
[client]
and
[mysqlimport]
groups. If this option is
given as
--defaults-group-suffix=_other
,
mysqlimport also reads the
[client_other]
and
[mysqlimport_other]
groups.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--delete
,
-D
Empty the table before importing the text file.
Enable the mysql_clear_password
cleartext
authentication plugin. (See
Section 6.4.1.4, “Client-Side Cleartext Pluggable Authentication”.)
--fields-terminated-by=...
,
--fields-enclosed-by=...
,
--fields-optionally-enclosed-by=...
,
--fields-escaped-by=...
These options have the same meaning as the corresponding
clauses for LOAD DATA
. See
Section 13.2.9, “LOAD DATA Statement”.
--force
,
-f
Ignore errors. For example, if a table for a text file does
not exist, continue processing any remaining files. Without
--force
,
mysqlimport exits if a table does not
exist.
Request from the server the public key required for RSA key
pair-based password exchange. This option applies to clients
that authenticate with the
caching_sha2_password
authentication
plugin. For that plugin, the server does not send the public
key unless requested. This option is ignored for accounts
that do not authenticate with that plugin. It is also
ignored if RSA-based password exchange is not used, as is
the case when the client connects to the server using a
secure connection.
If
--server-public-key-path=
is given and specifies a valid public key file, it takes
precedence over
file_name
--get-server-public-key
.
For information about the
caching_sha2_password
plugin, see
Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
--host=
,
host_name
-h
host_name
Import data to the MySQL server on the given host. The
default host is localhost
.
--ignore
,
-i
See the description for the
--replace
option.
Ignore the first N
lines of the
data file.
This option has the same meaning as the corresponding clause
for LOAD DATA
. For example,
to import Windows files that have lines terminated with
carriage return/linefeed pairs, use
--lines-terminated-by="\r\n"
.
(You might have to double the backslashes, depending on the
escaping conventions of your command interpreter.) See
Section 13.2.9, “LOAD DATA Statement”.
--local
,
-L
By default, files are read by the server on the server host. With this option, mysqlimport reads input files locally on the client host.
Successful use of LOCAL
load operations
within mysqlimport also requires that the
server permits local loading; see
Section 6.1.6, “Security Considerations for LOAD DATA LOCAL”
--lock-tables
,
-l
Lock all tables for writing before processing any text files. This ensures that all tables are synchronized on the server.
Read options from the named login path in the
.mylogin.cnf
login path file. A
“login path” is an option group containing
options that specify which MySQL server to connect to and
which account to authenticate as. To create or modify a
login path file, use the
mysql_config_editor utility. See
Section 4.6.7, “mysql_config_editor — MySQL Configuration Utility”.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
Use LOW_PRIORITY
when loading the table.
This affects only storage engines that use only table-level
locking (such as MyISAM
,
MEMORY
, and MERGE
).
Do not read any option files. If program startup fails due
to reading unknown options from an option file,
--no-defaults
can be
used to prevent them from being read.
The exception is that the .mylogin.cnf
file is read in all cases, if it exists. This permits
passwords to be specified in a safer way than on the command
line even when
--no-defaults
is used.
To create .mylogin.cnf
, use the
mysql_config_editor utility. See
Section 4.6.7, “mysql_config_editor — MySQL Configuration Utility”.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--password[=
,
password
]-p[
password
]
The password of the MySQL account used for connecting to the
server. The password value is optional. If not given,
mysqlimport prompts for one. If given,
there must be no space between
--password=
or
-p
and the password following it. If no
password option is specified, the default is to send no
password.
Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, “End-User Guidelines for Password Security”.
To explicitly specify that there is no password and that
mysqlimport should not prompt for one,
use the
--skip-password
option.
The password for multifactor authentication factor 1 of the
MySQL account used for connecting to the server. The
password value is optional. If not given,
mysqlimport prompts for one. If given,
there must be no space between
--password1=
and the
password following it. If no password option is specified,
the default is to send no password.
Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, “End-User Guidelines for Password Security”.
To explicitly specify that there is no password and that
mysqlimport should not prompt for one,
use the
--skip-password1
option.
--password1
and
--password
are
synonymous, as are
--skip-password1
and
--skip-password
.
The password for multifactor authentication factor 2 of the
MySQL account used for connecting to the server. The
semantics of this option are similar to the semantics for
--password1
; see the
description of that option for details.
The password for multifactor authentication factor 3 of the
MySQL account used for connecting to the server. The
semantics of this option are similar to the semantics for
--password1
; see the
description of that option for details.
--pipe
,
-W
On Windows, connect to the server using a named pipe. This
option applies only if the server was started with the
named_pipe
system variable
enabled to support named-pipe connections. In addition, the
user making the connection must be a member of the Windows
group specified by the
named_pipe_full_access_group
system variable.
The directory in which to look for plugins. Specify this
option if the
--default-auth
option is
used to specify an authentication plugin but
mysqlimport does not find it. See
Section 6.2.17, “Pluggable Authentication”.
--port=
,
port_num
-P
port_num
For TCP/IP connections, the port number to use.
Print the program name and all options that it gets from option files.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--protocol={TCP|SOCKET|PIPE|MEMORY}
The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 4.2.7, “Connection Transport Protocols”.
--replace
,
-r
The --replace
and
--ignore
options control
handling of input rows that duplicate existing rows on
unique key values. If you specify
--replace
, new rows
replace existing rows that have the same unique key value.
If you specify --ignore
,
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.
--server-public-key-path=
file_name
The path name to a file in PEM format containing a
client-side copy of the public key required by the server
for RSA key pair-based password exchange. This option
applies to clients that authenticate with the
sha256_password
or
caching_sha2_password
authentication
plugin. This option is ignored for accounts that do not
authenticate with one of those plugins. It is also ignored
if RSA-based password exchange is not used, as is the case
when the client connects to the server using a secure
connection.
If
--server-public-key-path=
is given and specifies a valid public key file, it takes
precedence over
file_name
--get-server-public-key
.
For sha256_password
, this option applies
only if MySQL was built using OpenSSL.
For information about the sha256_password
and caching_sha2_password
plugins, see
Section 6.4.1.3, “SHA-256 Pluggable Authentication”, and
Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
--shared-memory-base-name=
name
On Windows, the shared-memory name to use for connections
made using shared memory to a local server. The default
value is MYSQL
. The shared-memory name is
case-sensitive.
This option applies only if the server was started with the
shared_memory
system
variable enabled to support shared-memory connections.
--silent
,
-s
Silent mode. Produce output only when errors occur.
--socket=
,
path
-S
path
For connections to localhost
, the Unix
socket file to use, or, on Windows, the name of the named
pipe to use.
On Windows, this option applies only if the server was
started with the named_pipe
system variable enabled to support named-pipe connections.
In addition, the user making the connection must be a member
of the Windows group specified by the
named_pipe_full_access_group
system variable.
Options that begin with --ssl
specify
whether to connect to the server using encryption and
indicate where to find SSL keys and certificates. See
Command Options for Encrypted Connections.
--ssl-fips-mode={OFF|ON|STRICT}
Controls whether to enable FIPS mode on the client side. The
--ssl-fips-mode
option
differs from other
--ssl-
options in that it is not used to establish encrypted
connections, but rather to affect which cryptographic
operations to permit. See Section 6.8, “FIPS Support”.
xxx
These --ssl-fips-mode
values are permitted:
OFF
: Disable FIPS mode.
ON
: Enable FIPS mode.
STRICT
: Enable “strict”
FIPS mode.
If the OpenSSL FIPS Object Module is not available, the
only permitted value for
--ssl-fips-mode
is
OFF
. In this case, setting
--ssl-fips-mode
to
ON
or STRICT
causes
the client to produce a warning at startup and to operate
in non-FIPS mode.
As of MySQL 8.0.34, this option is deprecated. Expect it to be removed in a future version of MySQL.
--tls-ciphersuites=
ciphersuite_list
The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”.
This option was added in MySQL 8.0.16.
The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”.
--user=
,
user_name
-u
user_name
The user name of the MySQL account to use for connecting to the server.
Load files in parallel using N
threads.
--verbose
,
-v
Verbose mode. Print more information about what the program does.
--version
,
-V
Display version information and exit.
--zstd-compression-level=
level
The compression level to use for connections to the server
that use the zstd
compression algorithm.
The permitted levels are from 1 to 22, with larger values
indicating increasing levels of compression. The default
zstd
compression level is 3. The
compression level setting has no effect on connections that
do not use zstd
compression.
For more information, see Section 4.2.8, “Connection Compression Control”.
This option was added in MySQL 8.0.18.
Here is a sample session that demonstrates use of mysqlimport:
$>mysql -e 'CREATE TABLE imptest(id INT, n VARCHAR(30))' test
$>ed
a 100 Max Sydow 101 Count Dracula . w imptest.txt 32 q $>od -c imptest.txt
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 $>mysqlimport --local test imptest.txt
test.imptest: Records: 2 Deleted: 0 Skipped: 0 Warnings: 0 $>mysql -e 'SELECT * FROM imptest' test
+------+---------------+ | id | n | +------+---------------+ | 100 | Max Sydow | | 101 | Count Dracula | +------+---------------+