Skip to content

feat: support primary partition listing for bq native tables and views #701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 30, 2025

Conversation

tchow-zlai
Copy link
Collaborator

@tchow-zlai tchow-zlai commented Apr 29, 2025

Summary

  • For bigquery views, there won't be an explicit partition column on the table. Let's just use the same implementation to list primary part columns.

Checklist

  • Added Unit Tests
  • Covered by existing CI
  • Integration tested
  • Documentation update

Summary by CodeRabbit

  • New Features
    • Improved partition handling for BigQuery tables, allowing direct retrieval of distinct partition values.
  • Bug Fixes
    • Added clear error handling for unsupported sub-partition filtering in BigQuery partition queries.

Copy link

coderabbitai bot commented Apr 29, 2025

Walkthrough

The primaryPartitions method in the BigQueryNative object was fully overridden to directly query BigQuery for distinct values of a specified partition column. The new implementation constructs and executes a SQL query using the Spark BigQuery connector, collecting partition values as a list of strings. It also introduces an explicit check for unsupported sub-partition filtering, raising a NotImplementedError if such filters are provided. The method signature remains unchanged. The supportSubPartitionsFilter method was changed to return false. Additionally, a new ignored test was added to verify partition retrieval from a BigQuery view.

Changes

File(s) Change Summary
cloud_gcp/.../BigQueryNative.scala Fully overrides primaryPartitions to query BigQuery for distinct partition values, adds error for unsupported sub-partition filtering, changes supportSubPartitionsFilter to false.
cloud_gcp/.../BigQueryCatalogTest.scala Adds ignored test "check views" verifying partition count for a BigQuery view.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant BigQueryNative
    participant BigQuery
    participant SparkSession

    Caller->>BigQueryNative: primaryPartitions(tableName, partitionColumn, subPartitionsFilter)
    BigQueryNative->>BigQueryNative: Check if subPartitionsFilter is empty
    alt subPartitionsFilter is not empty
        BigQueryNative-->>Caller: Throw NotImplementedError
    else
        BigQueryNative->>BigQuery: Execute SQL for distinct partition values
        BigQuery->>SparkSession: Return results
        SparkSession-->>BigQueryNative: List of partition values
        BigQueryNative-->>Caller: Return List[String]
    end
Loading

Possibly related PRs

Suggested reviewers

  • nikhil-zlai
  • david-zlai
  • varant-zlai

Poem

BigQuery’s secrets, now revealed,
Partition values, no longer concealed.
With Spark it queries, columns in tow,
Throws an error if sub-partitions show.
A change in the code, crisp and direct,
Listing partitions with newfound respect!

Warning

Review ran into problems

🔥 Problems

GitHub Actions and Pipeline Checks: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (2)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala (2)

81-83: Redundant condition check.

Class returns true for supportSubPartitionsFilter (line 178), so check will never trigger.


103-104: Missing null handling.

No explicit handling for null values in partition column.

-    partVals.as[String].collect().toList
+    partVals.filter(col(partitionColumn).isNotNull).as[String].collect().toList
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 9eb680d and 518d8ca.

📒 Files selected for processing (1)
  • cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (18)
  • GitHub Check: cloud_gcp_tests
  • GitHub Check: cloud_aws_tests
  • GitHub Check: cloud_aws_tests
  • GitHub Check: cloud_gcp_tests
  • GitHub Check: service_tests
  • GitHub Check: service_tests
  • GitHub Check: online_tests
  • GitHub Check: online_tests
  • GitHub Check: hub_tests
  • GitHub Check: service_commons_tests
  • GitHub Check: flink_tests
  • GitHub Check: flink_tests
  • GitHub Check: hub_tests
  • GitHub Check: api_tests
  • GitHub Check: aggregator_tests
  • GitHub Check: aggregator_tests
  • GitHub Check: scala_compile_fmt_fix
  • GitHub Check: api_tests

Comment on lines +89 to +103
val bqPartSQL =
s"""
|select distinct ${partitionColumn} FROM ${tableName}
|""".stripMargin

val partVals = sparkSession.read
.format(bqFormat)
.option("project", providedProject)
// See: https://github.com/GoogleCloudDataproc/spark-bigquery-connector/issues/434#issuecomment-886156191
// and: https://cloud.google.com/bigquery/docs/information-schema-intro#limitations
.option("viewsEnabled", true)
.option("materializationDataset", tableIdentifier.getDataset)
.load(bqPartSQL)

partVals.as[String].collect().toList
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Unused subPartitionsFilter parameter.

Method checks if filter is supported but doesn't use it in query.

-      s"""
-         |select distinct ${partitionColumn} FROM ${tableName}
-         |""".stripMargin
+      s"""
+         |select distinct ${partitionColumn} FROM ${tableName}
+         |${if (subPartitionsFilter.nonEmpty) s"WHERE " + subPartitionsFilter.map { case (k, v) => s"`$k` = '$v'" }.mkString(" AND ") else ""}
+         |""".stripMargin
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
val bqPartSQL =
s"""
|select distinct ${partitionColumn} FROM ${tableName}
|""".stripMargin
val partVals = sparkSession.read
.format(bqFormat)
.option("project", providedProject)
// See: https://github.com/GoogleCloudDataproc/spark-bigquery-connector/issues/434#issuecomment-886156191
// and: https://cloud.google.com/bigquery/docs/information-schema-intro#limitations
.option("viewsEnabled", true)
.option("materializationDataset", tableIdentifier.getDataset)
.load(bqPartSQL)
partVals.as[String].collect().toList
val bqPartSQL =
s"""
|select distinct ${partitionColumn} FROM ${tableName}
|${if (subPartitionsFilter.nonEmpty)
s"WHERE " +
subPartitionsFilter
.map { case (k, v) => s"`$k` = '$v'" }
.mkString(" AND ")
else ""}
|""".stripMargin
val partVals = sparkSession.read
.format(bqFormat)
// See: https://github.com/GoogleCloudDataproc/spark-bigquery-connector/issues/434#issuecomment-886156191
// and: https://cloud.google.com/bigquery/docs/information-schema-intro#limitations
.option("project", providedProject)
.option("viewsEnabled", true)
.option("materializationDataset", tableIdentifier.getDataset)
.load(bqPartSQL)
partVals.as[String].collect().toList

