Skip to content

Conversation

@sheyanjie-qq
Copy link
Contributor

@sheyanjie-qq sheyanjie-qq commented Oct 15, 2025

Description

Please briefly describe the code changes in this pull request.

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?

@gemini-code-assist
Copy link
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 focuses on a substantial overhaul of the TDengine documentation, specifically targeting the organization and clarity of information regarding database connectors and error codes. By introducing reusable MDX components and centralizing error code references, the changes aim to provide a more consistent, maintainable, and user-friendly documentation experience. The update also refines the guidance on connection methods, promoting WebSocket connections and clarifying the scope of direct REST API interactions.

Highlights

  • Documentation Refactoring: The documentation for TDengine connectors and error codes has undergone a significant refactoring. Common introductory text, connection methods, and platform compatibility matrices have been extracted into reusable MDX components (_connector_type.mdx and _platform_supported.mdx) for improved consistency and maintainability across English and Chinese documentation.
  • Centralized Error Codes: All detailed error code tables, previously embedded within individual language-specific connector documentation (C++, Java, Node.js, Rust, C#), have been consolidated into a single, comprehensive error-code.md document. This centralizes error information for both TSDB (server/client) and connector-specific errors, making it easier for developers to reference.
  • Clarified REST API Usage: The documentation now clearly distinguishes between using language-specific connectors (which can leverage WebSocket or Native connections) and directly interacting with the TDengine REST API. Direct REST API usage is noted to have more limited functionality (primarily SQL execution) compared to connectors, and previous 'REST connection' examples within connectors have been largely removed or de-emphasized in favor of WebSocket connections.
  • Java Example Update: A minor update was made to the Java MyBatis-Plus example, adding a new countBySql method to the MetersMapper interface and a corresponding test case to verify its functionality.
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.

@sheyanjie-qq sheyanjie-qq changed the title docs: update conntector and error code page docs: update conntector and error code page, remove rest connect type Oct 15, 2025
Copy link
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 significantly improves the documentation by refactoring shared content into reusable components and centralizing the error code information. This enhances maintainability and consistency across the documentation. The changes also seem to de-emphasize REST connections in favor of WebSocket connections, which is a significant strategic update.

My review includes a critical security suggestion for an example file to prevent SQL injection, and a suggestion to improve the clarity and maintainability of the new error code page.

Also, there's a small typo in the pull request title: 'connttector' should be 'connector'.

Copy link
Contributor

@zitsen zitsen left a comment

Choose a reason for hiding this comment

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

LGTM

@zitsen zitsen merged commit f8e55ed into main Oct 15, 2025
5 checks passed
@zitsen zitsen deleted the docs/TD-38201 branch October 15, 2025 13:03
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.

5 participants