chore(ibis): Support additional PyMySQL configuration via kwargs

[ongdisheng]

Description

This PR adds a kwargs parameter to allow users to pass additional keyword arguments to PyMySQL for enhanced configurability. Defaults to None.

[coderabbitai]

Walkthrough

The pull request introduces an enhancement to the MySQL connection configuration in the Ibis server. A new optional kwargs field is added to the MySqlConnectionInfo class, allowing users to pass additional keyword arguments to the PyMySQL library. The get_mysql_connection method in the DataSourceExtension class is updated to incorporate these extra connection parameters, providing more flexibility in database connection setup.

Changes

File	Change Summary
ibis-server/app/model/__init__.py	Added optional kwargs field to MySqlConnectionInfo class with type `dict[str, str]
ibis-server/app/model/data_source.py	Updated get_mysql_connection method to handle additional keyword arguments via **info.kwargs

Sequence Diagram

sequenceDiagram
    participant User
    participant MySqlConnectionInfo
    participant DataSourceExtension
    participant PyMySQL

    User->>MySqlConnectionInfo: Create connection info with optional kwargs
    MySqlConnectionInfo-->>DataSourceExtension: Pass connection info
    DataSourceExtension->>PyMySQL: Establish connection with extra parameters
    PyMySQL-->>DataSourceExtension: Connection established

Loading

Poem

🐰 A MySQL connection tale, so bright
With kwargs dancing left and right
Flexibility springs forth today
Extra parameters find their way
A rabbit's code, now more refined! 🔧

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

ibis-server/app/model/__init__.py (1)

98-100: Consider supporting broader data types for kwargs.

Currently, kwargs is defined as dict[str, str]. Some PyMySQL arguments (especially SSL options) may require booleans, numeric values, or nested dictionaries. Consider either supporting a more accommodating type or clarifying that only string-based parameters are expected. Also ensure you test how these kwargs get passed and interpreted by PyMySQL.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 441743e and 0483a79.

📒 Files selected for processing (2)

• ibis-server/app/model/__init__.py (1 hunks)
• ibis-server/app/model/data_source.py (1 hunks)

🔇 Additional comments (1)

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

134-134: Validate overlap of existing parameters with kwargs.

When passing **info.kwargs, keys in kwargs might conflict with or overshadow named parameters like host, port, etc. Confirm this behavior is correct, and if necessary, warn or sanitize overlapping keys to avoid confusion. This helps ensure predictable connections and user experience.

[goldmedal]

Thanks @ongdisheng, look great!

[ongdisheng]

Edited the PR title and description to better align with the changes introduced and improve clarity :D.