Tsurugi - next generation RDB for the new era

Tsurugi is an open-source relational database system designed for modern computer architectures that have hundreds of CPU cores and huge memory capacity. It focuses on the following features:

1. Designed for a Many-Core/In-Memory Environment
2. Ensuring Consistency
3. Simultaneous Use of Multiple Interfaces
4. Component-Based Architecture
5. Excellence in Batch Processing and Long Transactions
6. Developed as Open Source

• More: about.md
• More: Detailed Information is offered in the Handbook (only in Japanese)
  • https://nkbp.jp/lin-tsurugi

Getting started

• Installation
  • Tsurugi Getting Started (日本語版)
• Use official Docker Image
  • Tsurugi Docker User Guide (日本語版)

Client Libraries

• Java - Tsurugi-specific API
  • Iceaxe - High-Level Java API
  • Tsubakuro - Low-Level Java API
• Java - JDBC Driver
  • Tsurugi JDBC - JDBC Driver
• Java - ORM Integration
  • Tsurugi Hibernate - Hibernate ORM Dialect
• Rust
  • tsubakuro-rust-core - Rust API (crates.io)
• C
  • tsubakuro-rust-ffi - C API (Rust FFI bindings to C)
• ODBC Driver
  • Tsurugi ODBC Driver - ODBC Driver (Installer)
• Python
  • Tsurugi Python DB-API - Python DB API 2.0 Driver (PyPI)

Tools and Integrations

• Basic CLI
  • tgctl - Database management tool for Tsurugi
  • tgsql - SQL console for Tsurugi
  • tgdump - Database dump tool for Tsurugi
• UDF
  • Tsurugi UDF - Extension Toolkit that allows user programs created as gRPC services to be called as SQL functions
• Web Admin API
  • Belayer Web-API - Web Administration API for Tsurugi
• PostgreSQL Integration
  • tsurugi-fdw - PostgreSQL Foreign Data Wrapper for Tsurugi
• MCP
  • Tsurugi MCP Server - MCP Server for Tsurugi

Documentation

• Runtime Environments
  • Supported Platforms
• Supported SQL
  • Available SQL features in Tsurugi
• Configuration
  • Configuration file parameters
• Authentication and Authorization
  • Tsurugi User Authentication and Table Permissions (ja)
• Additional Resources
  • docs directory contains more documents.
  • GitHub Discussions provides release information and additional guidance documents for release features.
  • Sub projects have their own docs directories with detailed information for each component.

Sub projects

Transaction engine

• shirakami Concurrency control system

• yakushima In-memory index

• limestone Data store for transaction logs

• sharksfin KVS adapter for transaction engine

SQL execution engine

• jogasaki SQL job scheduler and interpreter

• mizugaki SQL compiler front-end including SQL parser

• yugawara SQL semantic analyzer and optimizer

• takatori SQL intermediate representations and utilities

Database framework

• tateyama Database component framework including messaging service

• tateyama-bootstrap Database service bootstrap

Database clients

• tsubakuro Client library (Java)

• tanzawa SQL console (Java)

Peripherals

• harinoki Tiny authentication service

Resources

• Tsurugi Community Site (ja)
• note (ja)

Contributing

• Please report any issues to repository for issue tracking

• For any other questions or feedback, please post to tsurugidb discussions forum

• This repository is a collection of submodules of each Sub projects. Therefore, please send Pull Request to the repository of Sub projects, not to this repository.

License

• Apache License, Version 2.0