{"id":13440811,"url":"https://github.com/percona/PerconaFT","last_synced_at":"2025-03-20T10:32:44.252Z","repository":{"id":927337,"uuid":"9465623","full_name":"percona/PerconaFT","owner":"percona","description":"PerconaFT is a high-performance, transactional key-value store","archived":false,"fork":false,"pushed_at":"2024-03-29T21:02:03.000Z","size":25174,"stargazers_count":560,"open_issues_count":28,"forks_count":120,"subscribers_count":164,"default_branch":"master","last_synced_at":"2024-08-01T03:32:02.542Z","etag":null,"topics":["ps"],"latest_commit_sha":null,"homepage":"http://www.percona.com/","language":"C++","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/percona.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING.AGPLv3","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-16T06:14:08.000Z","updated_at":"2024-06-27T21:08:34.000Z","dependencies_parsed_at":"2023-01-11T15:48:32.442Z","dependency_job_id":null,"html_url":"https://github.com/percona/PerconaFT","commit_stats":null,"previous_names":[],"tags_count":284,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percona%2FPerconaFT","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percona%2FPerconaFT/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percona%2FPerconaFT/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percona%2FPerconaFT/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/percona","download_url":"https://codeload.github.com/percona/PerconaFT/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244595468,"owners_count":20478477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ps"],"created_at":"2024-07-31T03:01:26.506Z","updated_at":"2025-03-20T10:32:42.742Z","avatar_url":"https://github.com/percona.png","language":"C++","funding_links":[],"categories":["HarmonyOS","C++"],"sub_categories":["Windows Manager"],"readme":"PerconaFT\n======\n\nPerconaFT is a high-performance, transactional key-value store, used in the\nTokuDB storage engine for Percona Server and MySQL, and in TokuMX, the\nhigh-performance MongoDB distribution.\n\nPerconaFT is provided as a shared library with an interface similar to\nBerkeley DB.\n\nTo build the full MySQL product, see the instructions for\n[Percona/percona-server][percona-server].  This document covers PerconaFT only.\n\n[percona-server]: https://github.com/Percona/percona-server\n\n\nBuilding\n--------\n\nPerconaFT is built using CMake \u003e= 2.8.9.  Out-of-source builds are\nrecommended.  You need a C++11 compiler, though only some versions\nof GCC \u003e= 4.7 and Clang are tested.  You also need zlib development\npackages (`yum install zlib-devel` or `apt-get install zlib1g-dev`).\n\nYou will also need the source code for jemalloc, checked out in\n`third_party/`.\n\n```sh\ngit clone git://github.com/Percona/PerconaFT.git percona-ft\ncd percona-ft\ngit clone git://github.com/Percona/jemalloc.git third_party/jemalloc\nmkdir build\ncd build\nCC=gcc47 CXX=g++47 cmake \\\n    -D CMAKE_BUILD_TYPE=Debug \\\n    -D BUILD_TESTING=OFF \\\n    -D USE_VALGRIND=OFF \\\n    -D CMAKE_INSTALL_PREFIX=../prefix/ \\\n    ..\ncmake --build . --target install\n```\n\nThis will build `libft.so` and `libtokuportability.so` and install it,\nsome header files, and some examples to `percona-ft/prefix/`.  It will also\nbuild jemalloc and install it alongside these libraries, you should link\nto that if you are planning to run benchmarks or in production.\n\n### Platforms\n\nPerconaFT is supported on 64-bit Centos, Debian, and Ubuntu and should work\non other 64-bit linux distributions, and may work on OSX 10.8 and FreeBSD.\nPerconaFT is not supported on 32-bit systems.\n\n[Transparent hugepages][transparent-hugepages] is a feature in newer linux\nkernel versions that causes problems for the memory usage tracking\ncalculations in PerconaFT and can lead to memory overcommit.  If you have\nthis feature enabled, PerconaFT will not start, and you should turn it off.\nIf you want to run with transparent hugepages on, you can set an\nenvironment variable `TOKU_HUGE_PAGES_OK=1`, but only do this for testing,\nand only with a small cache size.\n\n[transparent-hugepages]: https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Performance_Tuning_Guide/s-memory-transhuge.html\n\n\nTesting\n-------\n\nPerconaFT uses CTest for testing.  The CDash testing dashboard is not\ncurrently public, but you can run the tests without submitting them.\n\nThere are some large data files not stored in the git repository, that\nwill be made available soon.  For now, the tests that use these files will\nnot run.\n\nIn the build directory from above:\n\n```sh\ncmake -D BUILD_TESTING=ON ..\nctest -D ExperimentalStart \\\n      -D ExperimentalConfigure \\\n      -D ExperimentalBuild \\\n      -D ExperimentalTest\n```\n\n\nContributing\n------------\n\nPlease report bugs in PerconaFT to the [issue tracker][jira].\n\nWe have two publicly accessible mailing lists for TokuDB:\n\n - tokudb-user@googlegroups.com is for general and support related\n   questions about the use of TokuDB.\n - tokudb-dev@googlegroups.com is for discussion of the development of\n   TokuDB.\n\nAll source code and test contributions must be provided under a [BSD 2-Clause][bsd-2] license. For any small change set, the license text may be contained within the commit comment and the pull request. For larger contributions, the license must be presented in a COPYING.\u003cfeature_name\u003e file in the root of the PerconaFT project. Please see the [BSD 2-Clause license template][bsd-2] for the content of the license text.\n\n[jira]: https://jira.percona.com/projects/TDB\n[bsd-2]: http://opensource.org/licenses/BSD-2-Clause/\n\n\nLicense\n-------\n\nPortions of the PerconaFT library (the 'locktree' and 'omt') are available under the Apache version 2 license.\nPerconaFT is available under the GPL version 2, and AGPL version 3.\nSee [COPYING.APACHEv2][apachelicense],\n[COPYING.AGPLv3][agpllicense],\n[COPYING.GPLv2][gpllicense], and\n[PATENTS][patents].\n\n[apachelicense]: http://github.com/Percona/PerconaFT/blob/master/COPYING.APACHEv2\n[agpllicense]: http://github.com/Percona/PerconaFT/blob/master/COPYING.AGPLv3\n[gpllicense]: http://github.com/Percona/PerconaFT/blob/master/COPYING.GPLv2\n[patents]: http://github.com/Percona/PerconaFT/blob/master/PATENTS\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercona%2FPerconaFT","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpercona%2FPerconaFT","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercona%2FPerconaFT/lists"}