Skip to content

Temporary hack to work with partition values stored as yyyy-MM-dd but represented as yyyyMMdd in information schema in bq. #175

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 3 commits into from
Jan 8, 2025

Conversation

david-zlai
Copy link
Contributor

@david-zlai david-zlai commented Jan 7, 2025

Summary

We noticed a discrepancy of the date format between partitions in INFORMATION_SCHEMA.PARTITIONS in bigquery vs how it's represented in the actual bq table.

in particular, we see that the raw bq table will have ds in yyyy-MM-dd but for some reason BQ will represent that ds partition id in INFORMATION_SCHEMA.PARTITIONS to be formatted as yyyyMMdd (no dashes).

To work around this, we're coding with the assumption that partition ids in INFORMATION_SCHEMA.PARTITIONS to be yyyyMMdd.

Checklist

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

Copy link

coderabbitai bot commented Jan 7, 2025

Walkthrough

The pull request modifies the BigQueryFormat.scala file in the GCP cloud integration module, specifically enhancing the partitions method of the BQuery class. The change introduces more flexible partition value processing by incorporating the date_format function from Spark SQL, allowing configurable partition formatting while maintaining a default "yyyyMMdd" format.

Changes

File Change Summary
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryFormat.scala - Added import for date_format from org.apache.spark.sql.functions
- Updated partition processing logic to use date_format for more flexible date formatting

Possibly related PRs

Suggested reviewers

  • nikhil-zlai

Poem

🕰️ Partitions dance, dates reborn anew,
Spark's magic weaves a flexible view
From rigid strings to format's grace
Code evolves with elegant embrace
🌟 BigQuery's rhythm now set free!

Warning

Review ran into problems

🔥 Problems

GitHub Actions: 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 docstrings to generate docstrings for this PR. (Beta)
  • @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.

@david-zlai david-zlai marked this pull request as ready for review January 8, 2025 20:47
@david-zlai david-zlai force-pushed the davidhan/temp_hack_date_format_raw branch from 01a81dd to 0a2ea05 Compare January 8, 2025 20:48
@david-zlai david-zlai changed the title Temporary hack to work with partition values stored as yyyy-MM-dd but… Temporary hack to work with partition values stored as yyyy-MM-dd but represented as yyyyMMdd in information schema in bq. Jan 8, 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: 0

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

151-153: Track this technical debt.

Create a ticket to standardize on yyyyMMdd format for future BigQuery data storage.

Want me to create a GitHub issue to track this technical debt?


162-167: Remove misleading comment about hardcoded format.

The "yyyyMMdd" format must match BigQuery's INFORMATION_SCHEMA format - it's not something we can change.

-              "yyyyMMdd" // Note: this "yyyyMMdd" format is hardcoded but we need to change it to be something else.
+              "yyyyMMdd" // Note: this matches BigQuery's INFORMATION_SCHEMA.PARTITIONS format
📜 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 98fb0d3 and 0a2ea05.

