1MYSQLIMPORT(1) MySQL Database System MYSQLIMPORT(1)
2
6 mysqlimport - a data import program
7
9 mysqlimport [options] db_name textfile1 ...
10
12 The mysqlimport client provides a command-line interface to the LOAD
13 DATA SQL statement. Most options to mysqlimport correspond directly to
14 clauses of LOAD DATA syntax. See Section 13.2.7, “LOAD DATA Statement”.
15 Invoke mysqlimport like this:
17 mysqlimport [options] db_name textfile1 [textfile2 ...]
19 For each text file named on the command line, mysqlimport strips any
21 extension from the file name and uses the result to determine the name
22 of the table into which to import the file's contents. For example,
23 files named patient.txt, patient.text, and patient all would be
24 imported into a table named patient.
25 mysqlimport supports the following options, which can be specified on
27 the command line or in the [mysqlimport] and [client] groups of an
28 option file. For information about option files used by MySQL programs,
29 see Section 4.2.2.2, “Using Option Files”.
30 • --help, -? Display a help message and exit.
32 • --bind-address=ip_address On a computer having multiple network
34 interfaces, use this option to select which interface to use for
35 connecting to the MySQL server.
36 • --character-sets-dir=dir_name The directory where character sets
38 are installed. See Section 10.15, “Character Set Configuration”.
39 • --columns=column_list, -c column_list This option takes a list of
41 comma-separated column names as its value. The order of the column
42 names indicates how to match data file columns with table columns.
43 • --compress, -C Compress all information sent between the client and
45 the server if possible. See Section 4.2.8, “Connection Compression
46 Control”.
47 As of MySQL 8.0.18, this option is deprecated. Expect it to be
49 removed in a future version of MySQL. See the section called
50 “Configuring Legacy Connection Compression”.
51 • --compression-algorithms=value The permitted compression algorithms
53 for connections to the server. The available algorithms are the
54 same as for the protocol_compression_algorithms system variable.
55 The default value is uncompressed.
56 For more information, see Section 4.2.8, “Connection Compression
58 Control”.
59 This option was added in MySQL 8.0.18.
61 • --debug[=debug_options], -# [debug_options] Write a debugging log.
63 A typical debug_options string is d:t:o,file_name. The default is
64 d:t:o.
65 This option is available only if MySQL was built using WITH_DEBUG.
67 MySQL release binaries provided by Oracle are not built using this
68 option.
69 • --debug-check Print some debugging information when the program
71 exits.
72 This option is available only if MySQL was built using WITH_DEBUG.
74 MySQL release binaries provided by Oracle are not built using this
75 option.
76 • --debug-info Print debugging information and memory and CPU usage
78 statistics when the program exits.
79 This option is available only if MySQL was built using WITH_DEBUG.
81 MySQL release binaries provided by Oracle are not built using this
82 option.
83 • --default-character-set=charset_name Use charset_name as the
85 default character set. See Section 10.15, “Character Set
86 Configuration”.
87 • --default-auth=plugin A hint about which client-side authentication
89 plugin to use. See Section 6.2.17, “Pluggable Authentication”.
90 • --defaults-extra-file=file_name Read this option file after the
92 global option file but (on Unix) before the user option file. If
93 the file does not exist or is otherwise inaccessible, an error
94 occurs. If file_name is not an absolute path name, it is
95 interpreted relative to the current directory.
96 For additional information about this and other option-file
98 options, see Section 4.2.2.3, “Command-Line Options that Affect
99 Option-File Handling”.
100 • --defaults-file=file_name Use only the given option file. If the
102 file does not exist or is otherwise inaccessible, an error occurs.
103 If file_name is not an absolute path name, it is interpreted
104 relative to the current directory.
105 Exception: Even with --defaults-file, client programs read
107 .mylogin.cnf.
108 For additional information about this and other option-file
110 options, see Section 4.2.2.3, “Command-Line Options that Affect
111 Option-File Handling”.
112 • --defaults-group-suffix=str Read not only the usual option groups,
114 but also groups with the usual names and a suffix of str. For
115 example, mysqlimport normally reads the [client] and [mysqlimport]
116 groups. If this option is given as --defaults-group-suffix=_other,
117 mysqlimport also reads the [client_other] and [mysqlimport_other]
118 groups.
119 For additional information about this and other option-file
121 options, see Section 4.2.2.3, “Command-Line Options that Affect
122 Option-File Handling”.
123 • --delete, -D Empty the table before importing the text file.
125 • --enable-cleartext-plugin Enable the mysql_clear_password cleartext
127 authentication plugin. (See Section 6.4.1.4, “Client-Side Cleartext
128 Pluggable Authentication”.)
129 • --fields-terminated-by=..., --fields-enclosed-by=...,
131 --fields-optionally-enclosed-by=..., --fields-escaped-by=... These
132 options have the same meaning as the corresponding clauses for LOAD
133 DATA. See Section 13.2.7, “LOAD DATA Statement”.
134 • --force, -f Ignore errors. For example, if a table for a text file
136 does not exist, continue processing any remaining files. Without
137 --force, mysqlimport exits if a table does not exist.
138 • --get-server-public-key Request from the server the public key
140 required for RSA key pair-based password exchange. This option
141 applies to clients that authenticate with the caching_sha2_password
142 authentication plugin. For that plugin, the server does not send
143 the public key unless requested. This option is ignored for
144 accounts that do not authenticate with that plugin. It is also
145 ignored if RSA-based password exchange is not used, as is the case
146 when the client connects to the server using a secure connection.
147 If --server-public-key-path=file_name is given and specifies a
149 valid public key file, it takes precedence over
150 --get-server-public-key.
151 For information about the caching_sha2_password plugin, see
153 Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
154 • --host=host_name, -h host_name Import data to the MySQL server on
156 the given host. The default host is localhost.
157 • --ignore, -i See the description for the --replace option.
159 • --ignore-lines=N Ignore the first N lines of the data file.
161 • --lines-terminated-by=... This option has the same meaning as the
163 corresponding clause for LOAD DATA. For example, to import Windows
164 files that have lines terminated with carriage return/linefeed
165 pairs, use --lines-terminated-by="\r\n". (You might have to double
166 the backslashes, depending on the escaping conventions of your
167 command interpreter.) See Section 13.2.7, “LOAD DATA Statement”.
168 • --local, -L By default, files are read by the server on the server
170 host. With this option, mysqlimport reads input files locally on
171 the client host.
172 Successful use of LOCAL load operations within mysqlimport also
174 requires that the server permits local loading; see Section 6.1.6,
175 “Security Considerations for LOAD DATA LOCAL”
176 • --lock-tables, -l Lock all tables for writing before processing any
178 text files. This ensures that all tables are synchronized on the
179 server.
180 • --login-path=name Read options from the named login path in the
182 .mylogin.cnf login path file. A “login path” is an option group
183 containing options that specify which MySQL server to connect to
184 and which account to authenticate as. To create or modify a login
185 path file, use the mysql_config_editor utility. See
186 mysql_config_editor(1).
187 For additional information about this and other option-file
189 options, see Section 4.2.2.3, “Command-Line Options that Affect
190 Option-File Handling”.
191 • --low-priority Use LOW_PRIORITY when loading the table. This
193 affects only storage engines that use only table-level locking
194 (such as MyISAM, MEMORY, and MERGE).
195 • --no-defaults Do not read any option files. If program startup
197 fails due to reading unknown options from an option file,
198 --no-defaults can be used to prevent them from being read.
199 The exception is that the .mylogin.cnf file is read in all cases,
201 if it exists. This permits passwords to be specified in a safer way
202 than on the command line even when --no-defaults is used. To create
203 .mylogin.cnf, use the mysql_config_editor utility. See
204 mysql_config_editor(1).
205 For additional information about this and other option-file
207 options, see Section 4.2.2.3, “Command-Line Options that Affect
208 Option-File Handling”.
209 • --password[=password], -p[password] The password of the MySQL
211 account used for connecting to the server. The password value is
212 optional. If not given, mysqlimport prompts for one. If given,
213 there must be no space between --password= or -p and the password
214 following it. If no password option is specified, the default is to
215 send no password.
216 Specifying a password on the command line should be considered
218 insecure. To avoid giving the password on the command line, use an
219 option file. See Section 6.1.2.1, “End-User Guidelines for Password
220 Security”.
221 To explicitly specify that there is no password and that
223 mysqlimport should not prompt for one, use the --skip-password
224 option.
225 • --password1[=pass_val] The password for multifactor authentication
227 factor 1 of the MySQL account used for connecting to the server.
228 The password value is optional. If not given, mysqlimport prompts
229 for one. If given, there must be no space between --password1= and
230 the password following it. If no password option is specified, the
231 default is to send no password.
232 Specifying a password on the command line should be considered
234 insecure. To avoid giving the password on the command line, use an
235 option file. See Section 6.1.2.1, “End-User Guidelines for Password
236 Security”.
237 To explicitly specify that there is no password and that
239 mysqlimport should not prompt for one, use the --skip-password1
240 option.
241 --password1 and --password are synonymous, as are --skip-password1
243 and --skip-password.
244 • --password2[=pass_val] The password for multifactor authentication
246 factor 2 of the MySQL account used for connecting to the server.
247 The semantics of this option are similar to the semantics for
248 --password1; see the description of that option for details.
249 • --password3[=pass_val] The password for multifactor authentication
251 factor 3 of the MySQL account used for connecting to the server.
252 The semantics of this option are similar to the semantics for
253 --password1; see the description of that option for details.
254 • --pipe, -W On Windows, connect to the server using a named pipe.
256 This option applies only if the server was started with the
257 named_pipe system variable enabled to support named-pipe
258 connections. In addition, the user making the connection must be a
259 member of the Windows group specified by the
260 named_pipe_full_access_group system variable.
261 • --plugin-dir=dir_name The directory in which to look for plugins.
263 Specify this option if the --default-auth option is used to specify
264 an authentication plugin but mysqlimport does not find it. See
265 Section 6.2.17, “Pluggable Authentication”.
266 • --port=port_num, -P port_num For TCP/IP connections, the port
268 number to use.
269 • --print-defaults Print the program name and all options that it
271 gets from option files.
272 For additional information about this and other option-file
274 options, see Section 4.2.2.3, “Command-Line Options that Affect
275 Option-File Handling”.
276 • --protocol={TCP|SOCKET|PIPE|MEMORY} The transport protocol to use
278 for connecting to the server. It is useful when the other
279 connection parameters normally result in use of a protocol other
280 than the one you want. For details on the permissible values, see
281 Section 4.2.7, “Connection Transport Protocols”.
282 • --replace, -r The --replace and --ignore options control handling
284 of input rows that duplicate existing rows on unique key values. If
285 you specify --replace, new rows replace existing rows that have the
286 same unique key value. If you specify --ignore, input rows that
287 duplicate an existing row on a unique key value are skipped. If you
288 do not specify either option, an error occurs when a duplicate key
289 value is found, and the rest of the text file is ignored.
290 • --server-public-key-path=file_name The path name to a file in PEM
292 format containing a client-side copy of the public key required by
293 the server for RSA key pair-based password exchange. This option
294 applies to clients that authenticate with the sha256_password or
295 caching_sha2_password authentication plugin. This option is ignored
296 for accounts that do not authenticate with one of those plugins. It
297 is also ignored if RSA-based password exchange is not used, as is
298 the case when the client connects to the server using a secure
299 connection.
300 If --server-public-key-path=file_name is given and specifies a
302 valid public key file, it takes precedence over
303 --get-server-public-key.
304 For sha256_password, this option applies only if MySQL was built
306 using OpenSSL.
307 For information about the sha256_password and caching_sha2_password
309 plugins, see Section 6.4.1.3, “SHA-256 Pluggable Authentication”,
310 and Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
311 • --shared-memory-base-name=name On Windows, the shared-memory name
313 to use for connections made using shared memory to a local server.
314 The default value is MYSQL. The shared-memory name is
315 case-sensitive.
316 This option applies only if the server was started with the
318 shared_memory system variable enabled to support shared-memory
319 connections.
320 • --silent, -s Silent mode. Produce output only when errors occur.
322 • --socket=path, -S path For connections to localhost, the Unix
324 socket file to use, or, on Windows, the name of the named pipe to
325 use.
326 On Windows, this option applies only if the server was started with
328 the named_pipe system variable enabled to support named-pipe
329 connections. In addition, the user making the connection must be a
330 member of the Windows group specified by the
331 named_pipe_full_access_group system variable.
332 • --ssl* Options that begin with --ssl specify whether to connect to
334 the server using encryption and indicate where to find SSL keys and
335 certificates. See the section called “Command Options for Encrypted
336 Connections”.
337 • --ssl-fips-mode={OFF|ON|STRICT} Controls whether to enable FIPS
339 mode on the client side. The --ssl-fips-mode option differs from
340 other --ssl-xxx options in that it is not used to establish
341 encrypted connections, but rather to affect which cryptographic
342 operations to permit. See Section 6.8, “FIPS Support”.
343 These --ssl-fips-mode values are permitted:
345 • OFF: Disable FIPS mode.
347 • ON: Enable FIPS mode.
349 • STRICT: Enable “strict” FIPS mode.
351 Note
354 If the OpenSSL FIPS Object Module is not available, the only
355 permitted value for --ssl-fips-mode is OFF. In this case,
356 setting --ssl-fips-mode to ON or STRICT causes the client to
357 produce a warning at startup and to operate in non-FIPS mode.
358 • --tls-ciphersuites=ciphersuite_list The permissible ciphersuites
360 for encrypted connections that use TLSv1.3. The value is a list of
361 one or more colon-separated ciphersuite names. The ciphersuites
362 that can be named for this option depend on the SSL library used to
363 compile MySQL. For details, see Section 6.3.2, “Encrypted
364 Connection TLS Protocols and Ciphers”.
365 This option was added in MySQL 8.0.16.
367 • --tls-version=protocol_list The permissible TLS protocols for
369 encrypted connections. The value is a list of one or more
370 comma-separated protocol names. The protocols that can be named for
371 this option depend on the SSL library used to compile MySQL. For
372 details, see Section 6.3.2, “Encrypted Connection TLS Protocols and
373 Ciphers”.
374 • --user=user_name, -u user_name The user name of the MySQL account
376 to use for connecting to the server.
377 • --use-threads=N Load files in parallel using N threads.
379 • --verbose, -v Verbose mode. Print more information about what the
381 program does.
382 • --version, -V Display version information and exit.
384 • --zstd-compression-level=level The compression level to use for
386 connections to the server that use the zstd compression algorithm.
387 The permitted levels are from 1 to 22, with larger values
388 indicating increasing levels of compression. The default zstd
389 compression level is 3. The compression level setting has no effect
390 on connections that do not use zstd compression.
391 For more information, see Section 4.2.8, “Connection Compression
393 Control”.
394 This option was added in MySQL 8.0.18.
396 Here is a sample session that demonstrates use of mysqlimport:
398 $> mysql -e 'CREATE TABLE imptest(id INT, n VARCHAR(30))' test
400 $> ed
401 a
402 100 Max Sydow
403 101 Count Dracula
404 .
405 w imptest.txt
406 32
407 q
408 $> od -c imptest.txt
409 0000000 1 0 0 \t M a x S y d o w \n 1 0
410 0000020 1 \t C o u n t D r a c u l a \n
411 0000040
412 $> mysqlimport --local test imptest.txt
413 test.imptest: Records: 2 Deleted: 0 Skipped: 0 Warnings: 0
414 $> mysql -e 'SELECT * FROM imptest' test
415 +------+---------------+
416 | id | n |
417 +------+---------------+
418 | 100 | Max Sydow |
419 | 101 | Count Dracula |
420 +------+---------------+
421
423 Copyright © 1997, 2022, Oracle and/or its affiliates.
424 This documentation is free software; you can redistribute it and/or
426 modify it only under the terms of the GNU General Public License as
427 published by the Free Software Foundation; version 2 of the License.
428 This documentation is distributed in the hope that it will be useful,
430 but WITHOUT ANY WARRANTY; without even the implied warranty of
431 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
432 General Public License for more details.
433 You should have received a copy of the GNU General Public License along
435 with the program; if not, write to the Free Software Foundation, Inc.,
436 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
437 http://www.gnu.org/licenses/.
438
441 For more information, please refer to the MySQL Reference Manual, which
442 may already be installed locally and which is also available online at
443 http://dev.mysql.com/doc/.
444
446 Oracle Corporation (http://dev.mysql.com/).
447MySQL 8.0 08/29/2022 MYSQLIMPORT(1)