Skip to content
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

feat(bigquery): support to query BigQuery external table #1055

Merged
merged 2 commits into from
Feb 6, 2025

Conversation

goldmedal
Copy link
Contributor

@goldmedal goldmedal commented Feb 6, 2025

Description

Refer to Create credentials with scopes. If a BigQuery table comes from an external data (e.g. google sheet), we need to set up require permission and scopes for the credentials.

Summary by CodeRabbit

  • New Features
    • Enhanced integration with Google Cloud services by expanding authentication permissions, enabling more robust interactions with additional cloud functionalities.

Copy link

coderabbitai bot commented Feb 6, 2025

Walkthrough

The changes update two modules to include two additional OAuth scopes for BigQuery credentials. In both the BigQueryConnector.query method and the DataSourceExtension.get_bigquery_connection method, the credentials object is modified using the with_scopes method. The added scopes are "https://www.googleapis.com/auth/drive" and "https://www.googleapis.com/auth/cloud-platform". The overall structure of both classes remains unchanged, with only the credential configuration being extended.

Changes

Files Change Summary
ibis-server/app/model/connector.py
ibis-server/app/model/data_source.py
Modified credential creation to include additional OAuth scopes (https://www.googleapis.com/auth/drive and https://www.googleapis.com/auth/cloud-platform) for BigQuery.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Connector as BigQueryConnector
    participant Cred as Credentials
    participant GCS as Google Cloud Services

    Client->>Connector: query(service_account_info)
    Connector->>Cred: Create credentials from service account info
    Cred->>Cred: with_scopes(["https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/cloud-platform"])
    Connector->>GCS: Execute query with updated credentials
Loading
sequenceDiagram
    participant Client
    participant DataSource as DataSourceExtension
    participant Cred as Credentials
    participant GCS as Google Cloud Services

    Client->>DataSource: get_bigquery_connection(info)
    DataSource->>Cred: Create credentials for BigQuery
    Cred->>Cred: with_scopes(["https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/cloud-platform"])
    DataSource->>GCS: Return connection using updated credentials
Loading

Poem

I'm a rabbit on a coding spree,
Hoping through changes gracefully,
Scopes for Cloud and Drive now bloom,
Adding power, banishing gloom,
Leaping forward with a happy tune 🐇💻!

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

@github-actions github-actions bot added ibis python Pull requests that update Python code labels Feb 6, 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: 1

🧹 Nitpick comments (1)
ibis-server/app/model/data_source.py (1)

101-106: LGTM! Consider adding a comment explaining scope requirements.

The scope configuration is correctly placed before creating the connection. Consider adding a comment explaining why these scopes are required for external table support.

+        # Add required scopes for accessing BigQuery external tables
         credentials = credentials.with_scopes([
             "https://www.googleapis.com/auth/drive",
             "https://www.googleapis.com/auth/cloud-platform",
         ])
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 664e6af and 465fcc0.

📒 Files selected for processing (2)
  • ibis-server/app/model/connector.py (1 hunks)
  • ibis-server/app/model/data_source.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: validate-pull-request-title
  • GitHub Check: ci
🔇 Additional comments (1)
ibis-server/app/model/connector.py (1)

154-155: Verify the minimum required scopes for external tables.

Let's verify if both scopes are necessary for external table support.

ibis-server/app/model/connector.py Show resolved Hide resolved
@goldmedal goldmedal requested a review from wwwy3y3 February 6, 2025 08:06
@goldmedal goldmedal merged commit 83389fd into Canner:main Feb 6, 2025
11 checks passed
@goldmedal goldmedal deleted the feat/support-bq-external-table branch February 6, 2025 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ibis python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants