Spider Storage Engine Overview
Contents
About
The Spider storage engine is a storage engine with built-in sharding features. It supports partitioning and xa transactions, and allows tables of different MariaDB instances to be handled as if they were on the same instance. It refers to one possible implementation of ISO/IEC 9075-9:2008 SQL/MED.
When a table is created with the Spider storage engine, the table links to the table on a remote server. The remote table can be of any storage engine. The table link is concretely achieved by the establishment of the connection from a local MariaDB server to a remote MariaDB server. The link is shared for all tables that are part of a the same transaction.
Spider Versions in MariaDB
Spider Version | Introduced | Maturity |
---|---|---|
Spider 3.3.15 | MariaDB 10.5.7, MariaDB 10.4.6 | Stable |
Spider 3.3.15 | MariaDB 10.5.4 | Gamma |
Spider 3.3.14 | MariaDB 10.4.3, MariaDB 10.3.13 | Stable |
Spider 3.3.13 | MariaDB 10.3.7 | Stable |
Spider 3.3.13 | MariaDB 10.3.3 | Gamma |
Spider 3.2.37 | MariaDB 10.1.10, MariaDB 10.0.23 | Gamma |
Spider 3.2.21 | MariaDB 10.1.5, MariaDB 10.0.18 | Gamma |
Spider 3.2.18 | MariaDB 10.0.17 | Gamma |
Spider 3.2.11 | MariaDB 10.0.14 | Gamma |
Spider 3.2.4 | MariaDB 10.0.12 | Gamma |
Spider 3.2 | MariaDB 10.0.11 | Gamma |
Spider 3.0 | MariaDB 10.0.4 | Beta |
Some Server Variables to Set When Using Spider
MariaDB starting with 10.3.4
If you are using Spider with replication, you can expand the list of transaction errors to be retried by setting slave_transaction_retry_errors to the following to avoid network problems:
- 1158: Got an error reading communication packets
- 1159: Got timeout reading communication packets
- 1160: Got an error writing communication packets
- 1161: Got timeout writing communication packets
- 1429: Unable to connect to foreign data source
- 2013: Lost connection to MySQL server during query
- 12701: Remote MySQL server has gone away
Do this as follows in your my.cnf file:
slave_transaction_retry_errors="1158,1159,1160,1161,1429,2013,12701"
From MariaDB 10.4.5, the above is included the default.
Usage
Basic Usage
To create a table in the Spider storage engine format, the COMMENT and/or CONNECTION clauses of the CREATE TABLE statement are used to pass connection information about the remote server.
For example, the following table exists on a remote server (in this example, the remote node was created with the MySQL Sandbox tool, an easy way to test with multiple installations)::
node1 >CREATE TABLE s( id INT NOT NULL AUTO_INCREMENT, code VARCHAR(10), PRIMARY KEY(id));
On the local server, a Spider table can be created as follows:
CREATE TABLE s( id INT NOT NULL AUTO_INCREMENT, code VARCHAR(10), PRIMARY KEY(id) ) ENGINE=SPIDER COMMENT='host "127.0.0.1", user "msandbox", password "msandbox", port "8607"';
Records can now be inserted on the local server, and they will be stored on the remote server:
INSERT INTO s(code) VALUES ('a'); node1 > SELECT * FROM s; +----+------+ | id | code | +----+------+ | 1 | a | +----+------+
MariaDB starting with 10.8.1
Alternative to specifying the data node information in the COMMENT, certain information (server, database, table) can also be specified using Table Options, like so:
CREATE SERVER srv FOREIGN DATA WRAPPER mysql OPTIONS( HOST '127.0.0.1', USER 'msandbox', PASSWORD 'msandbox', PORT 8607); CREATE TABLE s( id INT NOT NULL AUTO_INCREMENT, code VARCHAR(10), PRIMARY KEY(id) ) ENGINE=SPIDER REMOTE_SERVER="srv" REMOTE_DATABASE="db" REMOTE_TABLE="s";
Further Examples
Preparing 10M record table using the sysbench utility
/usr/local/skysql/sysbench/bin/sysbench --test=oltp --db-driver=mysql --mysql-table-engine=innodb --mysql-user=skysql --mysql-password=skyvodka --mysql-host=192.168.0.202 --mysql-port=5054 --oltp-table-size=10000000 --mysql-db=test prepare
Make a first read only benchmark to check the initial single node performance.
/usr/local/skysql/sysbench/bin/sysbench --test=oltp --db-driver=mysql --mysql-table-engine=innodb --mysql-user=skysql --mysql-password=skyvodka --mysql-host=192.168.0.202 --mysql-port=5054 --mysql-db=test --oltp-table-size=10000000 --num-threads=4 --max-requests=100000 --oltp-read-only=on run
sysbench 0.4.12: multi-threaded system evaluation benchmark Running the test with following options: Number of threads: 4 Doing OLTP test. Running mixed OLTP test Doing read-only test Using Special distribution (12 iterations, 1 pct of values are returned in 75 pct cases) Using "BEGIN" for starting transactions Using auto_inc on the id column Maximum number of requests for OLTP test is limited to 100000 Threads started! Done. OLTP test statistics: queries performed: read: 1400196 write: 0 other: 200028 total: 1600224 transactions: 100014 (1095.83 per sec.) deadlocks: 0 (0.00 per sec.) read/write requests: 1400196 (15341.58 per sec.) other operations: 200028 (2191.65 per sec.) Test execution summary: total time: 91.2681s total number of events: 100014 total time taken by event execution: 364.3693 per-request statistics: min: 1.85ms avg: 3.64ms max: 30.70ms approx. 95 percentile: 4.66ms Threads fairness: events (avg/stddev): 25003.5000/84.78 execution time (avg/stddev): 91.0923/0.00
Define an easy way to access the nodes from the MariaDB or MySQL client.
alias backend1='/usr/local/skysql/mysql-client/bin/mysql --user=skysql --password=skyvodka --host=192.168.0.202 --port=5054' alias backend2='/usr/local/skysql/mysql-client/bin/mysql --user=skysql --password=skyvodka --host=192.168.0.203 --port=5054' alias spider1='/usr/local/skysql/mysql-client/bin/mysql --user=skysql --password=skyvodka --host=192.168.0.201 --port=5054'
Create the empty tables to hold the data and repeat for all available backend nodes.
backend1 << EOF CREATE DATABASE backend; CREATE TABLE backend.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; EOF backend2 << EOF CREATE DATABASE backend; CREATE TABLE backend.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; EOF
Federation Setup
spider1 << EOF CREATE SERVER backend FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.202', DATABASE 'test', USER 'skysql', PASSWORD 'skyvodka', PORT 5054 ); CREATE TABLE test.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=spider COMMENT='wrapper "mysql",srv "backend"'; SELECT * FROM test.sbtest LIMIT 10; EOF
Without connection pool or MariaDB thread pool, HaProxy and Spider have been protecting the tcp socket overflow without specific TCP tuning. In reality with a well tuned TCP stack or thread pool the curve should not decrease so abruptly to 0. Refer to the MariaDB Thread Pool to explore this feature.
Sharding Setup
Create the spider table on the Spider Node
#spider1 << EOF CREATE SERVER backend1 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.202', DATABASE 'backend', USER 'skysql', PASSWORD 'skyvodka', PORT 5054 ); CREATE SERVER backend2 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.203', DATABASE 'backend', USER 'skysql', PASSWORD 'skyvodka', PORT 5054 ); CREATE DATABASE IF NOT EXISTS backend; CREATE TABLE backend.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=spider COMMENT='wrapper "mysql", table "sbtest"' PARTITION BY KEY (id) ( PARTITION pt1 COMMENT = 'srv "backend1"', PARTITION pt2 COMMENT = 'srv "backend2"' ) ; EOF
Copy the data from the original sysbench table to the spider table
#/usr/local/skysql/mariadb/bin/mysqldump --user=skysql --password=skyvodka --host=192.168.0.202 --port=5054 --no-create-info test sbtest | spider1 backend #backend2 -e"select count(*) from backend.sbtest;" +----------+ | count(*) | +----------+ | 3793316 | +----------+ #backend1 -e"select count(*) from backend.sbtest;" +----------+ | count(*) | +----------+ | 6206684 | +----------+
We observe a common issue with partitioning is a non uniform distribution of data between the backends. based on the partition key hashing algorithm.
Rerun the Benchmark with less queries
#/usr/local/skysql/sysbench/bin/sysbench --test=oltp --db-driver=mysql --mysql-table-engine=innodb --mysql-user=skysql --mysql-password=skyvodka --mysql-host=192.168.0.201 --mysql-port=5054 --mysql-db=backend --mysql-engine-trx=yes --oltp-table-size=10000000 --num-threads=4 --max-requests=100 --oltp-read-only=on run
OLTP test statistics: queries performed: read: 1414 write: 0 other: 202 total: 1616 transactions: 101 (22.95 per sec.) deadlocks: 0 (0.00 per sec.) read/write requests: 1414 (321.30 per sec.) other operations: 202 (45.90 per sec.) Test execution summary: total time: 4.4009s total number of events: 101 total time taken by event execution: 17.2960 per-request statistics: min: 114.48ms avg: 171.25ms max: 200.98ms approx. 95 percentile: 195.12ms Threads fairness: events (avg/stddev): 25.2500/0.43 execution time (avg/stddev): 4.3240/0.04
The response time decreases to 0.04. This is expected because the query latency is increased from multiple network round trips and condition push down is not implemented yet. Sysbench doing a lot of range queries. Just consider for now that this range query can be a badly optimized query.
We need to increase the concurrency to get better throughput.
Background Setup
We have no background search available in MariaDB. It won't be available before MariaDB 10.2, but the next table definition mainly enables improving the performance of a single complex query plan with background search that can be found via the upstream spiral binaries MariaDB branch.
We have 4 cores per backend and 2 backends .
On backend1
#backend1 << EOF CREATE DATABASE bsbackend1; CREATE DATABASE bsbackend2; CREATE DATABASE bsbackend3; CREATE DATABASE bsbackend4; CREATE TABLE bsbackend1.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; CREATE TABLE bsbackend2.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; CREATE TABLE bsbackend3.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; CREATE TABLE bsbackend4.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; EOF
On backend2
#backend2 << EOF CREATE DATABASE bsbackend5; CREATE DATABASE bsbackend6; CREATE DATABASE bsbackend7; CREATE DATABASE bsbackend8; CREATE TABLE bsbackend5.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; CREATE TABLE bsbackend6.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; CREATE TABLE bsbackend7.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; CREATE TABLE bsbackend8.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=InnoDB; EOF
On Spider Node
#spider2 << EOF CREATE SERVER bsbackend1 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.202', DATABASE 'bsbackend1',USER 'skysql', PASSWORD 'skyvodka',PORT 5054); CREATE SERVER bsbackend2 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.202', DATABASE 'bsbackend2',USER 'skysql', PASSWORD 'skyvodka',PORT 5054); CREATE SERVER bsbackend3 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.202', DATABASE 'bsbackend3',USER 'skysql', PASSWORD 'skyvodka',PORT 5054); CREATE SERVER bsbackend4 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.202', DATABASE 'bsbackend4',USER 'skysql', PASSWORD 'skyvodka',PORT 5054); CREATE SERVER bsbackend5 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.203', DATABASE 'bsbackend5',USER 'skysql', PASSWORD 'skyvodka',PORT 5054); CREATE SERVER bsbackend6 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.203', DATABASE 'bsbackend6',USER 'skysql', PASSWORD 'skyvodka',PORT 5054); CREATE SERVER bsbackend7 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.203', DATABASE 'bsbackend7',USER 'skysql', PASSWORD 'skyvodka',PORT 5054); CREATE SERVER bsbackend8 FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.203', DATABASE 'bsbackend8',USER 'skysql', PASSWORD 'skyvodka',PORT 5054); CREATE DATABASE IF NOT EXISTS bsbackend; CREATE TABLE bsbackend.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=spider COMMENT='wrapper "mysql", table "sbtest"' PARTITION BY KEY (id) ( PARTITION pt1 COMMENT = 'srv "bsbackend1"', PARTITION pt2 COMMENT = 'srv "bsbackend2"', PARTITION pt3 COMMENT = 'srv "bsbackend3"', PARTITION pt4 COMMENT = 'srv "bsbackend4"', PARTITION pt5 COMMENT = 'srv "bsbackend5"', PARTITION pt6 COMMENT = 'srv "bsbackend6"', PARTITION pt7 COMMENT = 'srv "bsbackend7"', PARTITION pt8 COMMENT = 'srv "bsbackend8"' ) ; EOF INSERT INTO bsbackend.sbtest SELECT * FROM backend.sbtest;
Now test the following query :
select count(*) from sbtest; +----------+ | count(*) | +----------+ | 10000001 | +----------+ 1 row in set (8,38 sec) set spider_casual_read=1; set spider_bgs_mode=2; select count(*) from sbtest; +----------+ | count(*) | +----------+ | 10000001 | +----------+ 1 row in set (4,25 sec) mysql> select sum(k) from sbtest; +--------+ | sum(k) | +--------+ | 0 | +--------+ 1 row in set (5,67 sec) mysql> set spider_casual_read=0; mysql> select sum(k) from sbtest; +--------+ | sum(k) | +--------+ | 0 | +--------+ 1 row in set (12,56 sec)
High Availability Setup
MariaDB starting with 10.7.5
Spider's high availability feature has been deprecated (MDEV-28479), and will be deleted. Please use other high availability solutions like replication or galera-cluster.
#backend1 -e "CREATE DATABASE backend_rpl" #backend2 -e "CREATE DATABASE backend_rpl" #/usr/local/skysql/mariadb/bin/mysqldump --user=skysql --password=skyvodka --host=192.168.0.202 --port=5054 backend sbtest | backend1 backend_rpl #/usr/local/skysql/mariadb/bin/mysqldump --user=skysql --password=skyvodka --host=192.168.0.203 --port=5054 backend sbtest | backend2 backend_rpl #spider1 << EOF DROP TABLE backend.sbtest; CREATE SERVER backend1_rpl FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.202', DATABASE 'backend_rpl', USER 'skysql', PASSWORD 'skyvodka', PORT 5054 ); CREATE SERVER backend2_rpl FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.203', DATABASE 'backend_rpl', USER 'skysql', PASSWORD 'skyvodka', PORT 5054 ); CREATE TABLE backend.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=spider COMMENT='wrapper "mysql", table "sbtest"' PARTITION BY KEY (id) ( PARTITION pt1 COMMENT = 'srv "backend1 backend2_rpl"', PARTITION pt2 COMMENT = 'srv "backend2 backend1_rpl"' ) ; INSERT INTO backend.sbtest select 10000001, 0, '' ,'replicas test'; EOF #backend1 -e "SELECT * FROM backend.sbtest WHERE id=10000001"; +----------+---+---+---------------+ | id | k | c | pad | +----------+---+---+---------------+ | 10000001 | 0 | | replicas test | +----------+---+---+---------------+ # backend2 -e "SELECT * FROM backend.sbtest where id=10000001"; # backend2 -e "SELECT * FROM backend_rpl.sbtest where id=10000001"; +----------+---+---+---------------+ | id | k | c | pad | +----------+---+---+---------------+ | 10000001 | 0 | | replicas test | +----------+---+---+---------------+
What is happening if we stop one backend?
#spider1 -e "SELECT * FROM backend.sbtest where id=10000001"; ERROR 1429 (HY000) at line 1: Unable to connect to foreign data source: backend1
Let's fix this with spider monitoring. Note that msi is the list of spider nodes @@server_id variable participating in the quorum.
#spider1 << EOF DROP TABLE backend.sbtest; CREATE TABLE backend.sbtest ( id int(10) unsigned NOT NULL AUTO_INCREMENT, k int(10) unsigned NOT NULL DEFAULT '0', c char(120) NOT NULL DEFAULT '', pad char(60) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY k (k) ) ENGINE=spider COMMENT='wrapper "mysql", table "sbtest"' PARTITION BY KEY (id) ( PARTITION pt1 COMMENT = 'srv "backend1 backend2_rpl", mbk "2", mkd "2", msi "5054", link_status "0 0"', PARTITION pt2 COMMENT = 'srv "backend2 backend1_rpl", mbk "2", mkd "2", msi "5054", link_status "0 0" ' ) ; CREATE SERVER mon FOREIGN DATA WRAPPER mysql OPTIONS( HOST '192.168.0.201’, DATABASE 'backend', USER 'skysql', PASSWORD 'skyvodka', PORT 5054 ); INSERT INTO `mysql`.`spider_link_mon_servers` VALUES ('%','%','%',5054,'mon',NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,0,NULL,NULL); SELECT spider_flush_table_mon_cache(); EOF
Monitoring should be setup between Spider nodes participating in the cluster. We only have one Spider Node
and spider_link_mon_servers represent the inter-connection of all Spider nodes in our setup.
This simple setup does not bring HA in case the Spider Node
is not available. In a production setup the number of Spider Nodes
in the spider_link_mon_servers table should be at least 3 to get a majority consensus.
#spider1 -e "SELECT * FROM backend.sbtest WHERE id=10000001" +----------+---+---+---------------+ | id | k | c | pad | +----------+---+---+---------------+ | 10000001 | 0 | | replicas test | +----------+---+---+---------------+
Checking the state of the nodes:
#spider1 -e "SELECT db_name, table_name,server FROM mysql.spider_tables WHERE link_status=3" +---------+--------------+----------+ | db_name | table_name | server | +---------+--------------+----------+ | backend | sbtest#P#pt1 | backend1 | +---------+--------------+----------+
No change has been made to cluster, so let's create a divergence:
# spider1 -e "INSERT INTO backend.sbtest select 10000003, 0, '' ,'replicas test';" # backend1 -e "SELECT * FROM backend.sbtest WHERE id=10000003" # backend2 -e "SELECT * FROM backend_rpl.sbtest WHERE id=10000003" +----------+---+---+---------------+ | id | k | c | pad | +----------+---+---+---------------+ | 10000003 | 0 | | replicas test | +----------+---+---+---------------+
Reintroducing the failed backend1 in the cluster:
#spider1 << EOF ALTER TABLE backend.sbtest ENGINE=spider COMMENT='wrapper "mysql", table "sbtest"' PARTITION BY KEY (id) ( PARTITION pt1 COMMENT = 'srv "backend1 backend2_rpl" mbk "2", mkd "2", msi "5054", link_status "2 0"', PARTITION pt2 COMMENT = 'srv "backend2 backend1_rpl" mbk "2", mkd "2", msi "5054", link_status "0 2" ' ) ; select spider_copy_tables('backend.sbtest#P#pt1','0','1'); select spider_copy_tables('backend.sbtest#P#pt2','1','0'); ALTER TABLE backend.sbtest ENGINE=spider COMMENT='wrapper "mysql", table "sbtest"' PARTITION BY KEY (id) ( PARTITION pt1 COMMENT = 'srv "backend1 backend2_rpl" mbk "2", mkd "2", msi "5054", link_status "1 0"', PARTITION pt2 COMMENT = 'srv "backend2 backend1_rpl" mbk "2", mkd "2", msi "5054", link_status "0 1" ' ) ; EOF