Skip to content

Conversation

@pyramation
Copy link
Contributor

Summary

Adds documentation for the createEphemeralDb function to the pgsql-client README. This function creates temporary PostgreSQL databases with unique UUID-based names, useful for testing, code generation, and CI pipelines.

The documentation covers:

  • Basic usage example
  • Configuration options (prefix, extensions, baseConfig, verbose)
  • Return value description (name, config, admin, teardown)
  • Common use cases

Review & Testing Checklist for Human

  • Verify API accuracy — Compare the documented API against postgres/pgsql-client/src/ephemeral.ts to ensure options and return values match the implementation
  • Test the example — Run the basic usage example to confirm it works as documented

Notes

Link to Devin run: https://app.devin.ai/sessions/5edec0c962d04ee9bd15efc58ca2a050
Requested by: @pyramation

@devin-ai-integration
Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation merged commit 1b6ccc2 into main Jan 24, 2026
50 checks passed
@pyramation pyramation deleted the devin/1769256527-pgsql-client-ephemeral-docs branch January 24, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants