Skip to content

feat: do partition filtering on bq native tables by union individual partitions #690

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 2 commits into from
Apr 28, 2025

Conversation

tchow-zlai
Copy link
Collaborator

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

Summary

  • Getting a 403 querying for a range of partitions in bigquery native tables:
Response too large to return. Consider specifying a destination table in your job configuration
  • instead, let's just query individual partitions of data as separate dataframes and union them together.

Checklist

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

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of BigQuery partitioned tables, ensuring more accurate partition filtering and data retrieval.
  • Refactor

    • Streamlined the process for reading partitioned data from BigQuery, resulting in a clearer and more consistent approach for users working with partitioned tables.

Co-authored-by: Thomas Chow <[email protected]>
Copy link

coderabbitai bot commented Apr 28, 2025

Walkthrough

The table method in the BigQueryNative object was refactored to simplify the retrieval of partitioned data from BigQuery tables. The previous logic for handling system-defined pseudo-columns was removed. The new approach involves querying for the partition column, obtaining distinct partition values that match provided filters, and then reading and unioning data for each partition value. The method signature and the rest of the file remain unchanged.

Changes

File(s) Change Summary
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala Refactored table method: removed system-defined pseudo-column logic, now fetches and unions per-partition reads.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant BigQueryNative
    participant BigQuery

    Caller->>BigQueryNative: table(...)
    BigQueryNative->>BigQuery: Query partition column
    BigQuery-->>BigQueryNative: Partition column name
    BigQueryNative->>BigQuery: Query distinct partition values (with filters)
    BigQuery-->>BigQueryNative: List of partition values
    loop For each partition value
        BigQueryNative->>BigQuery: Read data for partition value
        BigQuery-->>BigQueryNative: DataFrame for partition
    end
    BigQueryNative->>Caller: Unioned DataFrame with partition column
Loading

Possibly related PRs

Suggested reviewers

  • nikhil-zlai
  • david-zlai

Poem

Refactored code, partitioned anew,
No pseudo-columns in our view.
Each partition gets its day,
Unioned results, clean display.
BigQuery reads, a simpler way!
🚀

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.


📜 Recent 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 ed7162a and 50840a0.

📒 Files selected for processing (1)
  • cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: service_tests
  • GitHub Check: service_commons_tests
  • GitHub Check: online_tests
  • GitHub Check: hub_tests
  • GitHub Check: cloud_gcp_tests
  • GitHub Check: service_tests
  • GitHub Check: hub_tests
  • GitHub Check: cloud_aws_tests
  • GitHub Check: cloud_gcp_tests
  • GitHub Check: cloud_aws_tests
  • GitHub Check: api_tests
  • GitHub Check: enforce_triggered_workflows
  • GitHub Check: online_tests
  • GitHub Check: api_tests
  • GitHub Check: scala_compile_fmt_fix
  • GitHub Check: flink_tests
  • GitHub Check: flink_tests
  • GitHub Check: aggregator_tests
  • GitHub Check: aggregator_tests

🪧 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.

@tchow-zlai tchow-zlai changed the title union individual partitions feat: do partition filtering on bq native tables by union individual partitions Apr 28, 2025
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: 3

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

62-70: Many small reads ⇒ latency; prefer single IN (…)

Looping over partitions issues N BQ jobs.
A single read with WHERE partCol IN ('p1','p2',…) is faster and cheaper.

📜 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 071ef17 and ed7162a.

📒 Files selected for processing (1)
  • cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala (2)
spark/src/main/scala/ai/chronon/spark/catalog/TableUtils.scala (3)
  • sql (319-347)
  • TableUtils (43-639)
  • TableUtils (641-643)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/SparkBQUtils.scala (2)
  • SparkBQUtils (7-24)
  • toTableId (9-16)
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: service_tests
  • GitHub Check: service_commons_tests
  • GitHub Check: service_tests
  • GitHub Check: hub_tests
  • GitHub Check: online_tests
  • GitHub Check: cloud_gcp_tests
  • GitHub Check: hub_tests
  • GitHub Check: cloud_aws_tests
  • GitHub Check: cloud_gcp_tests
  • GitHub Check: online_tests
  • GitHub Check: cloud_aws_tests
  • GitHub Check: flink_tests
  • GitHub Check: flink_tests
  • GitHub Check: aggregator_tests
  • GitHub Check: api_tests
  • GitHub Check: api_tests
  • GitHub Check: scala_compile_fmt_fix
  • GitHub Check: aggregator_tests
  • GitHub Check: enforce_triggered_workflows
🔇 Additional comments (1)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryNative.scala (1)

64-70: Preserve column type when re-adding partition field

lit(partValue) re-creates the column as STRING; original may be DATE/TIMESTAMP. Consider casting:

.withColumn(partColName, lit(partValue).cast(col(partColName).schema))

val partitionWheres = if (partitionFilters.nonEmpty) s"WHERE ${partitionFilters}" else partitionFilters
val partitionFormat = TableUtils(sparkSession).partitionFormat
val dfw = sparkSession.read
val select = s"SELECT distinct(${partColName}) AS ${internalBQCol} FROM ${bqFriendlyName} ${partitionWheres}"
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Use DISTINCT …distinct() is invalid BigQuery SQL

distinct(${partColName}) will ☠️ on BQ.
Replace with the keyword form.

-val select = s"SELECT distinct(${partColName}) AS ${internalBQCol} FROM ${bqFriendlyName} ${partitionWheres}"
+val select = s"SELECT DISTINCT ${partColName} AS ${internalBQCol} FROM ${bqFriendlyName} ${partitionWheres}"
📝 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 select = s"SELECT distinct(${partColName}) AS ${internalBQCol} FROM ${bqFriendlyName} ${partitionWheres}"
val select = s"SELECT DISTINCT ${partColName} AS ${internalBQCol} FROM ${bqFriendlyName} ${partitionWheres}"

Comment on lines +50 to +55
val selectedParts = sparkSession.read
.format(bqFormat)
.option("viewsEnabled", true)
.option("materializationDataset", bqTableId.getDataset)
if (isPseudoColumn) {
val select = s"SELECT ${partColName} AS ${internalBQCol}, * FROM ${bqFriendlyName} ${partitionWheres}"
logger.info(s"BQ select: ${select}")
dfw
.load(select)
.withColumn(partColName, date_format(col(internalBQCol), partitionFormat))
.drop(internalBQCol)
} else {
dfw
.load(s"SELECT * FROM ${bqFriendlyName} ${partitionWheres}")
}
.load(select)
.select(date_format(col(internalBQCol), partitionFormat))
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add missing project option when reading partitions

Reads here omit .option("project", providedProject). Cross-project tables will fail.

 val selectedParts = sparkSession.read
   .format(bqFormat)
+  .option("project", providedProject)
   .option("viewsEnabled", true)
   .option("materializationDataset", bqTableId.getDataset)
   .load(select)

Apply the same when loading each partition below.

Comment on lines +62 to +71
selectedParts
.map((partValue) => {
val pFilter = f"${partColName} = '${partValue}'"
sparkSession.read
.format(bqFormat)
.option("filter", pFilter)
.load(bqFriendlyName)
.withColumn(partColName, lit(partValue))
}) // todo: make it nullable
.reduce(_ unionByName _)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Guard against empty partition list

reduce throws on Nil.

-  .reduce(_ unionByName _)
+  .reduceOption(_ unionByName _)
+  .getOrElse(sparkSession.emptyDataFrame)

Co-authored-by: Thomas Chow <[email protected]>
Copy link
Collaborator

@varant-zlai varant-zlai left a comment

Choose a reason for hiding this comment

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

Man, BQ such a nightmare

@tchow-zlai tchow-zlai merged commit 058dee7 into main Apr 28, 2025
22 checks passed
@tchow-zlai tchow-zlai deleted the tchow/allow-large-results branch April 28, 2025 15:48
kumar-zlai pushed a commit that referenced this pull request Apr 29, 2025
…partitions (#690)

## Summary

- Getting a 403 querying for a range of partitions in bigquery native
tables:
```
Response too large to return. Consider specifying a destination table in your job configuration
```
- instead, let's just query individual partitions of data as separate
dataframes and union them together.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update



<!-- 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"}
```
-->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved handling of BigQuery partitioned tables, ensuring more
accurate partition filtering and data retrieval.

- **Refactor**
- Streamlined the process for reading partitioned data from BigQuery,
resulting in a clearer and more consistent approach for users working
with partitioned tables.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

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

## Summary

- Getting a 403 querying for a range of partitions in bigquery native
tables:
```
Response too large to return. Consider specifying a destination table in your job configuration
```
- instead, let's just query individual partitions of data as separate
dataframes and union them together.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update



<!-- 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"}
```
-->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved handling of BigQuery partitioned tables, ensuring more
accurate partition filtering and data retrieval.

- **Refactor**
- Streamlined the process for reading partitioned data from BigQuery,
resulting in a clearer and more consistent approach for users working
with partitioned tables.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

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

## Summary

- Getting a 403 querying for a range of partitions in bigquery native
tables:
```
Response too large to return. Consider specifying a destination table in your job configuration
```
- instead, let's just query individual partitions of data as separate
dataframes and union them together.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update



<!-- 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"}
```
-->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved handling of BigQuery partitioned tables, ensuring more
accurate partition filtering and data retrieval.

- **Refactor**
- Streamlined the process for reading partitioned data from BigQuery,
resulting in a clearer and more consistent approach for users working
with partitioned tables.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

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

## Summary

- Getting a 403 querying for a range of partitions in bigquery native
tables:
```
Response too large to return. Consider specifying a destination table in your job configuration
```
- instead, let's just query individual partitions of data as separate
dataframes and union them together.

## Cheour clientslist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update



<!-- 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"}
```
-->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved handling of BigQuery partitioned tables, ensuring more
accurate partition filtering and data retrieval.

- **Refactor**
- Streamlined the process for reading partitioned data from BigQuery,
resulting in a clearer and more consistent approach for users working
with partitioned tables.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

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.

2 participants