📒 Files selected for processing (1)
  • cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryFormat.scala (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: scala_compile_fmt_fix
🔇 Additional comments (2)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigQueryFormat.scala (2)

15-15: LGTM! Import required for date formatting.


154-154: LGTM! Good use of Spark configuration for format flexibility.

@david-zlai david-zlai requested a review from tchow-zlai January 8, 2025 20:51
@david-zlai david-zlai merged commit ecea77f into main Jan 8, 2025
4 checks passed
@david-zlai david-zlai deleted the davidhan/temp_hack_date_format_raw branch January 8, 2025 21:15
tchow-zlai pushed a commit that referenced this pull request Jan 9, 2025
… represented as yyyyMMdd in information schema in bq. (#175)

## Summary

We noticed a discrepancy of the date format between partitions in
INFORMATION_SCHEMA.PARTITIONS in bigquery vs how it's represented in the
actual bq table.

in particular, we see that the raw bq table will have `ds` in
`yyyy-MM-dd` but for some reason BQ will represent that `ds` partition
id in INFORMATION_SCHEMA.PARTITIONS to be formatted as `yyyyMMdd` (no
dashes).

To work around this, we're coding with the assumption that partition ids
in INFORMATION_SCHEMA.PARTITIONS to be `yyyyMMdd`.


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



---
- To see the specific tasks where the Asana app for GitHub is being
used, see below:
  - https://app.asana.com/0/0/1209110958473706
Co-authored-by: Thomas Chow <[email protected]>
@coderabbitai coderabbitai bot mentioned this pull request Jan 9, 2025
4 tasks
tchow-zlai added a commit that referenced this pull request Jan 9, 2025
## Summary

- do some date formatting because the input partitions may be of `DATE`
type, so we need to normalize them to a string.
- inline some options for bigquery writes for now, will follow up with
more abstracted handling. See:
#175
## Checklist
- [ ] Added Unit Tests
- [x] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Updated partition column and format handling in DataFrame processing.
- Modified visibility of `partitionFormat` to improve package-level
access.
  - Removed optional write format variable from TableUtils.

These changes enhance the functionality of data processing utilities by
refining how partition columns are managed and accessed within the Spark
extensions.
<!-- 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]>
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
… represented as yyyyMMdd in information schema in bq. (#175)

## Summary

We noticed a discrepancy of the date format between partitions in
INFORMATION_SCHEMA.PARTITIONS in bigquery vs how it's represented in the
actual bq table.

in particular, we see that the raw bq table will have `ds` in
`yyyy-MM-dd` but for some reason BQ will represent that `ds` partition
id in INFORMATION_SCHEMA.PARTITIONS to be formatted as `yyyyMMdd` (no
dashes).

To work around this, we're coding with the assumption that partition ids
in INFORMATION_SCHEMA.PARTITIONS to be `yyyyMMdd`.


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



---
- To see the specific tasks where the Asana app for GitHub is being
used, see below:
  - https://app.asana.com/0/0/1209110958473706
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
## Summary

- do some date formatting because the input partitions may be of `DATE`
type, so we need to normalize them to a string.
- inline some options for bigquery writes for now, will follow up with
more abstracted handling. See:
#175
## Checklist
- [ ] Added Unit Tests
- [x] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Updated partition column and format handling in DataFrame processing.
- Modified visibility of `partitionFormat` to improve package-level
access.
  - Removed optional write format variable from TableUtils.

These changes enhance the functionality of data processing utilities by
refining how partition columns are managed and accessed within the Spark
extensions.
<!-- 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]>
kumar-zlai pushed a commit that referenced this pull request Apr 29, 2025
… represented as yyyyMMdd in information schema in bq. (#175)

## Summary

We noticed a discrepancy of the date format between partitions in
INFORMATION_SCHEMA.PARTITIONS in bigquery vs how it's represented in the
actual bq table.

in particular, we see that the raw bq table will have `ds` in
`yyyy-MM-dd` but for some reason BQ will represent that `ds` partition
id in INFORMATION_SCHEMA.PARTITIONS to be formatted as `yyyyMMdd` (no
dashes).

To work around this, we're coding with the assumption that partition ids
in INFORMATION_SCHEMA.PARTITIONS to be `yyyyMMdd`.


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



---
- To see the specific tasks where the Asana app for GitHub is being
used, see below:
  - https://app.asana.com/0/0/1209110958473706
kumar-zlai pushed a commit that referenced this pull request Apr 29, 2025
## Summary

- do some date formatting because the input partitions may be of `DATE`
type, so we need to normalize them to a string.
- inline some options for bigquery writes for now, will follow up with
more abstracted handling. See:
#175
## Checklist
- [ ] Added Unit Tests
- [x] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Updated partition column and format handling in DataFrame processing.
- Modified visibility of `partitionFormat` to improve package-level
access.
  - Removed optional write format variable from TableUtils.

These changes enhance the functionality of data processing utilities by
refining how partition columns are managed and accessed within the Spark
extensions.
<!-- 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]>
@coderabbitai coderabbitai bot mentioned this pull request May 8, 2025
4 tasks
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
… represented as yyyyMMdd in information schema in bq. (#175)

## Summary

We noticed a discrepancy of the date format between partitions in
INFORMATION_SCHEMA.PARTITIONS in bigquery vs how it's represented in the
actual bq table.

in particular, we see that the raw bq table will have `ds` in
`yyyy-MM-dd` but for some reason BQ will represent that `ds` partition
id in INFORMATION_SCHEMA.PARTITIONS to be formatted as `yyyyMMdd` (no
dashes).

To work around this, we're coding with the assumption that partition ids
in INFORMATION_SCHEMA.PARTITIONS to be `yyyyMMdd`.


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



---
- To see the specific tasks where the Asana app for GitHub is being
used, see below:
  - https://app.asana.com/0/0/1209110958473706
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary

- do some date formatting because the input partitions may be of `DATE`
type, so we need to normalize them to a string.
- inline some options for bigquery writes for now, will follow up with
more abstracted handling. See:
#175
## Checklist
- [ ] Added Unit Tests
- [x] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Updated partition column and format handling in DataFrame processing.
- Modified visibility of `partitionFormat` to improve package-level
access.
  - Removed optional write format variable from TableUtils.

These changes enhance the functionality of data processing utilities by
refining how partition columns are managed and accessed within the Spark
extensions.
<!-- 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
…MM-dd but represented as yyyyMMdd in information schema in bq. (#175)

## Summary

We noticed a discrepancy of the date format between partitions in
INFORMATION_SCHEMA.PARTITIONS in bigquery vs how it's represented in the
actual bq table.

in particular, we see that the raw bq table will have `ds` in
`yyyy-MM-dd` but for some reason BQ will represent that `ds` partition
id in INFORMATION_SCHEMA.PARTITIONS to be formatted as `yyyyMMdd` (no
dashes).

To work around this, we're coding with the assumption that partition ids
in INFORMATION_SCHEMA.PARTITIONS to be `yyyyMMdd`.


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



---
- To see the specific tasks where the Asana app for GitHub is being
used, see below:
  - https://app.asana.com/0/0/1209110958473706
chewy-zlai pushed a commit that referenced this pull request May 16, 2025
## Summary

- do some date formatting because the input partitions may be of `DATE`
type, so we need to normalize them to a string.
- inline some options for bigquery writes for now, will follow up with
more abstracted handling. See:
#175
## Cheour clientslist
- [ ] Added Unit Tests
- [x] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Updated partition column and format handling in DataFrame processing.
- Modified visibility of `partitionFormat` to improve paour clientsage-level
access.
  - Removed optional write format variable from TableUtils.

These changes enhance the functionality of data processing utilities by
refining how partition columns are managed and accessed within the Spark
extensions.
<!-- 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.

2 participants