{"id":29905518,"url":"https://github.com/project-tsurugi/sharksfin","last_synced_at":"2025-08-01T19:14:22.318Z","repository":{"id":198152681,"uuid":"160290075","full_name":"project-tsurugi/sharksfin","owner":"project-tsurugi","description":"Transactional key-value store API","archived":false,"fork":false,"pushed_at":"2025-07-16T06:20:58.000Z","size":892,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-07-17T09:07:14.956Z","etag":null,"topics":["api","kvs","transaction","tsurugidb"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/project-tsurugi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-12-04T03:20:31.000Z","updated_at":"2025-05-26T02:20:48.000Z","dependencies_parsed_at":"2023-10-12T09:29:12.216Z","dependency_job_id":"da3ce760-bcd4-4d6f-8908-b4fe0ac4e9ea","html_url":"https://github.com/project-tsurugi/sharksfin","commit_stats":null,"previous_names":["project-tsurugi/sharksfin"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/project-tsurugi/sharksfin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-tsurugi%2Fsharksfin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-tsurugi%2Fsharksfin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-tsurugi%2Fsharksfin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-tsurugi%2Fsharksfin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/project-tsurugi","download_url":"https://codeload.github.com/project-tsurugi/sharksfin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-tsurugi%2Fsharksfin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268282397,"owners_count":24225164,"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","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","kvs","transaction","tsurugidb"],"created_at":"2025-08-01T19:14:11.246Z","updated_at":"2025-08-01T19:14:22.239Z","avatar_url":"https://github.com/project-tsurugi.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# transactional key-value store API\n\n## Requirements\n\n* CMake `\u003e= 3.16`\n* C++ Compiler `\u003e= C++17`\n* and see *Dockerfile* section\n\n```sh\n# retrieve third party modules\ngit submodule update --init --recursive\n```\n\n### Dockerfile\n\n```dockerfile\nFROM ubuntu:22.04\n\nRUN apt update -y \u0026\u0026 apt install -y git build-essential cmake ninja-build libboost-filesystem-dev doxygen libnuma-dev\n```\n\n### Install modules\n\n#### tsurugidb modules\n\nThis requires below [tsurugidb](https://github.com/project-tsurugi/tsurugidb) modules to be installed.\n\n* [shirakami](https://github.com/project-tsurugi/shirakami) if you want to run this API with it.\n\n\n## How to build\n\n```sh\nmkdir build\ncd build\ncmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..\ncmake --build .\n```\n\navailable options:\n* `-DBUILD_TESTS=ON` - build test programs\n* `-DBUILD_MEMORY=ON` - build API in-memory implementation\n* `-DBUILD_SHIRAKAMI=OFF` - never build shirakami bridge\n* `-DBUILD_EXAMPLES=ON` - build example programs\n* `-DBUILD_DOCUMENTS=ON` - build documents by doxygen\n* `-DBUILD_STRICT=OFF` - don't treat compile warnings as build errors\n* `-DINSTALL_EXAMPLES=ON` - also install example programs (requires `BUILD_EXAMPLES` is enables)\n* `-DEXAMPLE_IMPLEMENTATION=...` - link the specified target-name implementation to example programs\n  * `memory` - link to in-memory implementation\n  * `shirakami` - link to shirakami implementation (default)\n* `-DCMAKE_PREFIX_PATH=\u003cinstallation directory\u003e` - indicate dependant installation directory\n* for debugging only\n  * `-DENABLE_SANITIZER=OFF` - disable sanitizers (requires `-DCMAKE_BUILD_TYPE=Debug`)\n  * `-DENABLE_UB_SANITIZER=ON` - enable undefined behavior sanitizer (requires `-DENABLE_SANITIZER=ON`)\n  * `-DENABLE_COVERAGE=ON` - enable code coverage analysis (requires `-DCMAKE_BUILD_TYPE=Debug`)\n  * `-DBUILD_SHARED_LIBS=OFF` - create static libraries instead of shared libraries\n\n### install\n\n```sh\ncmake --build . --target install\n```\n\n### run tests\n\n```sh\nctest -V\n```\n\n### generate documents\n\n```sh\ncmake --build . --target doxygen\n```\n\n### Customize logging setting\nSharksfin internally uses [glog](https://github.com/google/glog) so you can pass glog environment variables such as `GLOG_logtostderr=1` to customize the logging output of executable that uses sharksfin.\n\n```sh\nGLOG_logtostderr=1 ./sharksfin-cli -Dlocation=./db1 put 0 A\n```\n\n`GLOG_minloglevel` can be used to set the log level (0=INFO, 1=WARN, 2=ERROR, 3=FATAL). Default log level is WARN.\n\n```sh\nGLOG_minloglevel=0 ./sharksfin-cli -Dlocation=./db1 put 0 A\n```\n\n## License\n\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-tsurugi%2Fsharksfin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fproject-tsurugi%2Fsharksfin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-tsurugi%2Fsharksfin/lists"}