wiki/duckdb/how-to-setup-duckdb-node-en.md
[ 快速部署 AliSQL DuckDB 节点 | How to setup DuckDB node in AliSQL ]
AliSQL integrates DuckDB as an analytical storage engine.
mysql.*, data dictionary)You can:
Use this when you are creating a fresh instance and want newly created tables to land in DuckDB by default.
git clone https://github.com/alibaba/AliSQL.git
cd AliSQL
sh build.sh -t release -d /opt/alisql
make install
# For example, use x86 el6 rpm for installation
wget https://github.com/alibaba/AliSQL/releases/download/AliSQL-8.0.44-1/alisql-8.0.44-1.el8.x86_64.rpm
rpm -ivh alisql-8.0.44-1.el8.x86_64.rpm
cat > init_alisql_dir.sh <<'EOF'
#!/usr/bin/env bash
set -euo pipefail
# Usage:
# ./init_alisql_dir.sh <absolute_path>
if [[ $# -ne 1 ]]; then
echo "Usage: $0 <absolute_path>"
exit 1
fi
DIR="$1"
if [[ "$DIR" != /* ]]; then
echo "Error: Argument must be an ABSOLUTE PATH (starting with /)."
exit 1
fi
DIR="${DIR%/}"
mkdir -p \
"$DIR/data/dbs" \
"$DIR/data/mysql" \
"$DIR/run" \
"$DIR/log/mysql" \
"$DIR/tmp"
cat > "$DIR/alisql.cnf" <<EOF2
[mysqld]
# --- Paths ---
datadir = ${DIR}/data/dbs
socket = ${DIR}/run/mysql.sock
pid-file = ${DIR}/run/mysqld.pid
tmpdir = ${DIR}/tmp
# --- Basic ---
character_set_server = utf8mb4
skip_ssl
lower_case_table_names = 1
core-file
# --- Logs ---
log-error = ${DIR}/log/mysql/error.log
# Binary logging (optional)
log-bin = ${DIR}/log/mysql/mysql-bin
binlog_format = ROW
# --- InnoDB (system tables / metadata) ---
innodb_data_home_dir = ${DIR}/data/mysql
innodb_log_group_home_dir = ${DIR}/data/mysql
# --- DuckDB Storage Engine ---
duckdb_mode=ON
force_innodb_to_duckdb=ON
# DuckDB resources (0 = auto)
duckdb_memory_limit=2147483648
duckdb_threads=0
duckdb_temp_directory=${DIR}/tmp
EOF2
echo "OK: created $DIR and $DIR/alisql.cnf"
EOF
chmod +x init_alisql_dir.sh
References:
# Example: store all data under $HOME/alisql_8044
./init_alisql_dir.sh $HOME/alisql_8044
# Initialize
/opt/alisql/bin/mysqld --defaults-file=$HOME/alisql_8044/alisql.cnf --initialize-insecure
# Start, the port is 3306 by default
/opt/alisql/bin/mysqld_safe --defaults-file=$HOME/alisql_8044/alisql.cnf &
CREATE DATABASE test;
USE test;
-- Create DuckDB table
CREATE TABLE t (
id INT PRIMARY KEY,
name VARCHAR(255)
) ENGINE = DuckDB;
-- Convert
ALTER TABLE t ENGINE = InnoDB;
ALTER TABLE t ENGINE = DuckDB;
-- DML
INSERT INTO t VALUES (1, 'John');
SELECT * FROM t;
UPDATE t SET name = 'Jane' WHERE id = 1;
DELETE FROM t WHERE id = 1;
-- DDL
ALTER TABLE t ADD COLUMN age INT;
ALTER TABLE t RENAME TO t_new;
Use this when you want to migrate existing InnoDB tables to DuckDB to boost analytical performance.
Stop the existing instance (clean shutdown)
Update my.cnf
[mysqld]
duckdb_mode=ON
force_innodb_to_duckdb=ON
duckdb_memory_limit=2147483648
duckdb_threads=0
duckdb_temp_directory=/path/to/duckdb_temp_dir
duckdb_convert_all_at_startup=ON
duckdb_convert_all_at_startup_threads=32
duckdb_convert_all_at_startup_ignore_error=ON
Start the instance
Verify
-- Check the conversion stage
SHOW GLOBAL STATUS LIKE 'DuckDB_convert_stage_at_startup';
-- Check the converted tables
SELECT table_schema, table_name, engine
FROM information_schema.tables
WHERE engine = 'DuckDB';
A common pattern is OLTP on the primary and OLAP on a DuckDB replica, fed by row-based binlogs.
binlog_format=ROWmy.cnf[mysqld]
duckdb_mode=ON
duckdb_require_primary_key=ON
force_innodb_to_duckdb=ON
dml_in_batch=ON
update_modified_column_only=ON
duckdb_multi_trx_in_batch=ON
duckdb_multi_trx_timeout=5000
duckdb_multi_trx_max_batch_length=268435456
Initialize the replica Follow section 1 (new instance) or section 2 (optional startup conversion), depending on your scenario.
Set up replication
CHANGE MASTER TO
MASTER_HOST='your-master-ip',
MASTER_USER='repl',
MASTER_PASSWORD='your-password',
MASTER_AUTO_POSITION=1;
START SLAVE;