Knex is a SQL query builder that works with a variety of SQL databases including Postgres and MySQL. This example shows you how to use Knex with Next.js to connect and query a Postgres database. The same code can also connect to all other databases supported by Knex.
Once you have access to the environment variables you'll need, deploy the example using Vercel:
Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example with-knex with-knex-appyarn create next-app --example with-knex with-knex-apppnpm create next-app --example with-knex with-knex-appnpm install
# or
yarnSet up a Postgres database locally or use a DBaaS provider such as AWS or Digital Ocean
Copy the .env.local.example file in this directory to .env.local (this will be ignored by Git):
cp .env.local.example .env.localSet the PG_URI variable in .env.local to the connection uri of your postgres database.
You can create, apply and rollback migrations using the scripts in package.json. For now we will run the example migrations in the knex/migrations folder, which will add some Todos to the database.
npm run migrate:latest
# or
yarn migrate:latestnpm run dev
# or
yarn devYour app should now be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.
You should now see a list of Todos that were fetched from the database via the API Route defined in /pages/api/todos.js.
You can deploy this app to the cloud with Vercel (Documentation).
To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.
Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.
Alternatively, you can deploy using our template by clicking on the Deploy button below.