| name | effect-facet-unstable-sql-sqlclient |
| description | Guidance for facet `effect/unstable/sql/SqlClient` focused on APIs like make, MakeOptions, and makeWithTransaction. Load after `effect-skill-router` when this facet is the primary owner. |
Effect Facet unstable/sql/SqlClient
Owned scope
- Owns only
effect/unstable/sql/SqlClient.
- Parent module:
effect/unstable/sql.
- Source anchor:
packages/effect/src/unstable/sql/SqlClient.ts.
What it is for
- Module-specific APIs and usage patterns for Effect programs.
API quick reference
make
MakeOptions
makeWithTransaction
SqlClient
SafeIntegers
TransactionConnection
- Full API list:
references/api-reference.md
How to use it
- Start with constructor-style APIs to build values/services before composing operations.
- Keep runtime/execute APIs at edges; compose pure transformations before execution.
- Assume unstable APIs can evolve quickly; isolate usage behind thin local adapters.
Starter example
import { SqlClient } from "effect/unstable/sql/SqlClient";
const value = SqlClient.make();
Common pitfalls
- Unstable module contracts may change; avoid coupling core app logic directly to experimental details.
- Prefer explicit, typed combinators over ad-hoc casting or unchecked assumptions.
Not covered here
- Sibling facets under the same parent are out of scope:
effect-facet-unstable-sql-migrator (effect/unstable/sql/Migrator)
effect-facet-unstable-sql-sqlconnection (effect/unstable/sql/SqlConnection)
effect-facet-unstable-sql-sqlerror (effect/unstable/sql/SqlError)
effect-facet-unstable-sql-sqlmodel (effect/unstable/sql/SqlModel)
effect-facet-unstable-sql-sqlresolver (effect/unstable/sql/SqlResolver)
effect-facet-unstable-sql-sqlschema (effect/unstable/sql/SqlSchema)
effect-facet-unstable-sql-sqlstream (effect/unstable/sql/SqlStream)
effect-facet-unstable-sql-statement (effect/unstable/sql/Statement)
- Parent module ownership belongs to
effect-module-unstable-sql.
Escalate to
effect-module-unstable-sql for parent module-wide workflows.
effect-skill-router for cross-module routing and ownership checks.
Reference anchors
- Facet source:
packages/effect/src/unstable/sql/SqlClient.ts
- Parent tests:
packages/effect/test/unstable/sql/SqlSchema.test.ts
- API details:
references/api-reference.md
- Usage notes:
references/usage-reference.md
- Ownership mapping:
references/owner.md