import Tab from '@mdx/Tab.astro'; import Tabs from '@mdx/Tabs.astro'; import Npm from "@mdx/Npm.astro"; import Callout from '@mdx/Callout.astro'; import Steps from '@mdx/Steps.astro'; import AnchorCards from '@mdx/AnchorCards.astro'; import Breadcrumbs from '@mdx/Breadcrumbs.astro'; import Prerequisites from "@mdx/Prerequisites.astro"; import CodeTabs from "@mdx/CodeTabs.astro"; import FileStructure from '@mdx/get-started/FileStructure.mdx'; import InstallPackages from '@mdx/get-started/InstallPackages.mdx'; import ConnectCockroach from '@mdx/get-started/cockroach/ConnectCockroach.mdx' import CreateTable from '@mdx/get-started/cockroach/CreateTable.mdx' import SetupConfig from '@mdx/get-started/SetupConfig.mdx'; import ApplyChanges from '@mdx/get-started/ApplyChanges.mdx'; import RunFile from '@mdx/get-started/RunFile.mdx'; import QueryDatabase from '@mdx/get-started/QueryDatabase.mdx'; import SetupEnv from '@mdx/get-started/SetupEnv.mdx';

<Breadcrumbs/>

Get Started with Drizzle and CockroachDB

<Callout type='error'> This page explains concepts available on drizzle versions `1.0.0-beta.2` and higher. </Callout> <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/) - **node-postgres** - package for querying your PostgreSQL database - [read here](https://node-postgres.com/) </Prerequisites>

Drizzle has native support for CockroachDB connections with the node-postgres and postgres.js drivers.

We will use node-postgres for this get started example. But if you want to find more ways to connect to postgresql check our CockroachDB Connection page

<FileStructure/>

Step 1 - Install node-postgres package

<Npm> drizzle-orm@beta pg dotenv -D drizzle-kit@beta tsx @types/pg </Npm>

Step 2 - Setup connection variables

<SetupEnv env_variable='DATABASE_URL' />

Step 3 - Connect Drizzle ORM to the database

<ConnectCockroach/>

Step 4 - Create a table

<CreateTable />

Step 5 - Setup Drizzle config file

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

Step 6 - Applying changes to the database

<ApplyChanges />

Step 7 - Seed and Query the database

<QueryDatabase dialect='cockroach' env_variable='DATABASE_URL'/>

Step 8 - Run index.ts file

<RunFile/>