mariadb/README.md

68 lines
2 KiB
Markdown
Raw Normal View History

2013-04-18 20:16:47 +02:00
TokuDB
======
TokuDB is a high-performance, transactional storage engine for MySQL and
MariaDB. For more details, see our [product page][products].
2013-04-18 20:26:06 +02:00
This repository contains the MySQL plugin that uses the [TokuKV][tokukv]
core.
2013-04-18 20:16:47 +02:00
There are also patches to the MySQL and MariaDB kernels, available in our
forks of [mysql][mysql] and [mariadb][mariadb].
[products]: http://www.tokutek.com/products/tokudb-for-mysql/
[tokukv]: http://github.com/Tokutek/ft-index
[mysql]: http://github.com/Tokutek/mysql
[mariadb]: http://github.com/Tokutek/mariadb
Building
--------
The `scripts/` directory contains a script that can be used to build a
working MySQL or MariaDB with Tokutek patches, and with the TokuDB storage
engine, called `make.mysql.bash`. This script will download copies of the
needed source code from github and build everything.
To build MySQL with TokuDB 7.0.0:
```sh
scripts/make.mysql.bash --git_tag=tokudb-7.0.0
```
To build MariaDB with TokuDB 7.0.0:
```sh
scripts/make.mysql.bash --git_tag=tokudb-7.0.0 --mysql=mariadb-5.5.30
```
2013-04-18 22:09:05 +02:00
Before you start, make sure you have a C++11-compatible compiler (GCC
>= 4.7 is recommended) and the libraries and header files for valgrind,
zlib, and Berkeley DB. On Centos, `yum install valgrind-devel zlib-devel
libdb-devel`, on Ubuntu, `apt-get install valgrind zlib1g-dev libdb-dev`.
2013-04-18 20:16:47 +02:00
Contributing
------------
2013-04-18 20:25:16 +02:00
Please report bugs in TokuDB here on github.
2013-04-18 20:16:47 +02:00
We have two publicly accessible mailing lists:
- tokudb-user@googlegroups.com is for general and support related
2013-04-18 20:40:06 +02:00
questions about the use of TokuDB.
2013-04-18 20:16:47 +02:00
- tokudb-dev@googlegroups.com is for discussion of the development of
2013-04-18 20:40:06 +02:00
TokuDB.
2013-04-18 20:16:47 +02:00
We are also available on IRC on freenode.org, in the #tokutek channel.
License
-------
2013-04-18 21:42:28 +02:00
TokuDB is available under the GPL version 2. See [COPYING][copying]
2013-04-18 20:16:47 +02:00
2013-04-18 21:42:28 +02:00
The TokuKV component of TokuDB is available under the GPL version 2, with
slight modifications. See [README-TOKUDB][license].
[copying]: http://github.com/Tokutek/ft-engine/blob/master/COPYING
2013-04-18 20:16:47 +02:00
[license]: http://github.com/Tokutek/ft-index/blob/master/README-TOKUDB