import Npm from '@mdx/Npm.astro'; import Callout from '@mdx/Callout.astro'; import Prerequisites from "@mdx/Prerequisites.astro"; import CodeTabs from "@mdx/CodeTabs.astro"; import WhatsNextPostgres from "@mdx/WhatsNextPostgres.astro"; import Breadcrumbs from '@mdx/Breadcrumbs.astro'; import FileStructure from '@mdx/get-started/FileStructure.mdx'; import InstallPackages from '@mdx/get-started/InstallPackages.mdx'; import SetupEnv from '@mdx/get-started/SetupEnv.mdx'; import ConnectTiDB from '@mdx/get-started/mysql/ConnectTiDB.mdx'; import CreateTable from '@mdx/get-started/mysql/CreateTable.mdx'; import QueryDatabase from '@mdx/get-started/QueryDatabase.mdx'; import ApplyChanges from '@mdx/get-started/ApplyChanges.mdx'; import RunFile from '@mdx/get-started/RunFile.mdx'; import SetupConfig from '@mdx/get-started/SetupConfig.mdx';

<Breadcrumbs/>

Get Started with Drizzle and TiDB

<Prerequisites> - **dotenv** - package for managing environment variables - [read here](https://www.npmjs.com/package/dotenv) - **tsx** - package for running TypeScript files - [read here](https://tsx.is/) - **TiDB** - The Distributed SQL Database by PingCAP - [read here](https://www.pingcap.com/) - **serverless-js** - package for serverless and edge compute platforms that require HTTP external connections - [read here](https://github.com/tidbcloud/serverless-js) </Prerequisites> <Callout title='important' type='warning'> 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](/docs/get-started/mysql-new) page </Callout> <FileStructure/>

Step 1 - Install @tidbcloud/serverless package

<InstallPackages lib='@tidbcloud/serverless'/>

Step 2 - Setup connection variables

<SetupEnv env_variable='DATABASE_URL' />

Step 3 - Connect Drizzle ORM to the database

<ConnectTiDB/>

Step 4 - Create a table

<CreateTable/>

Step 5 - Setup Drizzle config file

<SetupConfig dialect='mysql' env_variable='DATABASE_URL'/>

Step 6 - Applying changes to the database

<ApplyChanges />

Step 7 - Seed and Query the database

<QueryDatabase dialect='tidb-serverless' env_variable='DATABASE_URL'/>

Step 8 - Run index.ts file

<RunFile/>