All pages
Powered by GitBook
1 of 4

Loading...

Loading...

Loading...

Loading...

ColumnStore Streaming Data Adapters

Streaming data adapters for MariaDB ColumnStore built on the Bulk Data API, including the deprecated MaxScale CDC adapter and a Kafka adapter for ETL and real-time ingestion.

The enables the creation of higher performance adapters for ETL integration and data ingestions. The Streaming Data Adapters are out of box adapters using these API for specific data sources and use cases.

  • MaxScale CDC Data Adapter is integration of the MaxScale CDC streams into MariaDB ColumnStore.

  • Kafka Data Adapter is integration of the Kafka streams into MariaDB ColumnStore.

MaxScale CDC Data Adapter

The MaxScale CDC Data Adapter allows streaming change data events (binary log events) from MariaDB Master hosting non-columnstore engines (InnoDB, MyRocks, MyISAM) to MariaDB ColumnStore. In other words, replicate data from a MariaDB master server to MariaDB ColumnStore. It acts as a CDC Client for MaxScale and uses the events received from MaxScale as input to MariaDB ColumnStore Bulk Data API to push the data to MariaDB ColumnStore. maxscale-cdc-adapter

It registers with MariaDB MaxScale as a CDC Client using the MaxScale CDC Connector API, receiving change data records from MariaDB MaxScale (that are converted from binlog events received from the Master on MariaDB TX) in a JSON format. Then, using the MariaDB ColumnStore bulk write SDK, it converts the JSON data into API calls and streams it to a MariaDB PM node. The adapter has options to insert all the events in the same schema as the source database table or insert each event with metadata as well as table data. The event meta data includes the event timestamp, the GTID, event sequence and event type (insert, update, delete).

Installation

Pre-requisite:

  • Download and install MaxScale CDC Connector API from connector.

  • Download and install MariaDB ColumnStore bulk write SDK from columnstore-bulk-write-sdk.md.

CentOS 7

Debian 9/Ubuntu Xenial:

Debian 8:

Usage

Streaming Multiple Tables

To stream multiple tables, use the -f parameter to define a path to a TSV formatted file. The file must have one database and one table name per line. The database and table must be separated by a TAB character and the line must be terminated in a newline (\n).

Here is an example file with two tables, t1 and t2 both in the test database:

Automated Table Creation on ColumnStore

You can have the adapter automatically create the tables on the ColumnStore instance with the -an option. In this case, the user used for cross-engine queries will be used to create the table (the values in ColumnStore.CrossEngineSupport). This user requires CREATE privileges on all streamed databases and tables.

Data Transformation Mode

The -z option enables the data transformation mode. In this mode, the data is converted from historical, append-only data to the current version of the data. In practice, this replicates changes from a MariaDB master server to ColumnStore via the MaxScale CDC.

Quick Start

Download and install both MaxScale and ColumnStore.

Copy the Columnstore.xml file from /usr/local/mariadb/columnstore/etc/ColumnStore.xml from one of the ColumnStore PrimProc nodes to the server where the adapter is installed.

Configure MaxScale according to the .

Create a CDC user by executing the following MaxAdmin command on the MaxScale server. Replace the <service> with the name of the avrorouter service and <user> and <password> with the credentials that are to be created.

Then we can start the adapter by executing the following command.

The <database> and <table> define the table that is streamed to ColumnStore. This table should exist on the master server where MaxScale is reading events from. If the table is not created on ColumnStore, the adapter will print instructions on how to define it in the correct way.

The <user> and <password> are the users created for the CDC user, <host> is the MaxScale address and <port> is the port where the CDC service listener is listening.

The -c flag is optional if you are running the adapter on the server where ColumnStore is located.

Kafka to ColumnStore Adapter

The Kafka data adapter streams all messages published to Apache Kafka topics in Avro format to MariaDB ColumnStore automatically and continuously - enabling data from many sources to be streamed and collected for analysis without complex code. The Kafka adapter is built using librdkafka and the MariaDB ColumnStore bulk write SDK

kafka-data-adapter

A tutorial for the Kafka adapter for ingesting Avro formatted data can be found in the kafka-to-columnstore-data-adapter document.

ColumnStore - Pentaho Data Integration - Data Adapter

Starting with MariaDB ColumnStore 1.1.4, a data adapter for Pentaho Data Integration (PDI) / Kettle is available to import data directly into ColumnStore’s WriteEngine. It is built on MariaDB’s rapid-paced Bulk Write SDK.

PDI Plugin Block info graphic

Compatibility notice

The plugin was designed for the following software composition:

  • Operating system: Windows 10 / Ubuntu 16.04 / RHEL/CentOS 7+

  • MariaDB ColumnStore >= 1.1.4

  • MariaDB Java Database client* >= 2.2.1

  • Java >= 8

  • Pentaho Data Integration >= 7 +not officially supported by Pentaho.

