Skip to main content

​
Cursor with Xata

Cursor works well for multi-file edits, background agents, and database-aware application changes. Use a Xata branch as the database target for Composer and agent sessions.

​
What Cursor is good for with Xata

  • Updating ORM models, queries, and migrations together.
  • Testing a feature against an isolated branch from inside the IDE terminal.
  • Reviewing generated code and SQL before it leaves your editor.
  • Running background agents without giving them production database credentials.

​
Quick start

  1. Create a Xata branch for the task.
  1. Put the branch URL in .env.local.
  1. Open the project in Cursor.
  2. Ask Composer or a background agent to use the connection string from .env.local.
Keep a separate branch for each Cursor task or background agent. If Cursor needs to generate migrations, ask it to apply them only to the task branch and show the SQL or migration file before you merge.

​
Example prompts

  • “Use the Xata branch connection string in .env.local for all database work.”
  • “Update the Drizzle or Prisma schema and run the app against this branch.”
  • “Generate the migration, apply it to the branch, and show me the SQL before I merge.”
  • “Create a pull request summary that includes database changes and test output.”
  • “Do not edit production environment variables.”

​
Common workflows

​
Composer with a branch URL

  1. Create a branch for the feature.
  2. Add the branch connection string to .env.local.
  3. Ask Composer to implement the feature.
  4. Run the app and tests from Cursor’s terminal.
  5. Review generated schema and data changes.

​
Background agent for pull requests

  1. Create a task branch in Xata.
  2. Include the branch URL in the agent instructions.
  3. Ask the agent to keep database changes isolated.
  4. Review every migration and environment change before merging.

​
Tips

  • Keep .env.local out of commits.
  • Prefer branch names that match the issue or pull request.
  • Ask Cursor to explain generated SQL in plain language.
  • Link Cursor to Instant Branching when prompting for database safety.

​
Troubleshooting