SequoiaSQL-MySQL Storage Engine

SequoiaSQL-MySQL Storage Engine is a distributed MySQL storage engine.

It currently supports SequoiaDB 3.x as the backend database, and it will be extended to multiple databases such like MongoDB/Redis and etc...

In order to take advantages of scalability and performance, SequoiaSQL-MySQL Storage Engine can be used to replace InnoDB and store user data/index/lob in the backend distributed database.

Building.

1. Get the source code of SequoiaSQL-MySQL from github.

git clone https://github.com/SequoiaDB/sequoiasql-mysql.git sequoiasql-mysql

2. Get the SequoiaDB C++ driver.
3. Compile.

cd sequoiasql-mysql
python3 build.py --sdbdriver </path/to/sequoiadb/cpp/driver> --commitsha <commit SHA> --mysqlsrcpkgdir </path/to/mysql/original/src/archive/package> -t mysql --buildir=<builddir_name> --connector=<connector_branch_name> -i  </path/to/install/mysql/>  --archivetest --dd -j 64

# eg:
# build master branch
python3 build.py --sdbdriver /data/temp/sequoiadb/client --commitsha 7f1105cbb78e415e5d59caf536aed50c4d6b0b67 --mysqlsrcpkgdir /data/temp/ -t mysql --builddir=mysql_debug_build -i  /data/temp/mysql --archivetest --dd -j 64

# build v3.4 branch
python3 build.py --sdbdriver /data/temp/sequoiadb/client --commitsha 7f1105cbb78e415e5d59caf536aed50c4d6b0b67 --mysqlsrcpkgdir /data/temp/ -t mysql --builddir=mysql_v34_debug_build --connector="3.4" -i  /data/temp/mysql --archivetest --dd -j 64

# build v3.6 branch
python3 build.py --sdbdriver /data/temp/sequoiadb/client --commitsha 7f1105cbb78e415e5d59caf536aed50c4d6b0b67 --mysqlsrcpkgdir /data/temp/ -t mysql --builddir=mysql_v36_debug_build --connector="3.6" -i  /data/temp/mysql --archivetest --dd -j 64

Testing the SequoiaSQL-MySQL server.

Prerequisites:

• SequoiaSQL-MySQL server can acess a SequoiaDB Cluster.
• transisolation: The transaction isolation of SequoiaDB should be RC.

SequoiaSQL-MySQL using the MySQL testing framework defined in mysql-test folder. To run all tests:

cd mysql-test
./mtr --suite=main,json --big-test --force --max-test-fail=0 --parallel=4

To run only one test:

cd mysql-test
./mtr --suite=<main_or_json> <test_case_name>

Coding Guidelines

According to MySQL coding guidelines, we use the Google C++ coding style.

We use clang-format to format source code by 'Google' style with some exceptions. The '.clang-format' file contains all the options we used.

The .clang-format file is dumped from the tool by following command:

clang-format -style=google -dump-config > .clang-format

And we changed following options:

SortIncludes: false
AllowShortFunctionsOnASingleLine: Inline
AllowShortIfStatementsOnASingleLine: false
AllowShortLoopsOnASingleLine: false

You can directly use clang-format command line or the plugin in VSCode if you use VSCode. Remember to use the .clang-format file as style.

License

License under the GPL License, Version 2.0. See LICENSE for more information. Copyright (c) 2018, SequoiaDB and/or its affiliates. All rights reserved.