Back to Drizzle Orm

Get Started with Drizzle and MSSQL in existing project

src/content/docs/get-started/mssql-existing.mdx

latest2.6 KB
Original Source

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 CodeTabs from "@mdx/CodeTabs.astro"; import Prerequisites from "@mdx/Prerequisites.astro"; import IntrospectMSSQL from '@mdx/get-started/mssql/IntrospectMSSQL.mdx'; import FileStructure from '@mdx/get-started/FileStructure.mdx'; import InstallPackages from '@mdx/get-started/InstallPackages.mdx'; import SetupConfig from '@mdx/get-started/SetupConfig.mdx'; import SetupEnv from '@mdx/get-started/SetupEnv.mdx'; import TransferCode from '@mdx/get-started/TransferCode.mdx'; import ApplyChanges from '@mdx/get-started/ApplyChanges.mdx'; import RunFile from '@mdx/get-started/RunFile.mdx'; import ConnectMSSQL from '@mdx/get-started/mssql/ConnectMSSQL.mdx' import QueryDatabase from '@mdx/get-started/QueryDatabase.mdx'; import QueryDatabaseUpdated from '@mdx/get-started/QueryDatabaseUpdated.mdx'; import UpdateSchema from '@mdx/get-started/mssql/UpdateSchema.mdx';

<Breadcrumbs/>

Get Started with Drizzle and MSSQL in existing project

<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-mssql** - package for querying your MSSQL database - [read here](https://github.com/tediousjs/node-mssql) </Prerequisites> <FileStructure/>

Step 1 - Install mssql package

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

Step 2 - Setup connection variables

<SetupEnv env_variable='DATABASE_URL' />

Step 3 - Setup Drizzle config file

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

Step 4 - Introspect your database

<IntrospectMSSQL/>

Step 5 - Transfer code to your actual schema file

<TransferCode/>

Step 6 - Connect Drizzle ORM to the database

<ConnectMSSQL/>

Step 7 - Query the database

<QueryDatabase dialect='node-mssql' env_variable='DATABASE_URL'/>

Step 8 - Run index.ts file

<RunFile/>

Step 9 - Update your table schema (optional)

<UpdateSchema/>

Step 10 - Applying changes to the database (optional)

<ApplyChanges />

Step 11 - Query the database with a new field (optional)

<QueryDatabaseUpdated dialect='node-mssql' env_variable='DATABASE_URL' />