Skip to content

Conversation

@rahul2393
Copy link
Contributor

This commit adds the foundational SsFormat class that provides sortable string format (ssformat) encoding utilities. This encoding is used by Spanner for key ordering and routing.

Key features:

  • Composite tag encoding for interleaved tables
  • Signed/unsigned integer encoding (increasing/decreasing)
  • String and bytes encoding with proper escaping
  • Double encoding with proper sign handling
  • Timestamp and UUID encoding
  • Null value markers with configurable ordering
  • TargetRange class for key range representation

This is part of the experimental location-aware routing for improved latency.

@rahul2393 rahul2393 requested review from a team as code owners January 8, 2026 03:28
@product-auto-label product-auto-label bot added size: l Pull request size is large. api: spanner Issues related to the googleapis/java-spanner API. labels Jan 8, 2026
@gemini-code-assist
Copy link

Summary of Changes

Hello @rahul2393, I'm Gemini Code Assist1! 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 core encoding utilities for Spanner's key management and routing. It provides a robust SsFormat library for various data types and a TargetRange class for key range representation, laying the groundwork for advanced features like location-aware routing to enhance performance.

Highlights

  • New SsFormat Encoding Library: Introduces the foundational SsFormat class, providing sortable string format (ssformat) encoding utilities essential for Spanner's key ordering and routing mechanisms.
  • Comprehensive Encoding Support: The SsFormat library supports a wide range of data types, including composite tags for interleaved tables, signed/unsigned integers (increasing/decreasing order), strings and bytes with proper escaping, doubles with sign handling, timestamps, and UUIDs. It also includes configurable null value markers.
  • New TargetRange Class: Adds a TargetRange class to represent key ranges, featuring start, limit, and approximate properties, along with a mergeFrom method for combining ranges.
  • Location-Aware Routing: These changes are part of an experimental initiative to implement location-aware routing, aiming to improve latency within Spanner.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces the SsFormat encoding library and the TargetRange class, which are foundational for sortable string format (ssformat) encoding utilities used by Spanner for key ordering and routing. The SsFormat class provides various encoding methods for different data types, including integers, strings, doubles, timestamps, and UUIDs, supporting both increasing and decreasing order. The TargetRange class represents a key range and includes logic for merging ranges. Overall, it is a good starting point. However, I've identified a potential correctness issue in the byte sequence encoding and some areas for improved maintainability.

This commit adds the foundational SsFormat class that provides sortable
string format (ssformat) encoding utilities. This encoding is used by
Spanner for key ordering and routing.

Key features:
- Composite tag encoding for interleaved tables
- Signed/unsigned integer encoding (increasing/decreasing)
- String and bytes encoding with proper escaping
- Double encoding with proper sign handling
- Timestamp and UUID encoding
- Null value markers with configurable ordering
- TargetRange class for key range representation

Includes unit tests for all encoding functions.

This is part of the experimental location-aware routing for improved
latency.
@rahul2393 rahul2393 force-pushed the feat/ssformat-encoding branch from 77c4f60 to a6b8fc2 Compare January 8, 2026 03:38
@rahul2393 rahul2393 force-pushed the feat/ssformat-encoding branch from fcdf2cc to 5ad36f7 Compare January 8, 2026 07:14
Added missing clirr exemptions for the protobuf library upgrade from
GeneratedMessage to GeneratedMessageV3:

- 5001: Removed superclass (GeneratedMessage/GeneratedMessage$Builder)
- 7005: Parameter type changes (BuilderParent types)
- 7006: Return type changes (internalGetFieldAccessorTable)
- 7014: Method made final (getDescriptor)

These exemptions are applied to all proto modules:
- proto-google-cloud-spanner-admin-instance-v1
- proto-google-cloud-spanner-admin-database-v1
- proto-google-cloud-spanner-v1
- proto-google-cloud-spanner-executor-v1
@product-auto-label product-auto-label bot added size: xl Pull request size is extra large. and removed size: l Pull request size is large. labels Jan 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: spanner Issues related to the googleapis/java-spanner API. size: xl Pull request size is extra large.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants