@empiricalrun/playwright-utils 0.52.0 → 0.53.0

package/docs/postgres.md

@@ -1,78 +0,0 @@
-# Postgres
-
-A PostgreSQL client for creating and managing temporary Neon databases in tests.
-
-## Fixture usage
-
-```ts
-test("example", async ({ page, postgres }) => {
-  // Get or create a database (cached via KV for 1 hour by default)
-  const { connectionUri } = await postgres.get("my-test-db");
-
-  // Run queries
-  const users = await postgres.query<{ id: number; name: string }>(
-    connectionUri,
-    "SELECT * FROM users",
-  );
-
-  // Execute multiple SQL statements
-  await postgres.execute(
-    connectionUri,
-    `
-    CREATE TABLE users (id SERIAL PRIMARY KEY, name TEXT);
-    INSERT INTO users (name) VALUES ('Alice');
-  `,
-  );
-
-  // Delete when done (optional - TTL will auto-expire)
-  await postgres.delete("my-test-db");
-});
-```
-
-## Standalone usage
-
-```ts
-import { PostgresClient } from "@empiricalrun/playwright-utils";
-
-const postgres = new PostgresClient();
-
-// Get or create a database
-const { projectId, connectionUri } = await postgres.get("my-db", {
-  pgVersion: 15,
-  ttl: 7200, // 2 hours
-});
-
-// Run a query
-const rows = await postgres.query(connectionUri, "SELECT NOW()");
-
-// Delete when done
-await postgres.delete("my-db");
-```
-
-## API
-
-### `postgres.get(name, options?)`
-
-Gets an existing database or creates a new one. Uses KV store to cache the connection.
-
-- `name` - Unique identifier for the database
-- `options.pgVersion` - PostgreSQL version (default: 15)
-- `options.ttl` - Cache TTL in seconds (default: 3600)
-
-Returns `{ projectId, connectionUri }`.
-
-### `postgres.delete(name)`
-
-Deletes the database and removes it from cache.
-
-### `postgres.query(connectionUri, sql)`
-
-Runs a SQL query and returns rows.
-
-### `postgres.execute(connectionUri, sql)`
-
-Executes multiple SQL statements separated by `;`.
-
-## Requirements
-
-- `EMPIRICALRUN_API_KEY` environment variable must be set