Comment on lines +91 to +92
|select distinct ${partitionColumn} FROM ${tableName}
|""".stripMargin
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

SQL injection risk in partitionColumn.

Direct string interpolation in SQL queries is risky.

-         |select distinct ${partitionColumn} FROM ${tableName}
+         |select distinct `${partitionColumn}` FROM ${tableName}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
|select distinct ${partitionColumn} FROM ${tableName}
|""".stripMargin
|select distinct `${partitionColumn}` FROM ${tableName}
|""".stripMargin

Co-authored-by: Thomas Chow <[email protected]>
@tchow-zlai tchow-zlai force-pushed the tchow/support-part-filters branch from 7c42e72 to 97a8588 Compare April 29, 2025 23:54
Co-authored-by: Thomas Chow <[email protected]>
@tchow-zlai tchow-zlai force-pushed the tchow/support-part-filters branch from 989b4d8 to b7a83eb Compare April 30, 2025 00:03
Co-authored-by: Thomas Chow <[email protected]>
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
cloud_gcp/src/test/scala/ai/chronon/integrations/cloud_gcp/BigQueryCatalogTest.scala (3)

59-63: Add comment explaining why this test is ignored

Like line 170, consider adding a comment explaining this test requires a BigQuery connection.


59-63: Enhance test robustness

Test only validates partition count. Consider:

  1. Verifying specific partition values
  2. Confirming the tested object is actually a view

62-62: Avoid hardcoded expectations

The expected count of 30 seems specific to this test data. Consider making this more resilient to data changes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 97a8588 and bbe5653.

📒 Files selected for processing (1)
  • cloud_gcp/src/test/scala/ai/chronon/integrations/cloud_gcp/BigQueryCatalogTest.scala (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
cloud_gcp/src/test/scala/ai/chronon/integrations/cloud_gcp/BigQueryCatalogTest.scala (3)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala (1)
  • partitions (107-176)
spark/src/main/scala/ai/chronon/spark/catalog/TableUtils.scala (1)
  • partitions (183-205)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryExternal.scala (1)
  • partitions (95-97)
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: cloud_aws_tests
  • GitHub Check: service_tests
  • GitHub Check: cloud_gcp_tests
  • GitHub Check: service_commons_tests
  • GitHub Check: online_tests
  • GitHub Check: cloud_aws_tests
  • GitHub Check: hub_tests
  • GitHub Check: service_tests
  • GitHub Check: online_tests
  • GitHub Check: api_tests
  • GitHub Check: flink_tests
  • GitHub Check: cloud_gcp_tests
  • GitHub Check: hub_tests
  • GitHub Check: aggregator_tests
  • GitHub Check: api_tests
  • GitHub Check: flink_tests
  • GitHub Check: scala_compile_fmt_fix
  • GitHub Check: aggregator_tests
  • GitHub Check: enforce_triggered_workflows

@tchow-zlai tchow-zlai merged commit 819dabe into main Apr 30, 2025
22 checks passed
@tchow-zlai tchow-zlai deleted the tchow/support-part-filters branch April 30, 2025 00:39
kumar-zlai pushed a commit that referenced this pull request May 1, 2025
#701)

## Summary

- For bigquery views, there won't be an explicit partition column on the
table. Let's just use the same implementation to list primary part
columns.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Improved partition handling for BigQuery tables, allowing direct
retrieval of distinct partition values.
- **Bug Fixes**
- Added clear error handling for unsupported sub-partition filtering in
BigQuery partition queries.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->

---------

Co-authored-by: Thomas Chow <[email protected]>
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
#701)

## Summary

- For bigquery views, there won't be an explicit partition column on the
table. Let's just use the same implementation to list primary part
columns.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Improved partition handling for BigQuery tables, allowing direct
retrieval of distinct partition values.
- **Bug Fixes**
- Added clear error handling for unsupported sub-partition filtering in
BigQuery partition queries.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->

---------

Co-authored-by: Thomas Chow <[email protected]>
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
#701)

## Summary

- For bigquery views, there won't be an explicit partition column on the
table. Let's just use the same implementation to list primary part
columns.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Improved partition handling for BigQuery tables, allowing direct
retrieval of distinct partition values.
- **Bug Fixes**
- Added clear error handling for unsupported sub-partition filtering in
BigQuery partition queries.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->

---------

Co-authored-by: Thomas Chow <[email protected]>
chewy-zlai pushed a commit that referenced this pull request May 16, 2025
#701)

## Summary

- For bigquery views, there won't be an explicit partition column on the
table. Let's just use the same implementation to list primary part
columns.

## Cheour clientslist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Improved partition handling for BigQuery tables, allowing direct
retrieval of distinct partition values.
- **Bug Fixes**
- Added clear error handling for unsupported sub-partition filtering in
BigQuery partition queries.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to traour clients
the status of staour clientss when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->

---------

Co-authored-by: Thomas Chow <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants