tidbx-kysely

Connect Node.js services to TiDB Cloud via TCP or serverless HTTP dialects.

24|14|Updated Feb 23, 2023
One-click install
npx skills add https://github.com/pingcap/agent-rules --skill tidbx-kysely
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tidbx-kysely
Source: https://github.com/pingcap/agent-rules/tree/main/skills/tidbx-kysely
Command: npx skills add https://github.com/pingcap/agent-rules --skill tidbx-kysely

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides guidance for using Kysely with TiDB Cloud (TiDB X), covering TCP usage and serverless HTTP-driven workflows for serverless/edge environments.

Core Features & Use Cases

  • TCP + Kysely: Use MysqlDialect with a MySQL pool for long-lived runtimes.
  • Serverless/edge: HTTP-based Kysely dialect for serverless environments using TiDB Cloud serverless driver.
  • Use Case: Connect a Node.js service to TiDB Cloud via TCP for traditional apps or switch to HTTP serverless dialect for edge deployments.

Quick Start

Start with a simple Kysely setup using a DATABASE_URL (TCP) or a serverless dialect over HTTP, then run a basic query.