*Only needed if you want to execute DDL.

Installation

The following steps are necessary to install the ColumnStore Data adapter (bulk loader plugin):

  1. Build the plugin from source or download it from our website

  2. Extract the archive mariadb-columnstore-kettle-bulk-exporter-plugin-*.zip into your PDI installation directory $PDI-INSTALLATION/plugins.

  3. Copy MariaDB's JDBC Client mariadb-java-client-2.2.x.jar into PDI's lib directory $PDI-INSTALLATION/lib.

  4. Install the additional library dependencies

Ubuntu dependencies

CentOS dependencies

Windows 10 dependencies

On Windows the installation of the Visual Studio 2015/2017 C++ Redistributable (x64) is required.

Configuration

Each MariaDB ColumnStore Bulk Loader block needs to be configured. On the one hand, it needs to know how to connect to the underlying Bulk Write SDK to inject data into ColumnStore, and on the other hand, it needs to have a proper JDBC connection to execute DDL.

Both configurations can be set in each block’s settings tab.

PDI Plugin Block settings info graphic

The database connection configuration follows PDI’s default schema.

By default, the plugin tries to use ColumnStore's default configuration /usr/local/mariadb/columnstore/etc/ColumnStore.xml to connect to the ColumnStore instance through the Bulk Write SDK. In addition, individual paths or variables can be used too.

Information on how to prepare the ColumnStore.xml configuration file can be found here.

Usage

PDI Plugin Block mapping info graphic

Once a block is configured and all inputs are connected in PDI, the inputs have to be mapped to ColumnStore’s table format.

One can either choose “Map all inputs”, which sets target columns of adequate type, or choose a custom mapping based on the structure of the existing table.

The SQL button can be used to generate DDL based on the defined mapping and to execute it.

Limitations

This plugin is a beta release.

In addition, it can't handle blob data types and only supports multiple inputs to one block if the input field names are equal for all input sources.

This page is: Copyright © 2025 MariaDB. All rights reserved.

ColumnStore Bulk Data API
sudo yum -y install epel-release
sudo yum -y install <data adapter>.rpm
sudo apt-get update
sudo dpkg -i <data adapter>.deb
sudo apt-get -f install
sudo echo "deb http://httpredir.debian.org/debian jessie-backports main contrib non-free" >> /etc/apt/sources.list
sudo apt-get update
sudo dpkg -i <data adapter>.deb
sudo apt-get -f install
Usage: mxs_adapter [OPTION]... DATABASE TABLE

 -f FILE      TSV file with database and table names to stream (must be in `database TAB table NEWLINE` format)
  -h HOST      MaxScale host (default: 127.0.0.1)
  -P PORT      Port number where the CDC service listens (default: 4001)
  -u USER      Username for the MaxScale CDC service (default: admin)
  -p PASSWORD  Password of the user (default: mariadb)
  -c CONFIG    Path to the Columnstore.xml file (default: '/usr/local/mariadb/columnstore/etc/Columnstore.xml')
  -a           Automatically create tables on ColumnStore
  -z           Transform CDC data stream from historical data to current data (implies -n)
  -s           Directory used to store the state files (default: '/var/lib/mxs_adapter')
  -r ROWS      Number of events to group for one bulk load (default: 1)
  -t TIME      Connection timeout (default: 10)
  -n           Disable metadata generation (timestamp, GTID, event type)
  -i TIME      Flush data every TIME seconds (default: 5)
  -l FILE      Log output to FILE instead of stdout
  -v           Print version and exit
  -d           Enable verbose debug output
test	t1
test	t2
maxadmin call command cdc add_user <service> <user> <password>
mxs_adapter -u <user> -p <password> -h <host> -P <port> -c <path to Columnstore.xml> <database><table>
sudo apt-get install libuv1 libxml2 libsnappy1v5
sudo yum install epel-release
sudo yum install libuv libxml2 snappy

The MaxScale CDC Data Adapter has been deprecated.

This mode is not as fast as the append-only mode and might not be suitable for heavy workloads. This is due to the fact that the data transformation is done via various DML statements.

spinner

ColumnStore Insert Cache

The MariaDB ColumnStore Insert Cache buffers small INSERTs in a hidden Aria table before flushing in batches to columnar storage, improving throughput for HTAP and write-heavy workloads.

Description

The ColumnStore Insert Cache is a performance optimization feature that improves INSERT operations in MariaDB ColumnStore, especially for write-heavy workloads. It uses a hidden Aria table that serves as a fast front‑end buffer before data is flushed to ColumnStore's columnar storage.

When this feature is enabled, inserts are first written to a lightweight internal Aria table (the cache table), and later flushed in batches to the ColumnStore storage engine. Because Aria is a built-in, memory‑optimized storage engine, inserts into its cache table are considerably faster than inserting directly into ColumnStore. This significantly improves insert performance by reducing the overhead of writing directly to ColumnStore for each row.

A write-heavy workload consists of:

  • High volumes of INSERT statements

  • Occasional DELETE, UPDATE, or SELECT statements

This feature was originally developed for deployments, in which an InnoDB primary replicates to a ColumnStore replica (including single- and multi-node deployments), allowing the ColumnStore replica to maintain with the InnoDB primary's high insert rates.

This insert cache feature is not limited to HTAP environments; it can also be enabled in standalone ColumnStore deployments.

By default, the insert cache is disabled. When enabled, the insert cache significantly improves insert throughput.

Purpose

is designed for analytical queries and large-scale batch workloads. However, workloads that rely on frequent small inserts may see lower throughput when writing directly to ColumnStore.

The insert cache feature addresses this by:

  • Buffering inserts in a lightweight storage engine (Aria)

  • Flushing cached data in larger batches

  • Reducing write amplification and SQL layer overhead

This makes ColumnStore particularly well-suited for write-heavy workloads, HTAP deployments, replication scenarios where data is moved from InnoDB to ColumnStore, and environments that involve frequent INSERT statements or LOAD DATA INFILE operations.

Supported Insert Operations

When this feature is enabled, the performance of the following types of inserts is improved:

  • Single-row INSERT statements

  • Multi-row INSERT statements

  • LOAD DATA INFILE statements

Other DML operations such as UPDATE, DELETE, and INSERT ... SELECT do not benefit from the insert cache.

How the Insert Cache Works

When columnstore_cache_inserts=ON:

  1. A hidden Aria table (cache table) is automatically created internally when a new ColumnStore table is created.

  2. This Aria table acts as a front-end for incoming inserts, writing operations rapidly to the cache table using MariaDB’s lightweight storage engine.

  3. Cached rows are flushed into the actual ColumnStore table when one of the following event occurs:

The flush operation writes accumulated rows to ColumnStore in bulk.

When to Use the Insert Cache

Ideal use cases for ColumnStore include:

  • Write-heavy workloads

  • Environments with high-frequency insert operations

  • Replication from InnoDB to ColumnStore

  • HTAP deployments

When to Avoid the Insert Cache

Avoid enabling when:

  • Strict transactional behavior with rollback support are required

  • Workloads are update-heavy rather than insert-heavy

  • Flush fragmentation caused by cpimport is undesirable

Configuration

Enabling the Insert Cache

The insert cache is disabled by default. The following system variable manages the insert cache:

  1. To enable the insert cache, add the following to your MariaDB configuration file:

  1. After modifying the setting, restart the MariaDB server.

  2. Once the server is restarted, verify the setting with:

This setting applies globally to all ColumnStore tables created while it is enabled.

Flush Threshold

Defines the number of cached rows that trigger an automatic flush to ColumnStore.

When set to lower values:

  • More frequent flushes

  • Potentially reduced performance

When set to higher values:

  • Fewer flushes

  • Larger batch writes

The optimal value depends on workload characteristics.

Import-Based Flush Mode

When enabled, cache flushes use cpimport instead of the internal batch SQL processing mode.

Default Behavior (OFF)

  • Flush uses ColumnStore's internal batch processing mode

  • Writes go through the SQL layer

When Enabled (ON)

  • Flush uses cpimport

  • Bypasses the ColumnStore SQL layer

  • Significantly improves flush performance for large batches

Important Consideration

When columnstore_cache_use_import=ON is enabled, frequent flushes can cause disk fragmentation in database files. This occurs because each cpimport operation begins inserting data at a new block boundary, creating fragmentation (“holes”) with every flush.

DBAs should evaluate workload characteristics before enabling this option.

Configuration Variables

columnstore_cache_inserts

Scope: Global Dynamic: No (requires restart) Default: OFF Description: Enables or disables the insert cache feature globally

columnstore_cache_flush_threshold

Scope: Global / Session Default: 500000 Description: Maximum number of rows to cache before automatic flush

columnstore_cache_use_import

Scope: Global Default: OFF Description: Use cpimport for cache flush instead of batch processing mode

For comprehensive details on system configuration variables, refer to .

Performance Characteristics

Internal benchmarking showed significant improvements in insert throughput:

  • ~4642x improvement for 50,000 single-row inserts

  • ~4763x improvement for 100,000 single-row inserts

These benchmarks were performed before the introduction of columnstore_cache_use_import. Enabling import-based flush mode may provide additional improvements depending on workload.

Actual performance gains depend on:

  • Insert batch size

  • Flush threshold configuration

  • Use of replication

  • Storage configuration

Replication and HTAP Use Cases

The insert cache was originally designed for HTAP deployments where:

  • An InnoDB master manages transactional workloads

  • A ColumnStore replica handles analytical queries

  • High insert rates must be maintained on the replica

With this configuration, the insert cache enables the ColumnStore replica to handle replication traffic more efficiently.

The feature is supported for:

  • Single-node ColumnStore deployments

  • Multi-node ColumnStore clusters

It is not limited to replication scenarios and can be used in standalone ColumnStore environments.

Operational Considerations

Global Scope

The insert cache is a global setting. It is not configurable per table. All ColumnStore tables created while the cache is enabled will use the insert cache.

Orphaned Tables

ColumnStore tables created with the insert cache enabled create corresponding hidden Aria cache tables. These tables must be dropped while the insert cache remains enabled. Dropping such tables with columnstore_cache_inserts=OFF may leave orphaned hidden Aria tables.

Unflushed Records Visibility

Rows that remain unflushed in the insert cache are not visible to queries executed after the cache is disabled; they only become accessible once the cache is re‑enabled and flushed.

Transactional Behavior

Because the cache uses Aria at the front-end, which is a non-transactional storage engine:

  • ROLLBACK is not supported for cached inserts

  • The insert cache is not suitable for transactional workloads that require rollback support

Limitations

The insert cache feature has certain limitations, including:

  • No rollback support for cached inserts

  • Global-only configuration (not per-table)

  • Potential file fragmentation when using import mode

  • Non-insert DML operations such as INSERT..SELECT

See Also

A non-insert statement is executed (SELECT, UPDATE, DELETE, INSERT ... SELECT)
  • The number of cached rows exceeds columnstore_cache_flush_threshold

  • A server restart occurs

  • Once flushed, the data becomes visible to all queries.

  • Insert rates are low and performance gain is negligible
    ,
    DELETE
    , and
    UPDATE
    are not accelerated by the cache and will trigger and immediate flush any pending data.
    INSERT INTO t1 VALUES ();
    INSERT INTO t1 VALUES (), ();
    columnstore_cache_inserts
    [mariadb]
    loose-columnstore_cache_inserts=ON
    SHOW VARIABLES LIKE 'columnstore_cache_inserts';
    columnstore_cache_flush_threshold
    columnstore_cache_use_import

    The loose- prefix is required for ColumnStore system variables in the configuration file. Without it, MariaDB Server will fail to start if the ColumnStore plugin is not installed or has been removed.

    ColumnStore
    ColumnStore System Variables
    LOAD DATA INFILE in ColumnStore
    ColumnStore System Variables

    ColumnStore Bulk Data Loading

    Bulk data loading in MariaDB ColumnStore uses cpimport for fast append-only ingestion of delimited flat files, with tokenization and atomic high-water-mark commits.

    Overview

    cpimport is a high-speed bulk load utility that imports data into ColumnStore tables in a fast and efficient manner. It accepts as input any flat file containing data that contains a delimiter between fields of data (i.e. columns in a table). The default delimiter is the pipe (‘|’) character, but other delimiters such as commas may be used as well. The data values must be in the same order as the create table statement, i.e. column 1 matches the first column in the table and so on. Date values must be specified in the format 'yyyy-mm-dd'.

    cpimport – performs the following operations when importing data into a MariaDB ColumnStore database:

    • Data is read from specified flat files.

    • Data is transformed to fit ColumnStore’s column-oriented storage design.

    • Redundant data is tokenized and logically compressed.

    • Data is written to disk.

    It is important to note that:

    • The bulk loads are an append operation to a table, so they allow existing data to be read and remain unaffected during the process.

    • The bulk loads do not write their data operations to the transaction log; they are not transactional in nature but are considered an atomic operation at this time. Information markers, however, are placed in the transaction log so the DBA is aware that a bulk operation did occur.

    • Upon completion of the load operation, a high-water mark in each column file is moved in an atomic operation that allows for any subsequent queries to read the newly loaded data. It appends operation provides for consistent read but does not incur the overhead of logging the data.

    There are two primary steps to using the cpimport utility:

    1. Optionally create a job file that is used to load data from a flat file into multiple tables.

    2. Run the cpimport utility to perform the data import.

    Syntax

    The simplest form of cpimport command is

    The full syntax is like this:

    cpimport modes

    Mode 1: Bulk Load from a central location with single data source file

    In this mode, you run the cpimport from your primary node (mcs1). The source file is located at this primary location and the data from cpimport is distributed across all the nodes. If no mode is specified, then this is the default.

    Example:

    Mode 2: Bulk load from central location with distributed data source files

    In this mode, you run the cpimport from your primary node (mcs1). The source data is in already partitioned data files residing on the PMs. Each PM should have the source data file of the same name but containing the partitioned data for the PM

    Example:

    Mode 3: Parallel distributed bulk load

    In this mode, you run cpimport from the individual nodes independently, which will import the source file that exists on that node. Concurrent imports can be executed on every node for the same table.

    Example:

    Note:

    • The bulk loads are an append operation to a table, so they allow existing data to be read and remain unaffected during the process.

    • The bulk loads do not write their data operations to the transaction log; they are not transactional in nature but are considered an atomic operation at this time. Information markers, however, are placed in the transaction log so the DBA is aware that a bulk operation did occur.

    • Upon completion of the load operation, a high-water mark in each column file is moved in an atomic operation that allows for any subsequent queries to read the newly loaded data. It appends operation provides for consistent read but does not incur the overhead of logging the data.

    Bulk loading data from STDIN

    Data can be loaded from STDIN into ColumnStore by simply not including the loadFile parameter

    Example:

    Bulk loading from AWS S3

    Similarly the AWS cli utility can be utilized to read data from an s3 bucket and pipe the output into cpimport allowing direct loading from S3. This assumes the aws cli program has been installed and configured on the host:

    Example:

    For troubleshooting connectivity problems remove the --quiet option which suppresses client logging including permission errors.

    Bulk loading output of SELECT FROM Table(s)

    Standard in can also be used to directly pipe the output from an arbitrary SELECT statement into cpimport. The select statement may select from non-columnstore tables such as or . In the example below, the db2.source_table is selected from, using the -N flag to remove non-data formatting. The -q flag tells the mysql client to not cache results which will avoid possible timeouts causing the load to fail.

    Example:

    Bulk loading from JSON

    Let's create a sample ColumnStore table:

    Now let's create a sample products.json file like this:

    We can then bulk load data from JSON into Columnstore by first piping the data to and then to using a one-line command.

    Example:

    In this example, the JSON data is coming from a static JSON file, but this same method will work for, and output streamed from any datasource using JSON such as an API or NoSQL database. For more information on 'jq', please view the manual here .

    Bulk loading into multiple tables

    There are two ways multiple tables can be loaded:

    1. Run multiple cpimport jobs simultaneously. Tables per import should be unique or for each import should be unique if using mode 3.

    2. Use colxml utility: colxml creates an XML job file for your database schema before you can import data. Multiple tables may be imported by either importing all tables within a schema or listing specific tables using the -t option in colxml. Then, using cpimport, that uses the job file generated by colxml. Here is an example of how to use colxml and cpimport to import data into all the tables in a database schema

    colxml syntax

    Example usage of colxml

    The following tables comprise a database name ‘tpch2’:

    1. First, put delimited input data file for each table in /usr/local/mariadb/columnstore/data/bulk/data/import. Each file should be named .tbl.

    2. Run colxml for the load job for the ‘tpch2’ database as shown here:

    Now actually run cpimport to use the job file generated by the colxml execution

    Handling Differences in Column Order and Values

    If there are some differences between the input file and table definition then the colxml utility can be utilized to handle these cases:

    • Different order of columns in the input file from table order

    • Input file column values to be skipped / ignored.

    • Target table columns to be defaulted.

    In this case run the colxml utility (the -t argument can be useful for producing a job file for one table if preferred) to produce the job xml file and then use this a template for editing and then subsequently use that job file for running cpimport.

    Consider the following simple table example:

    This would produce a colxml file with the following table element:

    If your input file had the data such that hire_date comes before salary then the following modification will allow correct loading of that data to the original table definition (note the last 2 Column elements are swapped):

    The following example would ignore the last entry in the file and default salary to it's default value (in this case null):

    • IgnoreFields instructs cpimport to ignore and skip the particular value at that position in the file.

    • DefaultColumn instructs cpimport to default the current table column and not move the column pointer forward to the next delimiter.

    Both instructions can be used indepedently and as many times as makes sense for your data and table definition.

    Binary Source Import

    It is possible to import using a binary file instead of a CSV file using fixed length rows in binary data. This can be done using the '-I' flag which has two modes:

    • -I1 - binary mode with NULLs accepted Numeric fields containing NULL will be treated as NULL unless the column has a default value

    • -I2 - binary mode with NULLs saturated NULLs in numeric fields will be saturated

    The following table shows how to represent the data in the binary format:

    Datatype
    Description

    For NULL values the following table should be used:

    Datatype
    Signed NULL
    Unsigned NULL

    Date Struct

    The spare bits in the Date struct "must" be set to 0x3E.

    DateTime Struct

    Working Folders & Logging

    As of version 1.4, cpimport uses the /var/lib/columnstore/bulk folder for all work being done. This folder contains:

    1. Logs

    2. Rollback info

    3. Job info

    4. A staging folder

    The log folder typically contains:

    A typical log might look like this:

    Prior to version 1.4, this folder was located at /usr/local/mariadb/columnstore/bulk.

    This page is: Copyright © 2025 MariaDB. All rights reserved.

    Using the Date struct below

    DATETIME

    Using the DateTime struct below

    DECIMAL

    Stored using an integer representation of the DECIMAL without the decimal point. With precision/width of 2 or less 2 bytes should be used, 3-4 should use 3 bytes, 4-9 should use 4 bytes and 10+ should use 8 bytes

    0x8000

    0xFFFE

    TINYINT

    0x80

    0xFE

    DECIMAL

    As equiv. INT

    As equiv. INT

    FLOAT

    0xFFAAAAAA

    N/A

    DOUBLE

    0xFFFAAAAAAAAAAAAAULL

    N/A

    DATE

    0xFFFFFFFE

    N/A

    DATETIME

    0xFFFFFFFFFFFFFFFEULL

    N/A

    CHAR/VARCHAR

    Fill with '\0'

    N/A

    cpimport dbName tblName [loadFile]
    cpimport dbName tblName [loadFile]
    [-h] [-m mode] [-f filepath] [-d DebugLevel]
    [-c readBufferSize] [-b numBuffers] [-r numReaders]
    [-e maxErrors] [-B libBufferSize] [-s colDelimiter] [-E EnclosedByChar]
    [-C escChar] [-j jobID] [-p jobFilePath] [-w numParsers]
    [-n nullOption] [-P pmList] [-i] [-S] [-q batchQty]
    
    positional parameters:
    	dbName     Name of the database to load
    	tblName    Name of table to load
    	loadFile   Optional input file name in current directory,
    			unless a fully qualified name is given.
    			If not given, input read from STDIN.
    Options:
    	-b	Number of read buffers
    	-c	Application read buffer size(in bytes)
    	-d	Print different level(1-3) debug message
    	-e	Max number of allowable error per table per PM
    	-f	Data file directory path.
    			Default is current working directory.
    			In Mode 1, -f represents the local input file path.
    			In Mode 2, -f represents the PM based input file path.
    			In Mode 3, -f represents the local input file path.
    	-l	Name of import file to be loaded, relative to -f path. (Cannot be used with -p)
    	-h	Print this message.
    	-q	Batch Quantity, Number of rows distributed per batch in Mode 1
    	-i	Print extended info to console in Mode 3.
    	-j	Job ID. In simple usage, default is the table OID.
    			unless a fully qualified input file name is given.
    	-n	NullOption (0-treat the string NULL as data (default);
    			1-treat the string NULL as a NULL value)
    	-p	Path for XML job description file.
    	-r	Number of readers.
    	-s	The delimiter between column values.
    	-B	I/O library read buffer size (in bytes)
    	-w	Number of parsers.
    	-E	Enclosed by character if field values are enclosed.
    	-C	Escape character used in conjunction with 'enclosed by'
    			character, or as part of NULL escape sequence ('\N');
    			default is '\'
    	-I	Import binary data; how to treat NULL values:
    			1 - import NULL values
    			2 - saturate NULL values
    	-P	List of PMs ex: -P 1,2,3. Default is all PMs.
    	-S	Treat string truncations as errors.
    	-m	mode
    			1 - rows will be loaded in a distributed manner across PMs.
    			2 - PM based input files loaded onto their respective PM.
    			3 - input files will be loaded on the local PM.
    cpimport -m1 mytest mytable mytable.tbl
    cpimport -m2 mytest mytable -l /home/mydata/mytable.tbl
    cpimport -m3 mytest mytable /home/mydata/mytable.tbl
    cpimport db1 table1
    aws s3 cp --quiet s3://dthompson-test/trades_bulk.csv - | cpimport test trades -s ","
    mariadb -q -e 'select * from source_table;' -N <source-db> | cpimport -s '\t' <target-db> <target-table>
    CREATE DATABASE `json_columnstore`;
    
    USE `json_columnstore`;
    
    CREATE TABLE `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;
    [{
      "_id": {
        "$oid": "5968dd23fc13ae04d9000001"
      },
      "product_name": "Sildenafil Citrate",
      "supplier": "Wisozk Inc",
      "quantity": 261,
      "unit_cost": "$10.47"
    }, {
      "_id": {
        "$oid": "5968dd23fc13ae04d9000002"
      },
      "product_name": "Mountain Juniperus Ashei",
      "supplier": "Keebler-Hilpert",
      "quantity": 292,
      "unit_cost": "$8.74"
    }, {
      "_id": {
        "$oid": "5968dd23fc13ae04d9000003"
      },
      "product_name": "Dextromethorphan HBR",
      "supplier": "Schmitt-Weissnat",
      "quantity": 211,
      "unit_cost": "$20.53"
    }]
    cat products.json | jq -r '.[] | [.product_name,.supplier,.quantity,.unit_cost] | @csv' | cpimport json_columnstore products -s ',' -E '"'
    colxml mytest -j299
    cpimport -m1 -j299
    Usage: colxml [options] dbName
    
    Options: 
       -d Delimiter (default '|')
       -e Maximum allowable errors (per table)
       -h Print this message
       -j Job id (numeric)
       -l Load file name
       -n "name in quotes"
       -p Path for XML job description file that is generated
       -s "Description in quotes"
       -t Table name
       -u User
       -r Number of read buffers
       -c Application read buffer size (in bytes)
       -w I/O library buffer size (in bytes), used to read files
       -x Extension of file name (default ".tbl")
       -E EnclosedByChar (if data has enclosed values)
       -C EscapeChar
       -b Debug level (1-3)
    MariaDB[tpch2]> show tables;
    +---------------+
    | Tables_in_tpch2 |
    +--------------+
    | customer    |
    | lineitem    |
    | nation      |
    | orders      |
    | part        |
    | partsupp    |
    | region      |
    | supplier    |
    +--------------+
    8 rows in set (0.00 sec)
    /usr/local/mariadb/columnstore/bin/colxml tpch2 -j500
    Running colxml with the following parameters:
    2015-10-07 15:14:20 (9481) INFO :
    Schema: tpch2
    Tables:
    Load Files:
    -b 0
    -c 1048576
    -d |
    -e 10
    -j 500
    -n
    -p /usr/local/mariadb/columnstore/data/bulk/job/
    -r 5
    -s
    -u
    -w 10485760
    -x tbl
    File completed for tables:
    tpch2.customer
    tpch2.lineitem
    tpch2.nation
    tpch2.orders
    tpch2.part
    tpch2.partsupp
    tpch2.region
    tpch2.supplier
    Normal exit.
    /usr/local/mariadb/columnstore/bin/cpimport -j 500
    Bulkload root directory : /usr/local/mariadb/columnstore/data/bulk
    job description file : Job_500.xml
    2015-10-07 15:14:59 (9952) INFO : successfully load job file /usr/local/mariadb/columnstore/data/bulk/job/Job_500.xml
    2015-10-07 15:14:59 (9952) INFO : PreProcessing check starts
    2015-10-07 15:15:04 (9952) INFO : PreProcessing check completed
    2015-10-07 15:15:04 (9952) INFO : preProcess completed, total run time : 5 seconds
    2015-10-07 15:15:04 (9952) INFO : No of Read Threads Spawned = 1
    2015-10-07 15:15:04 (9952) INFO : No of Parse Threads Spawned = 3
    2015-10-07 15:15:06 (9952) INFO : For table tpch2.customer: 150000 rows processed and 150000 rows inserted.
    2015-10-07 15:16:12 (9952) INFO : For table tpch2.nation: 25 rows processed and 25 rows inserted.
    2015-10-07 15:16:12 (9952) INFO : For table tpch2.lineitem: 6001215 rows processed and 6001215 rows inserted.
    2015-10-07 15:16:31 (9952) INFO : For table tpch2.orders: 1500000 rows processed and 1500000 rows inserted.
    2015-10-07 15:16:33 (9952) INFO : For table tpch2.part: 200000 rows processed and 200000 rows inserted.
    2015-10-07 15:16:44 (9952) INFO : For table tpch2.partsupp: 800000 rows processed and 800000 rows inserted.
    2015-10-07 15:16:44 (9952) INFO : For table tpch2.region: 5 rows processed and 5 rows inserted.
    2015-10-07 15:16:45 (9952) INFO : For table tpch2.supplier: 10000 rows processed and 10000 rows inserted.
    CREATE TABLE emp (
    emp_id INT, 
     dept_id INT,
    name VARCHAR(30), 
    salary INT, 
    hire_date DATE) ENGINE=columnstore;
    <Table tblName="test.emp" 
          loadName="emp.tbl" maxErrRow="10">
       <Column colName="emp_id"/>
       <Column colName="dept_id"/>
       <Column colName="name"/>
       <Column colName="salary"/>
       <Column colName="hire_date"/>
     </Table>
    <Table tblName="test.emp" 
          loadName="emp.tbl" maxErrRow="10">
       <Column colName="emp_id"/>
       <Column colName="dept_id"/>
       <Column colName="name"/>
       <Column colName="hire_date"/>
       <Column colName="salary"/>
     </Table>
    <Table tblName="test.emp"        
               loadName="emp.tbl" maxErrRow="10">
          <Column colName="emp_id"/>
          <Column colName="dept_id"/>
          <Column colName="name"/>
          <Column colName="hire_date"/>
          <IgnoreField/>
          <DefaultColumn colName="salary"/>
        </Table>
    Example
    cpimport -I1 mytest mytable /home/mydata/mytable.bin

    INT/TINYINT/SMALLINT/BIGINT

    Little-endian format for the numeric data

    FLOAT/DOUBLE

    IEEE format native to the computer

    CHAR/VARCHAR

    Data padded with '\0' for the length of the field. An entry that is all '\0' is treated as NULL

    BIGINT

    0x8000000000000000ULL

    0xFFFFFFFFFFFFFFFEULL

    INT

    0x80000000

    0xFFFFFFFE

    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
    };
    -rw-r--r--. 1 root  root        0 Dec 29 06:41 cpimport_1229064143_21779.err
    -rw-r--r--. 1 root  root     1146 Dec 29 06:42 cpimport_1229064143_21779.log
    2020-12-29 06:41:44 (21779) INFO : Running distributed import (mode 1) on all PMs...
    2020-12-29 06:41:44 (21779) INFO2 : /usr/bin/cpimport.bin -s , -E " -R /tmp/columnstore_tmp_files/BrmRpt112906414421779.rpt -m 1 -P pm1-21779 -T SYSTEM -u388952c1-4ab8-46d6-9857-c44827b1c3b9 bts flights
    2020-12-29 06:41:58 (21779) INFO2 : Received a BRM-Report from 1
    2020-12-29 06:41:58 (21779) INFO2 : Received a Cpimport Pass from PM1
    2020-12-29 06:42:03 (21779) INFO2 : Received a BRM-Report from 2
    2020-12-29 06:42:03 (21779) INFO2 : Received a Cpimport Pass from PM2
    2020-12-29 06:42:03 (21779) INFO2 : Received a BRM-Report from 3
    2020-12-29 06:42:03 (21779) INFO2 : BRM updated successfully
    2020-12-29 06:42:03 (21779) INFO2 : Received a Cpimport Pass from PM3
    2020-12-29 06:42:04 (21779) INFO2 : Released Table Lock
    2020-12-29 06:42:04 (21779) INFO2 : Cleanup succeed on all PMs
    2020-12-29 06:42:04 (21779) INFO : For table bts.flights: 374573 rows processed and 374573 rows inserted.
    2020-12-29 06:42:04 (21779) INFO : Bulk load completed, total run time : 20.3052 seconds
    2020-12-29 06:42:04 (21779) INFO2 : Shutdown of all child threads Finished!!
    jq
    cpimport
    here
    PMs
    spinner
    cpimport-mode1
    cpimport-mode2
    cpimport-mode3

    DATE

    SMALLINT

    CDC tutorial
    Hybrid Transactional/Analytical Processing (HTAP)
    System Variables Reference
    Aria Storage Engine
    MyISAM
    InnoDB

    Data Ingestion Methods & Tools

    Data ingestion options for MariaDB ColumnStore: cpimport for fast bulk loads, LOAD DATA INFILE, batch insert mode, INSERT INTO .. SELECT, DML, plus Bulk Write SDK and streaming adapters.

    ColumnStore provides several mechanisms to ingest data:

    • cpimport provides the fastest performance for inserting data and ability to route data to particular PrimProc nodes. Normally, this should be the default choice for loading data .

    • LOAD DATA INFILE provides another means of bulk inserting data.

      • By default, with autocommit on, it internally streams the data to an instance of the cpimport process.

      • In transactional mode, DML inserts are performed, which is significantly slower and also consumes both binlog transaction files and ColumnStore VersionBuffer files.

    • DML, i.e. INSERT, UPDATE, and DELETE, provide row-level changes. ColumnStore is optimized towards bulk modifications, so these operations are slower than they would be in, for instance, InnoDB.

      • Currently ColumnStore does not support operating as a replication replica target.

    • Using ColumnStore Bulk Write SDK or .

    This page is: Copyright © 2025 MariaDB. All rights reserved.

    Bulk DML operations will in general perform better than multiple individual statements.
    • with autocommit behaves similarly to LOAD DATE INFILE because, internally, it is mapped to cpimport for higher performance.

    • Bulk update operations based on a join with a small staging table can be relatively fast, especially if updating a single column.

    ColumnStore Streaming Data Adapters
    spinner
    INSERT INTO SELECT