Meet Waddler
Get started

Get Started with Waddler and TiDB

This guide assumes familiarity with:
  • dotenv - package for managing environment variables - read here
  • tsx - package for running TypeScript files - read here
  • TiDB - The Distributed SQL Database by PingCAP - read here
  • serverless-js - package for serverless and edge compute platforms that require HTTP external connections - read here
important

For this tutorial, we will use the @tidbcloud/serverless driver to make HTTP calls. If you need to connect to TiDB through TCP, you can refer to our MySQL Get Started page

Basic file structure

This is the basic file structure of the project.

📦 <project root>
 ├ 📂 src
 │   └ 📜 index.ts
 ├ 📜 .env
 ├ 📜 package.json
 └ 📜 tsconfig.json

Step 1 - Install @tidbcloud/serverless package

npm
yarn
pnpm
bun 
npm i waddler @tidbcloud/serverless dotenv
npm i -D tsx

Step 2 - Setup connection variables

Create a .env file in the root of your project and add your database connection variable:

DATABASE_URL=

Step 3 - Connect Waddler to the database

Create a index.ts file in the src/db directory and initialize the connection:

import 'dotenv/config';
import { waddler } from 'waddler/tidb-serverless';

const sql = waddler(process.env.DATABASE_URL!);

If you need to provide your existing driver:

import 'dotenv/config';
import { connect } from '@tidbcloud/serverless';
import { waddler } from 'waddler/tidb-serverless';

const client = connect({ url: process.env.DATABASE_URL! });
const sql = waddler({ client });

Step 4 - Create a table


(async () => {
  await sql.unsafe(`CREATE TABLE users (
				id serial,
				name varchar(255) NOT NULL,
        age int NOT NULL,
        email varchar(255) NOT NULL UNIQUE,
				CONSTRAINT PRIMARY KEY(id)
			);
    `);
})()

Step 5 - Seed and Query the database

Let’s update the src/index.ts file with queries to create, read, update, and delete users

src/index.ts
import 'dotenv/config';
import { waddler } from 'waddler/tidb-serverless';
  
const sql = waddler(process.env.DATABASE_URL!);

async function main() {
  const user = [
    'John',
    30,
    '[email protected]',
  ];

  await sql`insert into ${sql.identifier('users')} values ${sql.values([[sql.default, ...user]])};`;
  console.log('New user created!')

  const users = await sql`select * from ${sql.identifier('users')};`;
  console.log('Getting all users from the database: ', users)
  /*
  const users: {
    id: number;
    name: string;
    age: number;
    email: string;
  }[]
  */

  await sql`update ${sql.identifier('users')} set age = ${31} where email = ${user[2]};`;
  console.log('User info updated!')

  await sql`delete from ${sql.identifier('users')} where email = ${user[2]};`;
  console.log('User deleted!')
}

main();

Step 6 - Run index.ts file

To run any TypeScript files, you have several options, but let’s stick with one: using tsx

You’ve already installed tsx, so we can run our queries now

Run index.ts script

npm
yarn
pnpm
bun 
npx tsx src/index.ts
tips

We suggest using bun to run TypeScript files. With bun, such scripts can be executed without issues or additional settings, regardless of whether your project is configured with CommonJS (CJS), ECMAScript Modules (ESM), or any other module format. To run a script with bun, use the following command:

bun src/index.ts

If you don’t have bun installed, check the Bun installation docs