shizn/TiDB Hackathon 2022 - 贵司贵组 team‘s RFC.md

## TiDB Hackathon 2022 - 贵司贵组 team‘s RFC.md

      
    Raw
  

              TiDB Hackathon 2022 - 贵司贵组 team‘s RFC.md
            
          
    RFC template


Team name: 贵司贵组


Authors: Xin Shi


Project process:

VS Code extension repo - https://github.com/shizn/vscode-tidb-cloud
Node.JS SDK of TiDB Cloud - https://github.com/shizn/node-tidbcloud-sdk


Project description

With TiDB Cloud VS Code extension, you can have one-station experience for developing HTAP cloud apps.
Background & motivation

For now, TiDB Cloud developers have to always visit our cloud console to manage their projects and clusters. This requires lots of context-switching which are usually error-prone.
VS Code is world No.1 code editor for any language and any developers. Developers today can manage lots of cloud databases in VS Code while developing their applications. TiDB is not there yet.
This project aims to let TiDB Cloud meet where our developers are. Within VS Code, you can manage and connect to TiDB Cloud database seamlessly.
Project design

The design is simple and straightforward.
TiDB Cloud API  -> TiDB Cloud Node.JS SDK + VS Code API -> TiDB Cloud VS Code extension.
An RFC explanation video

The following image shows the basic design. Developers can manage and connect to the database with the context menu on the project/cluster