ndb_import imports CSV-formatted data, such as that produced by mysqldump --tab, directly into NDB using the NDB API. ndb_import requires a connection to an NDB management server (ndb_mgmd) to function; it does not require a connection to a MySQL Server.
ndb_importdb_namefile_nameoptions
ndb_import requires two arguments. db_name is the name of the database where the table into which to import the data is found; file_name is the name of the CSV file from which to read the data; this must include the path to this file if it is not in the current directory. The name of the file must match that of the table; the file's extension, if any, is not taken into consideration. Options supported by ndb_import include those for specifying field separators, escapes, and line terminators, and are described later in this section. ndb_import must be able to connect to an NDB Cluster management server; for this reason, there must be an unused [api] slot in the cluster config.ini file.
To duplicate an existing table that uses a different storage engine, such as InnoDB, as an NDB table, use the mysql client to perform a SELECT INTO OUTFILE statement to export the existing table to a CSV file, then to execute a CREATE TABLE LIKE statement to create a new table having the same structure as the existing table, then perform ALTER TABLE ... ENGINE=NDB on the new table; after this, from the system shell, invoke ndb_import to load the data into the new NDB table. For example, an existing InnoDB table named myinnodb_table in a database named myinnodb can be exported into an NDB table named myndb_table in a database named myndb as shown here, assuming that you are already logged in as a MySQL user with the appropriate privileges:
In the mysql client:
mysql>USE myinnodb;mysql>SELECT * INTO OUTFILE '/tmp/myndb_table.csv'>FIELDS TERMINATED BY ',' OPTIONALLY ENCLOSED BY '"' ESCAPED BY '\\'>LINES TERMINATED BY '\n'>FROM myinnodbtable;mysql>CREATE DATABASE myndb;mysql>USE myndb;mysql>CREATE TABLE myndb_table LIKE myinnodb.myinnodb_table;mysql>ALTER TABLE myndb_table ENGINE=NDB;mysql>EXIT;Bye shell>
Once the target database and table have been created, a running mysqld is no longer required. You can stop it using mysqladmin shutdown or another method before proceeding, if you wish.
In the system shell:
# if you are not already in the MySQL bin directory: shell>cdshell>path-to-mysql-bin-dirndb_import myndb /tmp/myndb_table.csv --fields-optionally-enclosed-by='"' \--fields-terminated-by="," --fields-escaped-by='\\'
The output should resemble what is shown here:
job-1 import myndb.myndb_table from /tmp/myndb_table.csv job-1 [running] import myndb.myndb_table from /tmp/myndb_table.csv job-1 [success] import myndb.myndb_table from /tmp/myndb_table.csv job-1 imported 19984 rows in 0h0m9s at 2277 rows/s jobs summary: defined: 1 run: 1 with success: 1 with failure: 0 shell>
All options that can be used with ndb_import are shown in the following table. Additional descriptions follow the table.
Table 23.35 Command-line options used with the program ndb_import
| Format | Description | Added, Deprecated, or Removed |
|---|---|---|
| Dump core on any fatal error; used for debugging | (Supported in all NDB releases based on MySQL 8.0) |
|
| For table with hidden PK, specify autoincrement increment. See mysqld | (Supported in all NDB releases based on MySQL 8.0) |
|
| For table with hidden PK, specify autoincrement offset. See mysqld | (Supported in all NDB releases based on MySQL 8.0) |
|
| For table with hidden PK, specify number of autoincrement values that are prefetched. See mysqld | (Supported in all NDB releases based on MySQL 8.0) |
|
| Directory containing character sets | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of times to retry connection before giving up | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of seconds to wait between attempts to contact management server | (Supported in all NDB releases based on MySQL 8.0) |
|
| Same as --ndb-connectstring | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of cluster connections to create | (Supported in all NDB releases based on MySQL 8.0) |
|
| When job fails, continue to next job | (Supported in all NDB releases based on MySQL 8.0) |
|
| Write core file on error; used in debugging | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of threads, per data node, executing database operations | (Supported in all NDB releases based on MySQL 8.0) |
|
| Read given file after global files are read | (Supported in all NDB releases based on MySQL 8.0) |
|
| Read default options from given file only | (Supported in all NDB releases based on MySQL 8.0) |
|
| Also read groups with concat(group, suffix) | (Supported in all NDB releases based on MySQL 8.0) |
|
| Error insert type, for testing purposes; use "list" to obtain all possible values | (Supported in all NDB releases based on MySQL 8.0) |
|
| Error insert delay in milliseconds; random variation is added | (Supported in all NDB releases based on MySQL 8.0) |
|
| Same as FIELDS ENCLOSED BY option for LOAD DATA statements. For CSV input this is same as using --fields-optionally-enclosed-by | (Supported in all NDB releases based on MySQL 8.0) |
|
| Same as FIELDS ESCAPED BY option for LOAD DATA statements | (Supported in all NDB releases based on MySQL 8.0) |
|
| Same as FIELDS OPTIONALLY ENCLOSED BY option for LOAD DATA statements | (Supported in all NDB releases based on MySQL 8.0) |
|
| Same as FIELDS TERMINATED BY option for LOAD DATA statements | (Supported in all NDB releases based on MySQL 8.0) |
|
| Display help text and exit | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of milliseconds to sleep waiting for more to do | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of times to re-try before idlesleep | (Supported in all NDB releases based on MySQL 8.0) |
|
| Ignore first # lines in input file. Used to skip a non-data header | (Supported in all NDB releases based on MySQL 8.0) |
|
| Input type: random or csv | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of threads processing input. Must be 2 or more if --input-type is csv | (Supported in all NDB releases based on MySQL 8.0) |
|
| State files (except non-empty *.rej files) are normally removed on job completion. Using this option causes all state files to be preserved instead | (Supported in all NDB releases based on MySQL 8.0) |
|
| Same as LINES TERMINATED BY option for LOAD DATA statements | (Supported in all NDB releases based on MySQL 8.0) |
|
| Read given path from login file | (Supported in all NDB releases based on MySQL 8.0) |
|
| Import only this number of input data rows; default is 0, which imports all rows | (Supported in all NDB releases based on MySQL 8.0) |
|
| Periodically print status of running job if something has changed (status, rejected rows, temporary errors). Value 0 disables. Value 1 prints any change seen. Higher values reduce status printing exponentially up to some pre-defined limit | (Supported in all NDB releases based on MySQL 8.0) |
|
| Set connect string for connecting to ndb_mgmd. Syntax: "[nodeid=id;][host=]hostname[:port]". Overrides entries in NDB_CONNECTSTRING and my.cnf | (Supported in all NDB releases based on MySQL 8.0) |
|
| Same as --ndb-connectstring | (Supported in all NDB releases based on MySQL 8.0) |
|
| Set node ID for this node, overriding any ID set by --ndb-connectstring | (Supported in all NDB releases based on MySQL 8.0) |
|
| Enable optimizations for selection of nodes for transactions. Enabled by default; use --skip-ndb-optimized-node-selection to disable | (Supported in all NDB releases based on MySQL 8.0) |
|
| Run database operations as batches, in single transactions | (Supported in all NDB releases based on MySQL 8.0) |
|
| Do not read default options from any option file other than login file | (Supported in all NDB releases based on MySQL 8.0) |
|
| Do not use distribution key hint to select data node (TC) | (Supported in all NDB releases based on MySQL 8.0) |
|
| A db execution batch is a set of transactions and operations sent to NDB kernel. This option limits NDB operations (including blob operations) in a db execution batch. Therefore it also limits number of asynch transactions. Value 0 is not valid | (Supported in all NDB releases based on MySQL 8.0) |
|
| Limit bytes in execution batch (default 0 = no limit) | (Supported in all NDB releases based on MySQL 8.0) |
|
| Output type: ndb is default, null used for testing | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of threads processing output or relaying database operations | (Supported in all NDB releases based on MySQL 8.0) |
|
| Align I/O buffers to given size | (Supported in all NDB releases based on MySQL 8.0) |
|
| Size of I/O buffers as multiple of page size. CSV input worker allocates a double-sized buffer | (Supported in all NDB releases based on MySQL 8.0) |
|
| Timeout per poll for completed asynchonous transactions; polling continues until all polls are completed, or error occurs | (Supported in all NDB releases based on MySQL 8.0) |
|
| Print program argument list and exit | (Supported in all NDB releases based on MySQL 8.0) |
|
| Limit number of rejected rows (rows with permanent error) in data load. Default is 0 which means that any rejected row causes a fatal error. The row exceeding the limit is also added to *.rej | (Supported in all NDB releases based on MySQL 8.0) |
|
| If job aborted (temporary error, user interrupt), resume with rows not yet processed | (Supported in all NDB releases based on MySQL 8.0) |
|
| Limit rows in row queues (default 0 = no limit); must be 1 or more if --input-type is random | (Supported in all NDB releases based on MySQL 8.0) |
|
| Limit bytes in row queues (0 = no limit) | (Supported in all NDB releases based on MySQL 8.0) |
|
| Where to write state files; currect directory is default | (Supported in all NDB releases based on MySQL 8.0) |
|
| Save performance related options and internal statistics in *.sto and *.stt files. These files are kept on successful completion even if --keep-state is not used | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of milliseconds to sleep between temporary errors | (Supported in all NDB releases based on MySQL 8.0) |
|
| Number of times a transaction can fail due to a temporary error, per execution batch; 0 means any temporary error is fatal. Such errors do not cause any rows to be written to .rej file | (Supported in all NDB releases based on MySQL 8.0) |
|
| Display help text and exit; same as --help | (Supported in all NDB releases based on MySQL 8.0) |
|
| Enable verbose output | (Supported in all NDB releases based on MySQL 8.0) |
|
| Display version information and exit | (Supported in all NDB releases based on MySQL 8.0) |
| Command-Line Format | --abort-on-error |
|---|---|
| Type | Boolean |
| Default Value | FALSE |
Dump core on any fatal error; used for debugging only.
| Command-Line Format | --ai-increment=# |
|---|---|
| Type | Integer |
| Default Value | 1 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
For a table with a hidden primary key, specify the autoincrement increment, like the auto_increment_increment system variable does in the MySQL Server.
| Command-Line Format | --ai-offset=# |
|---|---|
| Type | Integer |
| Default Value | 1 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
For a table with hidden primary key, specify the autoincrement offset. Similar to the auto_increment_offset system variable.
| Command-Line Format | --ai-prefetch-sz=# |
|---|---|
| Type | Integer |
| Default Value | 1024 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
For a table with a hidden primary key, specify the number of autoincrement values that are prefetched. Behaves like the ndb_autoincrement_prefetch_sz system variable does in the MySQL Server.
| Command-Line Format | --connections=# |
|---|---|
| Type | Integer |
| Default Value | 1 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
Number of cluster connections to create.
| Command-Line Format | --continue |
|---|---|
| Type | Boolean |
| Default Value | FALSE |
When a job fails, continue to the next job.
| Command-Line Format | --db-workers=# |
|---|---|
| Type | Integer |
| Default Value | 4 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
Number of threads, per data node, executing database operations.
| Command-Line Format | --errins-type=name |
|---|---|
| Type | Enumeration |
| Default Value | [none] |
| Valid Values |
|
Error insert type; use list as the name value to obtain all possible values. This option is used for testing purposes only.
| Command-Line Format | --errins-delay=# |
|---|---|
| Type | Integer |
| Default Value | 1000 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
| Unit | ms |
Error insert delay in milliseconds; random variation is added. This option is used for testing purposes only.
| Command-Line Format | --fields-enclosed-by=char |
|---|---|
| Type | String |
| Default Value | [none] |
This works in the same way as the FIELDS ENCLOSED BY option does for the LOAD DATA statement, specifying a character to be interpeted as quoting field values. For CSV input, this is the same as --fields-optionally-enclosed-by.
| Command-Line Format | --fields-escaped-by=name |
|---|---|
| Type | String |
| Default Value | \ |
Specify an escape character in the same way as the FIELDS ESCAPED BY option does for the SQL LOAD DATA statement.
--fields-optionally-enclosed-by=char
| Command-Line Format | --fields-optionally-enclosed-by=char |
|---|---|
| Type | String |
| Default Value | [none] |
This works in the same way as the FIELDS OPTIONALLY ENCLOSED BY option does for the LOAD DATA statement, specifying a character to be interpeted as optionally quoting field values. For CSV input, this is the same as --fields-enclosed-by.
| Command-Line Format | --fields-terminated-by=char |
|---|---|
| Type | String |
| Default Value | \t |
This works in the same way as the FIELDS TERMINATED BY option does for the LOAD DATA statement, specifying a character to be interpeted as the field separator.
| Command-Line Format | --idlesleep=# |
|---|---|
| Type | Integer |
| Default Value | 1 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
| Unit | ms |
Number of milliseconds to sleep waiting for more work to perform.
| Command-Line Format | --idlespin=# |
|---|---|
| Type | Integer |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
Number of times to retry before sleeping.
| Command-Line Format | --ignore-lines=# |
|---|---|
| Type | Integer |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
Cause ndb_import to ignore the first # lines of the input file. This can be employed to skip a file header that does not contain any data.
| Command-Line Format | --input-type=name |
|---|---|
| Type | Enumeration |
| Default Value | csv |
| Valid Values |
|
Set the type of input type. The default is csv; random is intended for testing purposes only. .
| Command-Line Format | --input-workers=# |
|---|---|
| Type | Integer |
| Default Value | 4 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
Set the number of threads processing input.
| Command-Line Format | --keep-state |
|---|---|
| Type | Boolean |
| Default Value | false |
By default, ndb_import removes all state files (except non-empty *.rej files) when it completes a job. Specify this option (nor argument is required) to force the program to retain all state files instead.
| Command-Line Format | --lines-terminated-by=name |
|---|---|
| Type | String |
| Default Value | \n |
This works in the same way as the LINES TERMINATED BY option does for the LOAD DATA statement, specifying a character to be interpeted as end-of-line.
| Command-Line Format | --log-level=# |
|---|---|
| Type | Integer |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 2 |
Performs internal logging at the given level. This option is intended primarily for internal and development use.
In debug builds of NDB only, the logging level can be set using this option to a maximum of 4.
| Command-Line Format | --max-rows=# |
|---|---|
| Type | Integer |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
| Unit | bytes |
Import only this number of input data rows; the default is 0, which imports all rows.
| Command-Line Format | --monitor=# |
|---|---|
| Type | Integer |
| Default Value | 2 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
| Unit | bytes |
Periodically print the status of a running job if something has changed (status, rejected rows, temporary errors). Set to 0 to disable this reporting. Setting to 1 prints any change that is seen. Higher values reduce the frequency of this status reporting.
| Command-Line Format | --no-asynch |
|---|---|
| Type | Boolean |
| Default Value | FALSE |
Run database operations as batches, in single transactions.
| Command-Line Format | --no-hint |
|---|---|
| Type | Boolean |
| Default Value | FALSE |
Do not use distribution key hinting to select a data node.
| Command-Line Format | --opbatch=# |
|---|---|
| Type | Integer |
| Default Value | 256 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
| Unit | bytes |
Set a limit on the number of operations (including blob operations), and thus the number of asynchronous transactions, per execution batch.
| Command-Line Format | --opbytes=# |
|---|---|
| Type | Integer |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
| Unit | bytes |
Set a limit on the number of bytes per execution batch. Use 0 for no limit.
| Command-Line Format | --output-type=name |
|---|---|
| Type | Enumeration |
| Default Value | ndb |
| Valid Values | null |
Set the output type. ndb is the default. null is used only for testing.
| Command-Line Format | --output-workers=# |
|---|---|
| Type | Integer |
| Default Value | 2 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
Set the number of threads processing output or relaying database operations.
| Command-Line Format | --pagesize=# |
|---|---|
| Type | Integer |
| Default Value | 4096 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
| Unit | bytes |
Align I/O buffers to the given size.
| Command-Line Format | --pagecnt=# |
|---|---|
| Type | Integer |
| Default Value | 64 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
Set the size of I/O buffers as multiple of page size. The CSV input worker allocates buffer that is doubled in size.
| Command-Line Format | --polltimeout=# |
|---|---|
| Type | Integer |
| Default Value | 1000 |
| Minimum Value | 1 |
| Maximum Value | 4294967295 |
| Unit | ms |
Set a timeout per poll for completed asynchonous transactions; polling continues until all polls are completed, or until an error occurs.
| Command-Line Format | --rejects=# |
|---|---|
| Type | Integer |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
Limit the number of rejected rows (rows with permanent errors) in the data load. The default is 0, which means that any rejected row causes a fatal error. Any rows causing the limit to be exceeded are added to the .rej file.
The limit imposed by this option is effective for the duration of the current run. A run restarted using --resume is considered a “new” run for this purpose.
| Command-Line Format | --resume |
|---|---|
| Type | Boolean |
| Default Value | FALSE |
If a job is aborted (due to a temporary db error or when interrupted by the user), resume with any rows not yet processed.
| Command-Line Format | --rowbatch=# |
|---|---|
| Type | Integer |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
| Unit | rows |
Set a limit on the number of rows per row queue. Use 0 for no limit.
| Command-Line Format | --rowbytes=# |
|---|---|
| Type | Integer |
| Default Value | 262144 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
| Unit | bytes |
Set a limit on the number of bytes per row queue. Use 0 for no limit.
| Command-Line Format | --stats |
|---|---|
| Type | Boolean |
| Default Value | false |
Save information about options related to performance and other internal statistics in files named *.sto and *.stt. These files are always kept on successful completion (even if --keep-state is not also specified).
| Command-Line Format | --state-dir=name |
|---|---|
| Type | String |
| Default Value | . |
Where to write the state files (tbl_name.maptbl_name.rejtbl_name.restbl_name.stt
| Command-Line Format | --tempdelay=# |
|---|---|
| Type | Integer |
| Default Value | 10 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
| Unit | ms |
Number of milliseconds to sleep between temporary errors.
| Command-Line Format | --temperrors=# |
|---|---|
| Type | Integer |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 4294967295 |
Number of times a transaction can fail due to a temporary error, per execution batch. The default is 0, which means that any temporary error is fatal. Temporary errors do not cause any rows to be added to the .rej file.
| Command-Line Format | --verbose |
|---|---|
| Type | Boolean |
| Default Value | false |
Enable verbose output.
| Command-Line Format | --print-defaults |
|---|
Print program argument list and exit.
| Command-Line Format | --no-defaults |
|---|
Do not read default options from any option file other than login file.
| Command-Line Format | --defaults-file=path |
|---|---|
| Type | String |
| Default Value | [none] |
Read default options from given file only.
| Command-Line Format | --defaults-extra-file=path |
|---|---|
| Type | String |
| Default Value | [none] |
Read given file after global files are read.
| Command-Line Format | --defaults-group-suffix=string |
|---|---|
| Type | String |
| Default Value | [none] |
Also read groups with concat(group, suffix).
| Command-Line Format | --login-path=path |
|---|---|
| Type | String |
| Default Value | [none] |
Read given path from login file.
| Command-Line Format | --help |
|---|
Display help text and exit.
| Command-Line Format | --usage |
|---|
Display help text and exit; same as --help.
| Command-Line Format | --version |
|---|
Display version information and exit.
| Command-Line Format | --ndb-connectstring=connection-string |
|---|---|
| Type | String |
| Default Value | [none] |
Set connect string for connecting to ndb_mgmd. Syntax: "[nodeid=id;][host=]hostname[:port]". Overrides entries in NDB_CONNECTSTRING and my.cnf.
| Command-Line Format | --connect-string=connection-string |
|---|---|
| Type | String |
| Default Value | [none] |
Same as --ndb-connectstring.
| Command-Line Format | --ndb-mgmd-host=connection-string |
|---|---|
| Type | String |
| Default Value | [none] |
Same as --ndb-connectstring.
| Command-Line Format | --ndb-nodeid=# |
|---|---|
| Type | Integer |
| Default Value | [none] |
Set node ID for this node, overriding any ID set by --ndb-connectstring.
| Command-Line Format | --core-file |
|---|
Write core file on error; used in debugging.
| Command-Line Format | --character-sets-dir=path |
|---|
Directory containing character sets.
| Command-Line Format | --connect-retries=# |
|---|---|
| Type | Integer |
| Default Value | 12 |
| Minimum Value | 0 |
| Maximum Value | 12 |
Number of times to retry connection before giving up.
| Command-Line Format | --connect-retry-delay=# |
|---|---|
| Type | Integer |
| Default Value | 5 |
| Minimum Value | 0 |
| Maximum Value | 5 |
Number of seconds to wait between attempts to contact management server.
--ndb-optimized-node-selection
| Command-Line Format | --ndb-optimized-node-selection |
|---|
Enable optimizations for selection of nodes for transactions. Enabled by default; use --skip-ndb-optimized-node-selection to disable.
As with LOAD DATA, options for field and line formatting much match those used to create the CSV file, whether this was done using SELECT INTO ... OUTFILE, or by some other means. There is no equivalent to the LOAD DATA statement STARTING WITH option.