MariaDB Enterprise ColumnStore Data Loading with cpimport

Intended Use Cases

You can load data using the cpimport tool in the following cases:

• You are loading data into a ColumnStore table from a text file stored on the primary node's file system.

• You are loading data into a ColumnStore table from a binary file stored on the primary node's file system.

• You are loading data into a ColumnStore table from the output of a command running on the primary node.

Locking

MariaDB Enterprise ColumnStore requires a write metadata lock (MDL) on the table when a bulk data load is performed with cpimport.

When a bulk data load is running:

• Read queries will not be blocked.

• Write queries and concurrent bulk data loads on the same table will be blocked until the bulk data load operation is complete, and the write metadata lock on the table has been released.

• The write metadata lock (MDL) can be monitored with the METADATA_LOCK_INFO plugin.

Import the Schema

Before data can be imported into the tables, the schema must be created.

1. Connect to the primary server using MariaDB Client:

   $ mariadb --host 192.168.0.100 --port 5001 \
         --user db_user --password \
         --default-character-set=utf8
   

   After the command is executed, it will prompt you for a password.

2. For each database that you are importing, create the database with the CREATE DATABASE statement:

   CREATE DATABASE inventory;
   

3. For each table that you are importing, create the table with the CREATE TABLE statement:

   CREATE TABLE inventory.products (
      product_name varchar(11) NOT NULL DEFAULT '',
      supplier varchar(128) NOT NULL DEFAULT '',
      quantity varchar(128) NOT NULL DEFAULT '',
      unit_cost varchar(128) NOT NULL DEFAULT ''
   ) ENGINE=Columnstore DEFAULT CHARSET=utf8;
   

   Note

   To get the best performance from Enterprise ColumnStore, make sure to follow Enterprise ColumnStore's best practices for schema design.

Appends Data

When MariaDB Enterprise ColumnStore performs a bulk data load, it appends data to the table in the order in which the data is read. Appending data reduces the I/O requirements of bulk data loads, so that larger data sets can be loaded very efficiently.

While the bulk load is in progress, the newly appended data is temporarily hidden from queries.

After the bulk load is complete, the newly appended data is visible to queries.

Sort the Input File

When MariaDB Enterprise ColumnStore performs a bulk data load, it appends data to the table in the order in which the data is read.

The order of data can have a significant effect on performance with Enterprise ColumnStore, so it can be helpful to sort the data in the input file prior to importing it.

For additional information, see "Load Ordered Data in Proper Order".

Confirm the Field Delimiter

Before importing a file into MariaDB Enterprise ColumnStore, confirm that the field delimiter is not present in the data.

The default field delimiter for the cpimport tool is a pipe (|).

To use a different delimiter, you can set the field delimiter.

Import from Text Files

The cpimport tool can import data from a text file if a file is provided as an argument after the database and table name.

For example, to import the file inventory-products.txt into the products table in the inventory database:

$ sudo cpimport \
   inventory products \
   inventory-products.txt

Import from Binary Files

The cpimport tool can import data from a binary file if the -I1 or -I2 option is provided and a file is provided as an argument after the database and table name.

For example, to import the file inventory-products.bin into the products table in the inventory database:

$ sudo cpimport -I1 \
   inventory products \
   inventory-products.bin

The -I1 and -I2 options allow two different binary import modes to be selected:

The binary file should use the following format for data:

struct Date
{
  unsigned spare : 6;
  unsigned day : 6;
  unsigned month : 4;
  unsigned year : 16
};

struct DateTime
{
  unsigned msecond : 20;
  unsigned second : 6;
  unsigned minute : 6;
  unsigned hour : 6;
  unsigned day : 6;
  unsigned month : 4;
  unsigned year : 16
};

Import from Standard Input

The cpimport tool can import data from standard input (stdin) if no file is provided as an argument.

Importing from standard input is useful in many scenarios.

One scenario is when you want to import data from a remote database. You can use MariaDB Client to query the table using the SELECT statement, and then pipe the results into the standard input of the cpimport tool:

$ mariadb --quick \
   --skip-column-names \
   --execute="SELECT * FROM inventory.products" \
   | cpimport -s '\t' inventory products

Import from S3 using AWS CLI

The cpimport tool can import data from a file stored in a remote S3 bucket.

You can use the AWS CLI to copy the file from S3, and then pipe the contents into the standard input of the cpimport tool:

$ aws s3 cp --quiet s3://columnstore-test/inventory-products.csv - \
   | cpimport -s ',' inventory products

Alternatively, the columnstore_info.load_from_s3 stored procedure can import data from S3-compatible cloud object storage.

Set the Field Delimiter

The default field delimiter for the cpimport tool is a pipe (|).

If your data file uses a different field delimiter, you can specify the field delimiter with the -s option.

For a TSV (tab-separated values) file:

$ sudo cpimport -s '\t' \
   inventory products \
   inventory-products.tsv

For a CSV (comma-separated values) file:

$ sudo cpimport -s ',' \
   inventory products \
   inventory-products.csv

Set the Quoting Style

By default, the cpimport tool does not expect fields to be quoted.

If your data file uses quotes around fields, you can specify the quote character with the -E option.

To load a TSV (tab-separated values) file that uses double quotes:

$ sudo cpimport -s '\t' -E '"' \
   inventory products \
   inventory-products.tsv

To load a CSV (comma-separated values) file that uses optional single quotes:

$ sudo cpimport -s ',' -E "'" \
   inventory products \
   inventory-products.csv

Logging

The cpimport tool writes logs to different directories, depending on the Enterprise ColumnStore version:

• In Enterprise ColumnStore 5.5.2 and later, logs are written to /var/log/mariadb/columnstore/bulk/

• In Enterprise ColumnStore 5 releases before 5.5.2, logs are written to /var/lib/columnstore/data/bulk/

• In Enterprise ColumnStore 1.4, logs are written to /usr/local/mariadb/columnstore/bulk/

Special Handling