Skip to main content

​
Codex with Xata

Codex can inspect a repository, edit files, run shell commands, and verify changes. Xata gives Codex a safe Postgres branch to use while it implements features or fixes tests.

​
What Codex is good for with Xata

  • Implementing code changes that need a real Postgres database.
  • Running test suites against a branch-scoped connection string.
  • Updating SQL, ORM models, or migrations and validating them in one session.
  • Cleaning up generated changes before a pull request.

​
Quick start

  1. Install and authenticate the Xata CLI.
  1. Create a task branch.
  1. Export the branch connection string for the Codex session.
  1. Start Codex in the repository and include the database boundary in the prompt.
Use a branch per Codex task. For risky changes, start from anonymized production data so tests cover realistic relationships without exposing sensitive values. If the task needs API access, create a scoped key and remove it after the session.

​
Example prompts

  • “Use only the Postgres database in DATABASE_URL. Do not ask for or use production credentials.”
  • “Add the feature, update the database migration, and run tests against the Xata branch.”
  • “Use the Xata CLI docs in /cli/branch if you need to inspect branch state.”
  • “Before finishing, summarize schema changes, test commands, and any rows you inserted.”
  • “Clean up temporary data in this branch before reporting completion.”

​
Common workflows

​
Branch-per-task implementation

  1. Create a Xata branch named for the task.
  2. Export DATABASE_URL for that branch.
  3. Ask Codex to implement the code change.
  4. Ask Codex to run migrations and tests.
  5. Review the diff and branch state before merging.

​
Test failure investigation

  1. Reproduce the failing test against the task branch.
  2. Ask Codex to inspect the query, schema, and fixtures.
  3. Let Codex change application code or test setup.
  4. Keep data changes inside the temporary branch.

​
Tips

  • Put database boundaries in the first prompt.
  • Prefer branch-scoped API keys for automation work.
  • Ask Codex to show exact commands before destructive database operations.
  • Use branch cleanup automation for repeated team workflows.

​
Troubleshooting