Skip to content

docs: add connector compatibility desc#34181

Merged
zitsen merged 1 commit intomainfrom
docs/6659972418
Jan 6, 2026
Merged

docs: add connector compatibility desc#34181
zitsen merged 1 commit intomainfrom
docs/6659972418

Conversation

@sheyanjie-qq
Copy link
Copy Markdown
Contributor

Closes: 6659972418

Description

Issue(s)

  • Close/close/Fix/fix/Resolve/resolve: Issue Link

Checklist

Please check the items in the checklist if applicable.

  • Is the user manual updated?
  • Are the test cases passed and automated?
  • Is there no significant decrease in test coverage?

Copilot AI review requested due to automatic review settings January 6, 2026 07:26
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @sheyanjie-qq, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the documentation regarding TDengine TSDB's connection methods, specifically focusing on WebSocket connections. It introduces a clear compatibility guarantee for WebSocket-based connectors with newer server versions and outlines the minimum connector versions required to leverage this guarantee. The update aims to provide users with precise information on connector compatibility, ensuring smoother integration and operation.

Highlights

  • WebSocket Compatibility Guarantee: Added a detailed description of the compatibility guarantee for WebSocket connections, ensuring all supporting connectors are compatible with TDengine TSDB 3.3.6.0 and later server versions.
  • Minimum Connector Version Requirements: Included a list of minimum version requirements for various connectors (Rust, Java, Go, Python, Node.js, C#, C/C++/ODBC) to benefit from the WebSocket compatibility guarantee.
  • Multilingual Documentation Update: The compatibility information has been updated in both English and Chinese documentation files.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation about connector compatibility for WebSocket connections in both English and Chinese. The added information is valuable, but it's presented as a long, single sentence in both files, which can be difficult to read. I've provided suggestions to format this information as a bulleted list to improve readability and make it easier for users to quickly find the version requirements for each connector.

Comment thread docs/en/assets/resources/_connector_type.mdx Outdated
Comment thread docs/zh/14-reference/05-connector/_connector_type.mdx Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds connector compatibility information to the WebSocket connection documentation, explaining that WebSocket connections provide a compatibility guarantee with TDengine TSDB 3.3.6.0 and later versions when using connectors that meet specific minimum version requirements.

  • Added compatibility guarantee description for WebSocket connections
  • Listed minimum version requirements for various language connectors (Rust, Java, Go, Python, Node.js, C#, C/C++/ODBC)

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/zh/14-reference/05-connector/_connector_type.mdx Added Chinese documentation for WebSocket connector compatibility guarantees and minimum version requirements
docs/en/assets/resources/_connector_type.mdx Added English documentation for WebSocket connector compatibility guarantees and minimum version requirements

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/zh/14-reference/05-connector/_connector_type.mdx Outdated
Comment thread docs/zh/14-reference/05-connector/_connector_type.mdx Outdated
Comment thread docs/en/assets/resources/_connector_type.mdx Outdated
Comment thread docs/zh/14-reference/05-connector/_connector_type.mdx Outdated
@zitsen zitsen merged commit 6cac9d6 into main Jan 6, 2026
8 checks passed
@zitsen zitsen deleted the docs/6659972418 branch January 6, 2026 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants