Add getSchema() to Records for schema access with empty results#2777
Merged
chernser merged 1 commit intoClickHouse:mainfrom Mar 5, 2026
Merged
Add getSchema() to Records for schema access with empty results#2777chernser merged 1 commit intoClickHouse:mainfrom
chernser merged 1 commit intoClickHouse:mainfrom
Conversation
Expose TableSchema from Records to enable access to column metadata even when query results are empty
chernser
approved these changes
Mar 5, 2026
Contributor
|
thank you for the contribution! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add
getSchema()method toRecordsclass to enable access to table schema metadata even when query results are empty.Following the pattern from PR #2004, this change exposes the
TableSchemafrom the underlyingClickHouseBinaryFormatReader, making it consistent withGenericRecord.getSchema().Use case: When
queryRecords()orqueryAll()returns no rows, users can still inspect column metadata (names, types, etc.) without needing to iterate through records.Example:
Checklist
CHANGELOG entry:
Note
Low Risk
Low risk API addition that delegates to the existing binary reader schema with only new test coverage; minimal impact beyond adding a new method.
Overview
Adds
Records.getSchema()to return the underlyingTableSchema, enabling schema inspection even whenRecords.isEmpty()is true.Extends
QueryTestswith integration coverage forgetSchema()on both empty and non-empty result sets, and asserts records’ per-row schema matches the collection schema.Written by Cursor Bugbot for commit ab709af. This will update automatically on new commits. Configure here.