Add ClientService and CLI for Table Store

[jnmt]

Description

This PR adds client service APIs and CLIs to interact with ScalarDL as a table store.

Related issues and/or PRs

• Add PartiQL parser (Create Table and Insert) #180
• Support Select and Update statement in PartiQL #192

Changes made

• Add the dedicated ClientServiceFactory that creates ClientService for the table store and automatically registers the client identity (certificate or secret) and necessary contracts.
  • ClientService has a new interface to execute a PartiQL statement instead of executing a contract.
  • ClientService also has dedicated validation interfaces for table schema, records, and index records.
• Add the client CLIs

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation to reflect the changes.
• I have considered whether similar issues could occur in other products, components, or modules if this PR is for bug fixes.
• Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
• Tests (unit, integration, etc.) have been added for the changes.
• My changes generate no new warnings.
• Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

• For now, the scalardl-table-store command is separated from the scalardl command in client due to a kind of circular dependency issue. However, it can probably be integrated by introducing the cli submodule in future refactoring. Integrating all the features into a single CLI might cause confusion (e.g., which register-cert commands should I use?), though.
• For generic contracts for object authenticity management, another abstraction, "Hash Store", will be introduced in another PR.

Release notes

Added ClientService and CLI for Table Store.

[Copilot]

Pull Request Overview

This PR introduces a new ClientService and CLI for Table Store, providing command-line tools for interacting with the table store functionality. The implementation includes both service layer abstractions and command-line interfaces for executing statements, registering contracts, and validating the ledger.

• Adds ClientService and ClientServiceFactory classes to provide a higher-level API for table store operations
• Implements CLI commands for statement execution, contract registration, and ledger validation
• Extends existing client utilities to support the new table store functionality

Reviewed Changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
table-store/src/main/java/com/scalar/dl/tablestore/client/service/ClientService.java	Core service class providing table store operations like statement execution and validation
table-store/src/main/java/com/scalar/dl/tablestore/client/service/ClientServiceFactory.java	Factory class for creating ClientService instances with proper configuration
table-store/src/main/java/com/scalar/dl/tablestore/client/tool/TableStoreCommandLine.java	Main CLI entry point with grouped subcommands for table store operations
table-store/src/main/java/com/scalar/dl/tablestore/client/tool/StatementExecution.java	CLI command for executing PartiQL statements
table-store/src/main/java/com/scalar/dl/tablestore/client/tool/LedgerValidation.java	CLI command for validating table schemas and records in the ledger
table-store/src/main/java/com/scalar/dl/tablestore/client/tool/ContractsRegistration.java	CLI command for registering all necessary table store contracts
table-store/src/main/java/com/scalar/dl/tablestore/client/model/StatementExecutionResult.java	Model class wrapping contract execution results for statement operations
table-store/src/main/java/com/scalar/dl/tablestore/client/error/TableStoreClientError.java	Adds error code for multiple statements not supported
table-store/build.gradle	Adds CLI application configuration and picocli dependency
client/src/main/java/com/scalar/dl/client/util/Common.java	Adds utility method for loading class bytes from resources
client/src/main/java/com/scalar/dl/client/tool/CommonOptions.java	Makes fields protected for inheritance by table store CLI classes
client/src/main/java/com/scalar/dl/client/tool/Common.java	Makes validation and error printing methods public for reuse

[gemini-code-assist]

Summary of Changes

Hello @jnmt, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new ClientService and a command-line interface (CLI) specifically designed for interacting with a "Table Store" abstraction built on top of the existing Ledger system. The primary goal is to provide a more intuitive, SQL-like interface (using PartiQL) for data manipulation and validation within the Ledger, abstracting away the complexities of direct contract interactions.

Highlights

• New Table Store Client Service: A comprehensive ClientService is added to the table-store module, offering a high-level API for managing and querying data in the Table Store. This service streamlines operations by handling the underlying contract execution.
• PartiQL Statement Processing: The new ClientService enables execution of SQL-like PartiQL statements (e.g., INSERT, SELECT, UPDATE) which are internally translated and executed as generic contracts on the Ledger.
• Dedicated Command-Line Interface (CLI): A new scalardl-table-store executable CLI tool is introduced. It provides subcommands for registering necessary Table Store contracts, executing PartiQL statements, and validating the integrity of table schemas and records in the Ledger.
• Enhanced Client Utilities: Existing client-side utilities are augmented with new functionalities, including a mechanism to load class bytecode for dynamic contract registration and a new error type to handle class loading failures.
• Expanded Contract Support: New contract constants (ShowTables, GetHistory) are added, indicating extended capabilities for listing available tables and retrieving historical data through the Table Store interface.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a significant new feature: a ClientService and a command-line interface (CLI) for a Table Store. The changes are extensive, including new services, data models, and CLI commands, along with a comprehensive set of tests.

The overall structure is well-designed, with a clear separation of concerns between the service layer and the CLI tools. The code is generally of high quality. However, I've identified a few issues that should be addressed:

• A critical bug in an equals method that could lead to a NullPointerException.
• An inconsistency in exception handling that could result in unhandled runtime exceptions.
• A performance issue related to the repeated creation of expensive objects in one of the new CLI commands.

Addressing these points will improve the correctness and robustness of the new functionality.

[josh-wong]

I've added some comments and suggestions. PTAL!

[josh-wong]

Just to confirm, are we officially going to capitalize Table Store as a proper noun? If not, I think we should lowercase it here.

[jnmt]

That's a good point. I just used it, similar to ScalarDB Cluster, but let me discuss it with Hiro.

[josh-wong]

LGTM! Thank you!🙇🏻‍♂️

[feeblefakie]

LGTM! Thank you!