Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
M
MariaDB
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
nexedi
MariaDB
Commits
6b1a322b
Commit
6b1a322b
authored
Jul 05, 2014
by
Leif Walsh
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
updated branding to tokuft
parent
adefb021
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
15 deletions
+15
-15
README.md
README.md
+15
-15
No files found.
README.md
View file @
6b1a322b
Toku
KV
Toku
FT
======
Toku
KV
is a high-performance, transactional key-value store, used in the
Toku
FT
is a high-performance, transactional key-value store, used in the
TokuDB storage engine for MySQL and MariaDB and in TokuMX, the
high-performance MongoDB distribution.
Toku
KV
is provided as a shared library with an interface similar to
Toku
FT
is provided as a shared library with an interface similar to
Berkeley DB.
To build the full MySQL product, see the instructions for
[
Tokutek/ft-engine
][
ft-engine
]
. To build TokuMX, see the instructions
for
[
Tokutek/mongo
][
mongo
]
. This document covers Toku
KV
only.
for
[
Tokutek/mongo
][
mongo
]
. This document covers Toku
FT
only.
[
ft-engine
]:
https://github.com/Tokutek/ft-engine
[
mongo
]:
https://github.com/Tokutek/mongo
...
...
@@ -19,7 +19,7 @@ for [Tokutek/mongo][mongo]. This document covers TokuKV only.
Building
--------
Toku
KV
is built using CMake >= 2.8.9. Out-of-source builds are
Toku
FT
is built using CMake >= 2.8.9. Out-of-source builds are
recommended. You need a C++11 compiler, though only GCC >= 4.7 and
Apple's Clang are tested. You also need zlib development packages
(
`yum install zlib-devel`
or
`apt-get install zlib1g-dev`
).
...
...
@@ -50,14 +50,14 @@ to that if you are planning to run benchmarks or in production.
### Platforms
Toku
KV
is supported on 64-bit Centos, should work on other 64-bit linux
distributions, and may work on OSX 10.8 and FreeBSD. Toku
KV
is not
Toku
FT
is supported on 64-bit Centos, should work on other 64-bit linux
distributions, and may work on OSX 10.8 and FreeBSD. Toku
FT
is not
supported on 32-bit systems.
[
Transparent hugepages
][
transparent-hugepages
]
is a feature in newer linux
kernel versions that causes problems for the memory usage tracking
calculations in Toku
KV
and can lead to memory overcommit. If you have
this feature enabled, Toku
KV
will not start, and you should turn it off.
calculations in Toku
FT
and can lead to memory overcommit. If you have
this feature enabled, Toku
FT
will not start, and you should turn it off.
If you want to run with transparent hugepages on, you can set an
environment variable
`TOKU_HUGE_PAGES_OK=1`
, but only do this for testing,
and only with a small cache size.
...
...
@@ -68,23 +68,23 @@ and only with a small cache size.
Examples
--------
There are some sample programs that can use either Toku
KV
or Berkeley DB
There are some sample programs that can use either Toku
FT
or Berkeley DB
in the
`examples/`
directory. Follow the above instructions to build and
install Toku
KV
, and then look in the installed
`examples/`
directory for
install Toku
FT
, and then look in the installed
`examples/`
directory for
instructions on building and running them.
Testing
-------
Toku
KV
uses CTest for testing. The CDash testing dashboard is not
Toku
FT
uses CTest for testing. The CDash testing dashboard is not
currently public, but you can run the tests without submitting them.
There are some large data files not stored in the git repository, that
will be made available soon. For now, the tests that use these files will
not run.
Many of the tests are linked with both Toku
KV
and Berkeley DB, as a sanity
Many of the tests are linked with both Toku
FT
and Berkeley DB, as a sanity
check on the tests themselves. To build these tests, you will need
Berkeley DB and its header files installed. If you do not have Berkeley
DB installed, just don't pass
`USE_BDB=ON`
.
...
...
@@ -103,7 +103,7 @@ ctest -D ExperimentalStart \
Contributing
------------
Please report bugs in Toku
KV
here on github.
Please report bugs in Toku
FT
here on github.
We have two publicly accessible mailing lists for TokuDB:
...
...
@@ -125,7 +125,7 @@ We are also available on IRC on freenode.net, in the #tokutek channel.
License
-------
Toku
KV
is available under the GPL version 2, with slight modifications.
Toku
FT
is available under the GPL version 2, with slight modifications.
See
[
README-TOKUDB
][
license
]
.
[
license
]:
http://github.com/Tokutek/ft-index/blob/master/README-TOKUDB
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment