datahub icon indicating copy to clipboard operation
datahub copied to clipboard

feat(ingest/bigquery): Add schema metadata field for _PARTITIONTIME internal column

Open asikowitz opened this issue 2 years ago • 3 comments

Produces the following smoke test change:

Urn changed, urn:li:dataset:(urn:li:dataPlatform:bigquery,acryl-staging-2.smoke_test_db_4.table_with_ingestion_time_partition,PROD):
<schemaMetadata> changed:
	Item aspect['fields'][1] added to iterable.
Old aspect:
    schemaName: acryl-staging-2.smoke_test_db_4.table_with_ingestion_time_partition
    platform: urn:li:dataPlatform:bigquery
    version: 0
    created:
      time: 0
      actor: urn:li:corpuser:unknown
    lastModified:
      time: 0
      actor: urn:li:corpuser:unknown
    hash: ''
    platformSchema:
      com.linkedin.schema.MySqlDDL:
        tableSchema: ''
    fields:
    - fieldPath: transaction_id
      nullable: true
      type:
        type:
          com.linkedin.schema.NumberType: {}
      nativeDataType: INT64
      recursive: false
      globalTags:
        tags: []
      isPartOfKey: false
New aspect:
    schemaName: acryl-staging-2.smoke_test_db_4.table_with_ingestion_time_partition
    platform: urn:li:dataPlatform:bigquery
    version: 0
    created:
      time: 0
      actor: urn:li:corpuser:unknown
    lastModified:
      time: 0
      actor: urn:li:corpuser:unknown
    hash: ''
    platformSchema:
      com.linkedin.schema.MySqlDDL:
        tableSchema: ''
    fields:
    - fieldPath: transaction_id
      nullable: true
      type:
        type:
          com.linkedin.schema.NumberType: {}
      nativeDataType: INT64
      recursive: false
      globalTags:
        tags: []
      isPartOfKey: false
    - fieldPath: _PARTITIONTIME
      nullable: true
      type:
        type:
          com.linkedin.schema.TimeType: {}
      nativeDataType: TIMESTAMP
      recursive: false
      globalTags:
        tags:
        - tag: urn:li:tag:PARTITION_KEY
      isPartOfKey: false

Checklist

  • [ ] The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • [ ] Links to related issues (if applicable)
  • [ ] Tests for the changes have been added/updated (if applicable)
  • [ ] Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • [ ] For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

  • New Features
    • Improved BigQuery integration by adding logic to handle partition information for tables, including appending a timestamp column to schema metadata under specific conditions.

asikowitz avatar Jun 28 '23 22:06 asikowitz

For the partition key tag, let's link to https://cloud.google.com/bigquery/docs/querying-partitioned-tables in the docs for that tag

hsheth2 avatar Jul 05 '23 18:07 hsheth2

Deployment failed with the following error:

The provided GitHub repository does not contain the requested branch or commit reference. Please ensure the repository is not empty.

vercel[bot] avatar Aug 09 '23 05:08 vercel[bot]

Walkthrough

The gen_schema_metadata function in the bigquery.py file of the metadata-ingestion module has been enhanced. It now includes logic to conditionally add a partition timestamp column to the schema metadata when the table meets specific criteria. This ensures that partition information is accurately captured for tables in BigQuery.

Changes

File Change Summary
metadata-ingestion/src/datahub/ingestion/source/bigquery_v2/bigquery.py Added import for google.cloud.bigquery.StandardSqlTypeNames and updated gen_schema_metadata to conditionally append a BigqueryColumn for partition information.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BigQuerySource
    participant Table
    participant gen_schema_metadata

    User ->> BigQuerySource: Create BigQuery Source
    BigQuerySource ->> Table: Fetch Table Information
    Table -->> BigQuerySource: Table Metadata
    BigQuerySource ->> gen_schema_metadata: Generate Schema Metadata
    gen_schema_metadata ->> gen_schema_metadata: Check Partition Criteria
    alt Meets Criteria
        gen_schema_metadata ->> gen_schema_metadata: Append Partition Column
    end
    gen_schema_metadata -->> BigQuerySource: Updated Schema Metadata
    BigQuerySource -->> User: Return Schema Metadata

Poem

In a land where data flows and grows,
A rabbit worked on schema rows 🐇,
He added partitions with great care,
So metadata's correct, fair and square.
With BigQuery columns shining bright,
Tables are now a perfect sight!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

coderabbitai[bot] avatar Jun 28 '24 21:06 coderabbitai[bot]

Closing as this is old and stale

asikowitz avatar Oct 21 '24 20:10 asikowitz