Tsurugi 1.6.0 - Release Notes (en)

[akirakw]

Tsurugi 1.6.0 Release Notes

Overview

Tsurugi 1.6.0 introduces user authentication and table privilege management features as experimental functionality. While Tsurugi has previously included partial authentication features for specific components, Tsurugi 1.6.0 significantly expands these into comprehensive user authentication and table privilege management capabilities.

User authentication supports multiple authentication methods, including username/password authentication, while the table privilege management feature provides privilege configuration capabilities through GRANT and REVOKE statements.

This release also includes several important bug fixes and stability improvements. We strongly recommend all users of previous versions to upgrade to this release.

New Features and Improvements

New Features and Improvements - Authentication & Authorization

• Introduced user authentication and table privilege management features as experimental functionality
  • User authentication supports multiple authentication methods, including username/password authentication
  • Table privilege management features support administrator and standard user categories, as well as privilege configuration capabilities through GRANT and REVOKE statements
  • In this version, authentication and authorization features are disabled by default.
    • To enable user authentication and table privilege management features, start the bundled authentication service and edit the authentication section in the configuration file tsurugi.ini before starting the Tsurugi database.
    • For details, see:
      • User Authentication and Table Privileges in Tsurugi (ja)
• Added authentication feature support to various clients
  • CLI tools
    • tgctl
      • Added authentication options to the tgctl command, added tgctl credentials subcommand to create credential files, and added privilege management support for various subcommands.
      • For details, see:
        • tgctl (ja)
    • tgsql
      • Official support for authentication options in tgsql, display of user information in REPL mode, etc.
      • For details, see:
        • tgsql (ja)
    • tgdump
      • Authentication option support for tgdump
      • For details, see:
        • tgdump (ja)
  • Client libraries
    • Tsubakuro/Java
    • Tsubakuro/Rust
    • Iceaxe
    • For information on how to use authentication features in each client library, see:
      • User Authentication and Table Privileges in Tsurugi (ja)
      • API documentation for each client library
  • Extensions
    • Tsurugi MCP Server
      • Added authentication options for MCP Server
      • For details, see:
        • Tsurugi MCP Server - README

New Features and Improvements - SQL

• Added support for GRANT and REVOKE statements with the introduction of authorization features
  • For details on GRANT and REVOKE statements, see:
    • GRANT PRIVILEGE
    • REVOKE PRIVILEGE
• Added support for target table locking during DDL execution
  • To address the known issue Database becomes unstable when DDL is executed during DML processing (TSURUGI-IS-177), table locking control has been added. When DML processing and DDL processing transactions conflict on a target table, an error is generated to prevent the database from entering an unstable state.
  • The above measures address conflicts that occur when DML and DDL are executed simultaneously in different transactions.
    • Conflicts when DML and DDL are executed simultaneously within the same transaction will be addressed in a future version.

New Features and Improvements - Transaction

• Improved Tsurugi database startup performance
  • Optimized part of the Tsurugi database startup process (index restore processing) to be executed in parallel by the transaction engine. This reduces startup time, especially for large databases.
  • The number of parallel processes for the transaction engine in the relevant processing can be changed by the setting value index_restore_threads in the cc section of the configuration file tsurugi.ini. The default value is 4. When the machine has many CPU cores, setting a larger value may reduce startup time. Please change to an appropriate value according to your environment.
• Improved performance of update operations involving scan when using LTX

New Features and Improvements - Client

• Provided Tsurugi ODBC Driver installer
  • Added support for installation via Windows installer and data source configuration from ODBC Data Source Administrator.
  • For Tsurugi ODBC Driver installation instructions, see:
    • Tsurugi ODBC Driver (ja)

Bug Fixes

Bug Fixes - SQL

• Fixed an issue where DDL could be executed using an invalidated transaction
• Fixed an issue where scale information is lost when casting a value with a decimal part of 0 to decimal

Bug Fixes - Endpoint

• Fixed an issue where "SQL-02037: The number of transactions exceeded the limit." could occur in unexpected situations

Bug Fixes - Transaction

• Fixed an issue where the database could rarely become inconsistent when restarting after transaction logs were corrupted due to improper termination of the Tsurugi database

Upgrade Notes

Client Compatibility List

Tsurugi 1.6.0 supports the following clients.
Please upgrade each client as needed when upgrading Tsurugi.

Client	Version
Tsubakuro/Java	1.11.0
Iceaxe	1.11.0
Tanzawa	1.11.0
Tsubakuro/Rust	0.5.0
Tsurugi MCP Server	0.3.0

Transaction Log Format Changes

In this version, the transaction log format version has been changed to Version 6. When you start version 1.6.0 using a transaction log that was used with version 1.5.0, the transaction log format version will be automatically updated.

As a result, transaction logs started with version 1.6.0 cannot be used with version 1.5.0. Also, please note that backups created with version 1.6.0 or later cannot be restored with version 1.5.0.

Authentication-Related Incompatible Changes

Version 1.6.0 includes several important changes to authentication-related functionality. While authentication features in version 1.5.0 and earlier were limited to integration with specific components and were not public features in themselves, many incompatible changes have been made. The main changes are listed below:

• Changes to authentication server (Jetty) Java version
  • With the upgrade of Jetty from Jetty 11 to Jetty 12 introduced by the installer in Tsurugi 1.6, the authentication server now requires Java 17 or higher.
  • Java 11, which was previously supported, is no longer supported.
• Changes to Jetty JAAS configuration file
  • With the upgrade to Jetty 12, the JAAS configuration file format has changed. JAAS configuration files for Jetty introduced by previous versions of the Tsurugi installer cannot be used with Jetty 12.
  • Tsurugi 1.6 provides JAAS configuration files in the new format. If you are using existing configuration files, you need to update the configuration to match the new format.
  • For details, see:
    • Jetty 12 - JAAS
• Deprecation of environment variable TSURUGI_JWT_SECRET_KEY
  • The environment variable TSURUGI_JWT_SECRET_KEY used for authentication service configuration has been deprecated. Instead, place a PEM format key file and set this file path in the configuration item tsurugi.jwt.private_key_file in harinoki.properties.
  • For details, see:
    • Authentication Server (Harinoki) Startup Configuration (ja)
• Changes to credential file format
  • The format of the credential file specified by the --credentials option in tgsql has been changed from the traditional JSON format to an encrypted key file format.
  • Accordingly, the default credential file extension has also been changed as follows:
    • credentials.json -> credentials.key
  • Encrypted files can be generated from the tgctl credentials command. For details, see:
    • tgctl credentials (ja)
• Integration of authentication service and authentication server logs
  • Authentication service and authentication server logs have been integrated, and authentication service logs are now output as part of Jetty logs.
  • Authentication service log settings can be changed by var/auth/resources/jetty-logging.properties under the Tsurugi installation directory.

Upgrade Procedure

For instructions on upgrading from previous versions, see:

• Tsurugi Upgrade Guide

Other Information

For a full list of changes in this version, see the Changelog:

• Tsurugi 1.6.0 - Changelog

For known issues and additional information about fixes in this version, see:

• Tsurugi 1.6.0 - Known Issues (en)