effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/unstable/sql/SqlClient.js

@@ -1,4 +1,25 @@
 /**
+ * Defines the `SqlClient` service, the central runtime entry point for Effect's
+ * unstable SQL support.
+ *
+ * A `SqlClient` combines the tagged-template statement constructor with a
+ * scoped connection acquirer, dialect compiler, tracing attributes, optional row
+ * transforms, reactive query helpers, and transaction management. Applications
+ * typically consume it from `Context` to build parameterized queries, stream
+ * rows, run raw driver operations, reserve a connection for lower-level work, or
+ * wrap several query effects in `withTransaction`.
+ *
+ * Transactions are tracked through a per-client context service. Top-level
+ * transactions acquire the configured transaction connection and issue the
+ * dialect's begin/commit/rollback SQL; nested transactions reuse that
+ * connection and rely on dialect-provided savepoint SQL. A query only joins a
+ * transaction when it is run with the same client service, so avoid mixing
+ * clients or manually reserved connections when atomicity matters. Dialect
+ * integrations are also responsible for the compiler and transaction
+ * statements, which means placeholder syntax, identifier escaping, row
+ * transforms, savepoint support, and unprepared/raw statement behavior can
+ * differ by database.
+ *
  * @since 4.0.0
  */
 import { Clock } from "../../Clock.js";
@@ -13,12 +34,18 @@ import { Reactivity } from "../reactivity/Reactivity.js";
 import * as Statement from "./Statement.js";
 const TypeId = "~effect/sql/SqlClient";
 /**
+ * Context service tag for the `SqlClient` service.
+ *
  * @category models
  * @since 4.0.0
  */
 export const SqlClient = /*#__PURE__*/Context.Service("effect/sql/SqlClient");
 let clientIdCounter = 0;
 /**
+ * Constructs a `SqlClient` from connection acquirers, a compiler, transaction
+ * commands, tracing attributes, optional row transforms, and reactive query
+ * integration.
+ *
  * @category constructors
  * @since 4.0.0
  */
@@ -71,8 +98,12 @@ export const make = /*#__PURE__*/Effect.fnUntraced(function* (options) {
   return client;
 });
 /**
- * @since 4.0.0
+ * Builds a transaction wrapper that begins top-level transactions, uses
+ * savepoints for nested transactions, commits on success, and rolls back on
+ * failure or interruption.
+ *
  * @category transactions
+ * @since 4.0.0
  */
 export const makeWithTransaction = options => effect => {
   return Effect.uninterruptibleMask(restore => Effect.useSpan("sql.transaction", {
@@ -106,10 +137,18 @@ export const makeWithTransaction = options => effect => {
   })));
 };
 /**
+ * Creates a unique context service tag for the active transaction connection of
+ * a specific SQL client.
+ *
+ * @category tags
  * @since 4.0.0
  */
 export const TransactionConnection = clientId => Context.Service(`effect/sql/SqlClient/TransactionConnection/${clientId}`);
 /**
+ * Context reference used by SQL integrations to opt in to safe integer
+ * handling; defaults to `false`.
+ *
+ * @category references
  * @since 4.0.0
  */
 export const SafeIntegers = /*#__PURE__*/Context.Reference("effect/sql/SqlClient/SafeIntegers", {

package/dist/unstable/sql/SqlClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"SqlClient.js","names":["Clock","Context","Effect","Exit","Option","Scope","Stream","Tracer","Reactivity","Statement","TypeId","SqlClient","Service","clientIdCounter","make","fnUntraced","options","transactionService","TransactionConnection","getConnection","flatMap","serviceOption","match","onNone","acquirer","onSome","conn","succeed","beginTransaction","commit","savepoint","name","rollback","rollbackSavepoint","transactionAcquirer","withTransaction","makeWithTransaction","spanAttributes","acquireConnection","scope","map","provide","begin","executeUnprepared","undefined","id","reactivity","client","Object","assign","compiler","transformRows","safe","reserve","withoutTransforms","statement","withoutTransform","reactive","reactiveQueue","keys","effect","pipe","fromQueue","unwrap","stream","reactiveMailbox","query","uninterruptibleMask","restore","useSpan","kind","span","withFiber","fiber","key","value","attribute","services","context","clock","getRef","connOption","getOption","_tag","provideContext","mutate","add","ParentSpan","exit","isSuccess","event","currentTimeNanosUnsafe","orDie","void","withScope","ensuring","close","clientId","SafeIntegers","Reference","defaultValue"],"sources":["../../../src/unstable/sql/SqlClient.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,SAASA,KAAK,QAAQ,gBAAgB;AACtC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAGzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,SAASC,UAAU,QAAQ,6BAA6B;AAIxD,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C,MAAMC,MAAM,GAAG,uBAAuB;AAoDtC;;;;AAIA,OAAO,MAAMC,SAAS,gBAAGV,OAAO,CAACW,OAAO,CAAY,sBAAsB,CAAC;AA8B3E,IAAIC,eAAe,GAAG,CAAC;AAEvB;;;;AAIA,OAAO,MAAMC,IAAI,gBAAGZ,MAAM,CAACa,UAAU,CAAC,WAAUC,OAA8B;EAC5E,MAAMC,kBAAkB,GAAGD,OAAO,CAACC,kBAAkB,IAAIC,qBAAqB,CAACL,eAAe,EAAE,CAAC;EACjG,MAAMM,aAAa,GAAGjB,MAAM,CAACkB,OAAO,CAClClB,MAAM,CAACmB,aAAa,CAACJ,kBAAkB,CAAC,EACxCb,MAAM,CAACkB,KAAK,CAAC;IACXC,MAAM,EAAEA,CAAA,KAAMP,OAAO,CAACQ,QAAQ;IAC9BC,MAAM,EAAEA,CAAC,CAACC,IAAI,CAAC,KAAKxB,MAAM,CAACyB,OAAO,CAACD,IAAI;GACxC,CAAC,CACH;EAED,MAAME,gBAAgB,GAAGZ,OAAO,CAACY,gBAAgB,IAAI,OAAO;EAC5D,MAAMC,MAAM,GAAGb,OAAO,CAACa,MAAM,IAAI,QAAQ;EACzC,MAAMC,SAAS,GAAGd,OAAO,CAACc,SAAS,KAAMC,IAAY,IAAK,aAAaA,IAAI,EAAE,CAAC;EAC9E,MAAMC,QAAQ,GAAGhB,OAAO,CAACgB,QAAQ,IAAI,UAAU;EAC/C,MAAMC,iBAAiB,GAAGjB,OAAO,CAACiB,iBAAiB,KAAMF,IAAY,IAAK,yBAAyBA,IAAI,EAAE,CAAC;EAC1G,MAAMG,mBAAmB,GAAGlB,OAAO,CAACkB,mBAAmB,IAAIlB,OAAO,CAACQ,QAAQ;EAC3E,MAAMW,eAAe,GAAGC,mBAAmB,CAAC;IAC1CnB,kBAAkB;IAClBoB,cAAc,EAAErB,OAAO,CAACqB,cAAc;IACtCC,iBAAiB,EAAEpC,MAAM,CAACkB,OAAO,CAC/Bf,KAAK,CAACS,IAAI,EAAE,EACXyB,KAAK,IAAKrC,MAAM,CAACsC,GAAG,CAACnC,KAAK,CAACoC,OAAO,CAACP,mBAAoB,EAAEK,KAAK,CAAC,EAAGb,IAAI,IAAK,CAACa,KAAK,EAAEb,IAAI,CAAU,CAAC,CACpG;IACDgB,KAAK,EAAGhB,IAAI,IAAKA,IAAI,CAACiB,iBAAiB,CAACf,gBAAgB,EAAE,EAAE,EAAEgB,SAAS,CAAC;IACxEd,SAAS,EAAEA,CAACJ,IAAI,EAAEmB,EAAE,KAAKnB,IAAI,CAACiB,iBAAiB,CAACb,SAAS,CAAC,cAAce,EAAE,EAAE,CAAC,EAAE,EAAE,EAAED,SAAS,CAAC;IAC7Ff,MAAM,EAAGH,IAAI,IAAKA,IAAI,CAACiB,iBAAiB,CAACd,MAAM,EAAE,EAAE,EAAEe,SAAS,CAAC;IAC/DZ,QAAQ,EAAGN,IAAI,IAAKA,IAAI,CAACiB,iBAAiB,CAACX,QAAQ,EAAE,EAAE,EAAEY,SAAS,CAAC;IACnEX,iBAAiB,EAAEA,CAACP,IAAI,EAAEmB,EAAE,KAAKnB,IAAI,CAACiB,iBAAiB,CAACV,iBAAiB,CAAC,cAAcY,EAAE,EAAE,CAAC,EAAE,EAAE,EAAED,SAAS;GAC7G,CAAC;EAEF,MAAME,UAAU,GAAG,OAAOtC,UAAU;EACpC,MAAMuC,MAAM,GAAcC,MAAM,CAACC,MAAM,CACrCxC,SAAS,CAACK,IAAI,CAACK,aAAa,EAAEH,OAAO,CAACkC,QAAQ,EAAElC,OAAO,CAACqB,cAAc,EAAErB,OAAO,CAACmC,aAAa,CAAC,EAC9F;IACE,CAACzC,MAAM,GAAGA,MAAuB;IACjC0C,IAAI,EAAER,SAAgB;IACtBT,eAAe;IACflB,kBAAkB;IAClBoC,OAAO,EAAEnB,mBAAmB;IAC5BoB,iBAAiBA,CAAA;MACf,IAAItC,OAAO,CAACmC,aAAa,KAAKP,SAAS,EAAE;QACvC,OAAO,IAAI;MACb;MACA,MAAMW,SAAS,GAAG9C,SAAS,CAACK,IAAI,CAC9BK,aAAa,EACbH,OAAO,CAACkC,QAAQ,CAACM,gBAAgB,EACjCxC,OAAO,CAACqB,cAAc,EACtBO,SAAS,CACV;MACD,MAAMG,MAAM,GAAGC,MAAM,CAACC,MAAM,CAACM,SAAS,EAAE;QACtC,GAAG,IAAI;QACP,GAAGA;OACJ,CAAC;MACAR,MAAc,CAACK,IAAI,GAAGL,MAAM;MAC5BA,MAAc,CAACO,iBAAiB,GAAG,MAAMP,MAAM;MACjD,OAAOA,MAAM;IACf,CAAC;IACDU,QAAQ,EAAEzC,OAAO,CAAC0C,aAAa,GAC7B,CACEC,IAA6E,EAC7EC,MAA8B,KAE9B5C,OAAO,CAAC0C,aAAc,CAACC,IAAI,EAAEC,MAAM,CAAC,CAACC,IAAI,CACvC3D,MAAM,CAACsC,GAAG,CAAClC,MAAM,CAACwD,SAAS,CAAC,EAC5BxD,MAAM,CAACyD,MAAM,CACd,GACHjB,UAAU,CAACkB,MAAM;IACnBC,eAAe,EAAEjD,OAAO,CAAC0C,aAAa,IAAIZ,UAAU,CAACoB;GACtD,CACF;EACCnB,MAAc,CAACK,IAAI,GAAGL,MAAM;EAE9B,OAAOA,MAAM;AACf,CAAC,CAAC;AAEF;;;;AAIA,OAAO,MAAMX,mBAAmB,GAAUpB,OASzC,IACS4C,MAA8B,IAAuC;EAC7E,OAAO1D,MAAM,CAACiE,mBAAmB,CAAEC,OAAO,IACxClE,MAAM,CAACmE,OAAO,CACZ,iBAAiB,EACjB;IAAEC,IAAI,EAAE;EAAQ,CAAE,EACjBC,IAAI,IACHrE,MAAM,CAACsE,SAAS,CAAsBC,KAAK,IAAI;IAC7C,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAI3D,OAAO,CAACqB,cAAc,EAAE;MACjDkC,IAAI,CAACK,SAAS,CAACF,GAAG,EAAEC,KAAK,CAAC;IAC5B;IACA,MAAME,QAAQ,GAAGJ,KAAK,CAACK,OAAO;IAC9B,MAAMC,KAAK,GAAGN,KAAK,CAACO,MAAM,CAAChF,KAAK,CAAC;IACjC,MAAMiF,UAAU,GAAGhF,OAAO,CAACiF,SAAS,CAACL,QAAQ,EAAE7D,OAAO,CAACC,kBAAkB,CAAC;IAC1E,MAAMS,IAAI,GAAGuD,UAAU,CAACE,IAAI,KAAK,MAAM,GACnCjF,MAAM,CAACyB,OAAO,CAAC,CAACiB,SAAS,EAAEqC,UAAU,CAACN,KAAK,CAAC,CAAC,CAAC,CAAU,CAAC,GACzD3D,OAAO,CAACsB,iBAAiB;IAC7B,MAAMO,EAAE,GAAGoC,UAAU,CAACE,IAAI,KAAK,MAAM,GAAGF,UAAU,CAACN,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACnE,OAAOzE,MAAM,CAACkB,OAAO,CACnBM,IAAI,EACJ,CACE,CAACa,KAAK,EAAEb,IAAI,CAAC,KAEb,CAACmB,EAAE,KAAK,CAAC,GAAG7B,OAAO,CAAC0B,KAAK,CAAChB,IAAI,CAAC,GAAGV,OAAO,CAACc,SAAS,CAACJ,IAAI,EAAEmB,EAAE,CAAC,EAAEgB,IAAI,CACjE3D,MAAM,CAACkB,OAAO,CAAC,MACblB,MAAM,CAACkF,cAAc,CACnBhB,OAAO,CAACR,MAAM,CAAC,EACf3D,OAAO,CAACoF,MAAM,CAACR,QAAQ,EAAGA,QAAQ,IAChCA,QAAQ,CAAChB,IAAI,CACX5D,OAAO,CAACqF,GAAG,CAACtE,OAAO,CAACC,kBAAkB,EAAE,CAACS,IAAI,EAAEmB,EAAE,CAAC,CAAC,EACnD5C,OAAO,CAACqF,GAAG,CAAC/E,MAAM,CAACgF,UAAU,EAAEhB,IAAI,CAAC,CACrC,CAAC,CACL,CACF,EACDrE,MAAM,CAACsF,IAAI,EACXtF,MAAM,CAACkB,OAAO,CAAEoE,IAAI,IAAI;MACtB,IAAI5B,MAA2B;MAC/B,IAAIzD,IAAI,CAACsF,SAAS,CAACD,IAAI,CAAC,EAAE;QACxB,IAAI3C,EAAE,KAAK,CAAC,EAAE;UACZ0B,IAAI,CAACmB,KAAK,CAAC,uBAAuB,EAAEX,KAAK,CAACY,sBAAsB,EAAE,CAAC;UACnE/B,MAAM,GAAG1D,MAAM,CAAC0F,KAAK,CAAC5E,OAAO,CAACa,MAAM,CAACH,IAAI,CAAC,CAAC;QAC7C,CAAC,MAAM;UACL6C,IAAI,CAACmB,KAAK,CAAC,0BAA0B,EAAEX,KAAK,CAACY,sBAAsB,EAAE,CAAC;UACtE/B,MAAM,GAAG1D,MAAM,CAAC2F,IAAI;QACtB;MACF,CAAC,MAAM;QACLtB,IAAI,CAACmB,KAAK,CAAC,yBAAyB,EAAEX,KAAK,CAACY,sBAAsB,EAAE,CAAC;QACrE/B,MAAM,GAAG1D,MAAM,CAAC0F,KAAK,CACnB/C,EAAE,GAAG,CAAC,GACF7B,OAAO,CAACiB,iBAAiB,CAACP,IAAI,EAAEmB,EAAE,CAAC,GACnC7B,OAAO,CAACgB,QAAQ,CAACN,IAAI,CAAC,CAC3B;MACH;MACA,MAAMoE,SAAS,GAAGvD,KAAK,KAAKK,SAAS,GAAG1C,MAAM,CAAC6F,QAAQ,CAACnC,MAAM,EAAEvD,KAAK,CAAC2F,KAAK,CAACzD,KAAK,EAAEiD,IAAI,CAAC,CAAC,GAAG5B,MAAM;MAClG,OAAO1D,MAAM,CAACkB,OAAO,CAAC0E,SAAS,EAAE,MAAMN,IAAI,CAAC;IAC9C,CAAC,CAAC,CACH,CACJ;EACH,CAAC,CAAC,CACL,CACF;AACH,CAAC;AAmBD;;;AAGA,OAAO,MAAMtE,qBAAqB,GAChC+E,QAAgB,IAEhBhG,OAAO,CAACW,OAAO,CAAC,8CAA8CqF,QAAQ,EAAE,CAAC;AAE3E;;;AAGA,OAAO,MAAMC,YAAY,gBAAGjG,OAAO,CAACkG,SAAS,CAAU,mCAAmC,EAAE;EAC1FC,YAAY,EAAEA,CAAA,KAAM;CACrB,CAAC","ignoreList":[]}
+{"version":3,"file":"SqlClient.js","names":["Clock","Context","Effect","Exit","Option","Scope","Stream","Tracer","Reactivity","Statement","TypeId","SqlClient","Service","clientIdCounter","make","fnUntraced","options","transactionService","TransactionConnection","getConnection","flatMap","serviceOption","match","onNone","acquirer","onSome","conn","succeed","beginTransaction","commit","savepoint","name","rollback","rollbackSavepoint","transactionAcquirer","withTransaction","makeWithTransaction","spanAttributes","acquireConnection","scope","map","provide","begin","executeUnprepared","undefined","id","reactivity","client","Object","assign","compiler","transformRows","safe","reserve","withoutTransforms","statement","withoutTransform","reactive","reactiveQueue","keys","effect","pipe","fromQueue","unwrap","stream","reactiveMailbox","query","uninterruptibleMask","restore","useSpan","kind","span","withFiber","fiber","key","value","attribute","services","context","clock","getRef","connOption","getOption","_tag","provideContext","mutate","add","ParentSpan","exit","isSuccess","event","currentTimeNanosUnsafe","orDie","void","withScope","ensuring","close","clientId","SafeIntegers","Reference","defaultValue"],"sources":["../../../src/unstable/sql/SqlClient.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,SAASA,KAAK,QAAQ,gBAAgB;AACtC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAGzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,SAASC,UAAU,QAAQ,6BAA6B;AAIxD,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C,MAAMC,MAAM,GAAG,uBAAuB;AAuDtC;;;;;;AAMA,OAAO,MAAMC,SAAS,gBAAGV,OAAO,CAACW,OAAO,CAAY,sBAAsB,CAAC;AAmC3E,IAAIC,eAAe,GAAG,CAAC;AAEvB;;;;;;;;AAQA,OAAO,MAAMC,IAAI,gBAAGZ,MAAM,CAACa,UAAU,CAAC,WAAUC,OAA8B;EAC5E,MAAMC,kBAAkB,GAAGD,OAAO,CAACC,kBAAkB,IAAIC,qBAAqB,CAACL,eAAe,EAAE,CAAC;EACjG,MAAMM,aAAa,GAAGjB,MAAM,CAACkB,OAAO,CAClClB,MAAM,CAACmB,aAAa,CAACJ,kBAAkB,CAAC,EACxCb,MAAM,CAACkB,KAAK,CAAC;IACXC,MAAM,EAAEA,CAAA,KAAMP,OAAO,CAACQ,QAAQ;IAC9BC,MAAM,EAAEA,CAAC,CAACC,IAAI,CAAC,KAAKxB,MAAM,CAACyB,OAAO,CAACD,IAAI;GACxC,CAAC,CACH;EAED,MAAME,gBAAgB,GAAGZ,OAAO,CAACY,gBAAgB,IAAI,OAAO;EAC5D,MAAMC,MAAM,GAAGb,OAAO,CAACa,MAAM,IAAI,QAAQ;EACzC,MAAMC,SAAS,GAAGd,OAAO,CAACc,SAAS,KAAMC,IAAY,IAAK,aAAaA,IAAI,EAAE,CAAC;EAC9E,MAAMC,QAAQ,GAAGhB,OAAO,CAACgB,QAAQ,IAAI,UAAU;EAC/C,MAAMC,iBAAiB,GAAGjB,OAAO,CAACiB,iBAAiB,KAAMF,IAAY,IAAK,yBAAyBA,IAAI,EAAE,CAAC;EAC1G,MAAMG,mBAAmB,GAAGlB,OAAO,CAACkB,mBAAmB,IAAIlB,OAAO,CAACQ,QAAQ;EAC3E,MAAMW,eAAe,GAAGC,mBAAmB,CAAC;IAC1CnB,kBAAkB;IAClBoB,cAAc,EAAErB,OAAO,CAACqB,cAAc;IACtCC,iBAAiB,EAAEpC,MAAM,CAACkB,OAAO,CAC/Bf,KAAK,CAACS,IAAI,EAAE,EACXyB,KAAK,IAAKrC,MAAM,CAACsC,GAAG,CAACnC,KAAK,CAACoC,OAAO,CAACP,mBAAoB,EAAEK,KAAK,CAAC,EAAGb,IAAI,IAAK,CAACa,KAAK,EAAEb,IAAI,CAAU,CAAC,CACpG;IACDgB,KAAK,EAAGhB,IAAI,IAAKA,IAAI,CAACiB,iBAAiB,CAACf,gBAAgB,EAAE,EAAE,EAAEgB,SAAS,CAAC;IACxEd,SAAS,EAAEA,CAACJ,IAAI,EAAEmB,EAAE,KAAKnB,IAAI,CAACiB,iBAAiB,CAACb,SAAS,CAAC,cAAce,EAAE,EAAE,CAAC,EAAE,EAAE,EAAED,SAAS,CAAC;IAC7Ff,MAAM,EAAGH,IAAI,IAAKA,IAAI,CAACiB,iBAAiB,CAACd,MAAM,EAAE,EAAE,EAAEe,SAAS,CAAC;IAC/DZ,QAAQ,EAAGN,IAAI,IAAKA,IAAI,CAACiB,iBAAiB,CAACX,QAAQ,EAAE,EAAE,EAAEY,SAAS,CAAC;IACnEX,iBAAiB,EAAEA,CAACP,IAAI,EAAEmB,EAAE,KAAKnB,IAAI,CAACiB,iBAAiB,CAACV,iBAAiB,CAAC,cAAcY,EAAE,EAAE,CAAC,EAAE,EAAE,EAAED,SAAS;GAC7G,CAAC;EAEF,MAAME,UAAU,GAAG,OAAOtC,UAAU;EACpC,MAAMuC,MAAM,GAAcC,MAAM,CAACC,MAAM,CACrCxC,SAAS,CAACK,IAAI,CAACK,aAAa,EAAEH,OAAO,CAACkC,QAAQ,EAAElC,OAAO,CAACqB,cAAc,EAAErB,OAAO,CAACmC,aAAa,CAAC,EAC9F;IACE,CAACzC,MAAM,GAAGA,MAAuB;IACjC0C,IAAI,EAAER,SAAgB;IACtBT,eAAe;IACflB,kBAAkB;IAClBoC,OAAO,EAAEnB,mBAAmB;IAC5BoB,iBAAiBA,CAAA;MACf,IAAItC,OAAO,CAACmC,aAAa,KAAKP,SAAS,EAAE;QACvC,OAAO,IAAI;MACb;MACA,MAAMW,SAAS,GAAG9C,SAAS,CAACK,IAAI,CAC9BK,aAAa,EACbH,OAAO,CAACkC,QAAQ,CAACM,gBAAgB,EACjCxC,OAAO,CAACqB,cAAc,EACtBO,SAAS,CACV;MACD,MAAMG,MAAM,GAAGC,MAAM,CAACC,MAAM,CAACM,SAAS,EAAE;QACtC,GAAG,IAAI;QACP,GAAGA;OACJ,CAAC;MACAR,MAAc,CAACK,IAAI,GAAGL,MAAM;MAC5BA,MAAc,CAACO,iBAAiB,GAAG,MAAMP,MAAM;MACjD,OAAOA,MAAM;IACf,CAAC;IACDU,QAAQ,EAAEzC,OAAO,CAAC0C,aAAa,GAC7B,CACEC,IAA6E,EAC7EC,MAA8B,KAE9B5C,OAAO,CAAC0C,aAAc,CAACC,IAAI,EAAEC,MAAM,CAAC,CAACC,IAAI,CACvC3D,MAAM,CAACsC,GAAG,CAAClC,MAAM,CAACwD,SAAS,CAAC,EAC5BxD,MAAM,CAACyD,MAAM,CACd,GACHjB,UAAU,CAACkB,MAAM;IACnBC,eAAe,EAAEjD,OAAO,CAAC0C,aAAa,IAAIZ,UAAU,CAACoB;GACtD,CACF;EACCnB,MAAc,CAACK,IAAI,GAAGL,MAAM;EAE9B,OAAOA,MAAM;AACf,CAAC,CAAC;AAEF;;;;;;;;AAQA,OAAO,MAAMX,mBAAmB,GAAUpB,OASzC,IACS4C,MAA8B,IAAuC;EAC7E,OAAO1D,MAAM,CAACiE,mBAAmB,CAAEC,OAAO,IACxClE,MAAM,CAACmE,OAAO,CACZ,iBAAiB,EACjB;IAAEC,IAAI,EAAE;EAAQ,CAAE,EACjBC,IAAI,IACHrE,MAAM,CAACsE,SAAS,CAAsBC,KAAK,IAAI;IAC7C,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAI3D,OAAO,CAACqB,cAAc,EAAE;MACjDkC,IAAI,CAACK,SAAS,CAACF,GAAG,EAAEC,KAAK,CAAC;IAC5B;IACA,MAAME,QAAQ,GAAGJ,KAAK,CAACK,OAAO;IAC9B,MAAMC,KAAK,GAAGN,KAAK,CAACO,MAAM,CAAChF,KAAK,CAAC;IACjC,MAAMiF,UAAU,GAAGhF,OAAO,CAACiF,SAAS,CAACL,QAAQ,EAAE7D,OAAO,CAACC,kBAAkB,CAAC;IAC1E,MAAMS,IAAI,GAAGuD,UAAU,CAACE,IAAI,KAAK,MAAM,GACnCjF,MAAM,CAACyB,OAAO,CAAC,CAACiB,SAAS,EAAEqC,UAAU,CAACN,KAAK,CAAC,CAAC,CAAC,CAAU,CAAC,GACzD3D,OAAO,CAACsB,iBAAiB;IAC7B,MAAMO,EAAE,GAAGoC,UAAU,CAACE,IAAI,KAAK,MAAM,GAAGF,UAAU,CAACN,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACnE,OAAOzE,MAAM,CAACkB,OAAO,CACnBM,IAAI,EACJ,CACE,CAACa,KAAK,EAAEb,IAAI,CAAC,KAEb,CAACmB,EAAE,KAAK,CAAC,GAAG7B,OAAO,CAAC0B,KAAK,CAAChB,IAAI,CAAC,GAAGV,OAAO,CAACc,SAAS,CAACJ,IAAI,EAAEmB,EAAE,CAAC,EAAEgB,IAAI,CACjE3D,MAAM,CAACkB,OAAO,CAAC,MACblB,MAAM,CAACkF,cAAc,CACnBhB,OAAO,CAACR,MAAM,CAAC,EACf3D,OAAO,CAACoF,MAAM,CAACR,QAAQ,EAAGA,QAAQ,IAChCA,QAAQ,CAAChB,IAAI,CACX5D,OAAO,CAACqF,GAAG,CAACtE,OAAO,CAACC,kBAAkB,EAAE,CAACS,IAAI,EAAEmB,EAAE,CAAC,CAAC,EACnD5C,OAAO,CAACqF,GAAG,CAAC/E,MAAM,CAACgF,UAAU,EAAEhB,IAAI,CAAC,CACrC,CAAC,CACL,CACF,EACDrE,MAAM,CAACsF,IAAI,EACXtF,MAAM,CAACkB,OAAO,CAAEoE,IAAI,IAAI;MACtB,IAAI5B,MAA2B;MAC/B,IAAIzD,IAAI,CAACsF,SAAS,CAACD,IAAI,CAAC,EAAE;QACxB,IAAI3C,EAAE,KAAK,CAAC,EAAE;UACZ0B,IAAI,CAACmB,KAAK,CAAC,uBAAuB,EAAEX,KAAK,CAACY,sBAAsB,EAAE,CAAC;UACnE/B,MAAM,GAAG1D,MAAM,CAAC0F,KAAK,CAAC5E,OAAO,CAACa,MAAM,CAACH,IAAI,CAAC,CAAC;QAC7C,CAAC,MAAM;UACL6C,IAAI,CAACmB,KAAK,CAAC,0BAA0B,EAAEX,KAAK,CAACY,sBAAsB,EAAE,CAAC;UACtE/B,MAAM,GAAG1D,MAAM,CAAC2F,IAAI;QACtB;MACF,CAAC,MAAM;QACLtB,IAAI,CAACmB,KAAK,CAAC,yBAAyB,EAAEX,KAAK,CAACY,sBAAsB,EAAE,CAAC;QACrE/B,MAAM,GAAG1D,MAAM,CAAC0F,KAAK,CACnB/C,EAAE,GAAG,CAAC,GACF7B,OAAO,CAACiB,iBAAiB,CAACP,IAAI,EAAEmB,EAAE,CAAC,GACnC7B,OAAO,CAACgB,QAAQ,CAACN,IAAI,CAAC,CAC3B;MACH;MACA,MAAMoE,SAAS,GAAGvD,KAAK,KAAKK,SAAS,GAAG1C,MAAM,CAAC6F,QAAQ,CAACnC,MAAM,EAAEvD,KAAK,CAAC2F,KAAK,CAACzD,KAAK,EAAEiD,IAAI,CAAC,CAAC,GAAG5B,MAAM;MAClG,OAAO1D,MAAM,CAACkB,OAAO,CAAC0E,SAAS,EAAE,MAAMN,IAAI,CAAC;IAC9C,CAAC,CAAC,CACH,CACJ;EACH,CAAC,CAAC,CACL,CACF;AACH,CAAC;AA6BD;;;;;;;AAOA,OAAO,MAAMtE,qBAAqB,GAChC+E,QAAgB,IAEhBhG,OAAO,CAACW,OAAO,CAAC,8CAA8CqF,QAAQ,EAAE,CAAC;AAE3E;;;;;;;AAOA,OAAO,MAAMC,YAAY,gBAAGjG,OAAO,CAACkG,SAAS,CAAU,mCAAmC,EAAE;EAC1FC,YAAY,EAAEA,CAAA,KAAM;CACrB,CAAC","ignoreList":[]}

package/dist/unstable/sql/SqlConnection.d.ts

@@ -1,4 +1,24 @@
 /**
+ * Defines the low-level SQL connection service and shared row/acquirer types
+ * used by Effect's unstable SQL driver integrations.
+ *
+ * A `Connection` is the driver-facing layer underneath `SqlClient`: it executes
+ * already-compiled SQL with positional parameters and exposes transformed row
+ * results, raw driver results, streams, value arrays, and unprepared statement
+ * execution. Most applications should work through `SqlClient`, while driver
+ * integrations and advanced code use this module to provide scoped connection
+ * acquisition, implement pooling, reserve a connection for a workflow, or adapt
+ * a dialect-specific client into Effect.
+ *
+ * Connections are resources and should be acquired through an `Acquirer` in a
+ * `Scope` so pool checkout, transaction pinning, and release semantics are
+ * preserved. Transaction coordination lives at the `SqlClient` layer, so mixing
+ * manually reserved connections with transactional client queries can bypass the
+ * expected atomic boundary. Raw, unprepared, streaming, parameter, and row
+ * transformation behavior ultimately comes from the driver and dialect; check
+ * each integration for differences in placeholders, prepared statement support,
+ * cursor lifetime, and result shapes.
+ *
  * @since 4.0.0
  */
 import * as Context from "../../Context.ts";
@@ -7,7 +27,11 @@ import type { Scope } from "../../Scope.ts";
 import type { Stream } from "../../Stream.ts";
 import type { SqlError } from "./SqlError.ts";
 /**
- * @category model
+ * Low-level SQL driver connection capable of executing compiled SQL as
+ * transformed rows, raw results, streams, value arrays, or unprepared
+ * statements.
+ *
+ * @category models
  * @since 4.0.0
  */
 export interface Connection {
@@ -22,17 +46,24 @@ export interface Connection {
     readonly executeUnprepared: (sql: string, params: ReadonlyArray<unknown>, transformRows: (<A extends object>(row: ReadonlyArray<A>) => ReadonlyArray<A>) | undefined) => Effect<ReadonlyArray<any>, SqlError>;
 }
 /**
- * @category model
+ * Scoped effect that acquires a `Connection`, may fail with `SqlError`, and
+ * requires a `Scope` for release.
+ *
+ * @category models
  * @since 4.0.0
  */
 export type Acquirer = Effect<Connection, SqlError, Scope>;
 /**
+ * Context service tag for a low-level SQL `Connection`.
+ *
  * @category tag
  * @since 4.0.0
  */
 export declare const Connection: Context.Service<Connection, Connection>;
 /**
- * @category model
+ * Generic SQL row shape mapping column names to unknown values.
+ *
+ * @category models
  * @since 4.0.0
  */
 export type Row = {

package/dist/unstable/sql/SqlConnection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SqlConnection.d.ts","sourceRoot":"","sources":["../../../src/unstable/sql/SqlConnection.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAE7C;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,CAChB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAC9B,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,KACvF,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAA;IAEzC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,CACnB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,KAC3B,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAE9B,QAAQ,CAAC,aAAa,EAAE,CACtB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAC9B,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,KACvF,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IAE1B,QAAQ,CAAC,aAAa,EAAE,CACtB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,KAC3B,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;IAE5D,QAAQ,CAAC,iBAAiB,EAAE,CAC1B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAC9B,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,KACvF,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAA;CAC1C;AAED;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;AAE1D;;;GAGG;AACH,eAAO,MAAM,UAAU,yCAA0D,CAAA;AAEjF;;;GAGG;AACH,MAAM,MAAM,GAAG,GAAG;IAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAA"}
+{"version":3,"file":"SqlConnection.d.ts","sourceRoot":"","sources":["../../../src/unstable/sql/SqlConnection.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,CAChB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAC9B,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,KACvF,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAA;IAEzC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,CACnB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,KAC3B,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAE9B,QAAQ,CAAC,aAAa,EAAE,CACtB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAC9B,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,KACvF,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IAE1B,QAAQ,CAAC,aAAa,EAAE,CACtB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,KAC3B,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;IAE5D,QAAQ,CAAC,iBAAiB,EAAE,CAC1B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAC9B,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,KACvF,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAA;CAC1C;AAED;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,UAAU,yCAA0D,CAAA;AAEjF;;;;;GAKG;AACH,MAAM,MAAM,GAAG,GAAG;IAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAA"}

package/dist/unstable/sql/SqlConnection.js

@@ -1,8 +1,30 @@
 /**
+ * Defines the low-level SQL connection service and shared row/acquirer types
+ * used by Effect's unstable SQL driver integrations.
+ *
+ * A `Connection` is the driver-facing layer underneath `SqlClient`: it executes
+ * already-compiled SQL with positional parameters and exposes transformed row
+ * results, raw driver results, streams, value arrays, and unprepared statement
+ * execution. Most applications should work through `SqlClient`, while driver
+ * integrations and advanced code use this module to provide scoped connection
+ * acquisition, implement pooling, reserve a connection for a workflow, or adapt
+ * a dialect-specific client into Effect.
+ *
+ * Connections are resources and should be acquired through an `Acquirer` in a
+ * `Scope` so pool checkout, transaction pinning, and release semantics are
+ * preserved. Transaction coordination lives at the `SqlClient` layer, so mixing
+ * manually reserved connections with transactional client queries can bypass the
+ * expected atomic boundary. Raw, unprepared, streaming, parameter, and row
+ * transformation behavior ultimately comes from the driver and dialect; check
+ * each integration for differences in placeholders, prepared statement support,
+ * cursor lifetime, and result shapes.
+ *
  * @since 4.0.0
  */
 import * as Context from "../../Context.js";
 /**
+ * Context service tag for a low-level SQL `Connection`.
+ *
  * @category tag
  * @since 4.0.0
  */

package/dist/unstable/sql/SqlConnection.js.map

@@ -1 +1 @@
-{"version":3,"file":"SqlConnection.js","names":["Context","Connection","Service"],"sources":["../../../src/unstable/sql/SqlConnection.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAkD3C;;;;AAIA,OAAO,MAAMC,UAAU,gBAAGD,OAAO,CAACE,OAAO,CAAa,0BAA0B,CAAC","ignoreList":[]}
+{"version":3,"file":"SqlConnection.js","names":["Context","Connection","Service"],"sources":["../../../src/unstable/sql/SqlConnection.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAyD3C;;;;;;AAMA,OAAO,MAAMC,UAAU,gBAAGD,OAAO,CAACE,OAAO,CAAa,0BAA0B,CAAC","ignoreList":[]}

package/dist/unstable/sql/SqlError.d.ts

@@ -7,14 +7,21 @@ declare const ConnectionError_base: Schema.Class<ConnectionError, Schema.TaggedS
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for connection or open failures; marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class ConnectionError extends ConnectionError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -25,14 +32,22 @@ declare const AuthenticationError_base: Schema.Class<AuthenticationError, Schema
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for authentication failures such as invalid credentials; not
+ * marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class AuthenticationError extends AuthenticationError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -43,14 +58,22 @@ declare const AuthorizationError_base: Schema.Class<AuthorizationError, Schema.T
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for authorization or permission failures; not marked
+ * retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class AuthorizationError extends AuthorizationError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -61,14 +84,21 @@ declare const SqlSyntaxError_base: Schema.Class<SqlSyntaxError, Schema.TaggedStr
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for invalid SQL syntax; not marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class SqlSyntaxError extends SqlSyntaxError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -80,14 +110,22 @@ declare const UniqueViolation_base: Schema.Class<UniqueViolation, Schema.TaggedS
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for a unique constraint violation, including the violated
+ * constraint identifier; not marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class UniqueViolation extends UniqueViolation_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -98,14 +136,21 @@ declare const ConstraintError_base: Schema.Class<ConstraintError, Schema.TaggedS
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for a non-unique constraint violation; not marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class ConstraintError extends ConstraintError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -116,14 +161,21 @@ declare const DeadlockError_base: Schema.Class<DeadlockError, Schema.TaggedStruc
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for a database deadlock; marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class DeadlockError extends DeadlockError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -134,14 +186,22 @@ declare const SerializationError_base: Schema.Class<SerializationError, Schema.T
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for a transaction serialization or isolation conflict;
+ * marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class SerializationError extends SerializationError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -152,14 +212,22 @@ declare const LockTimeoutError_base: Schema.Class<LockTimeoutError, Schema.Tagge
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for timing out while waiting on a database lock; marked
+ * retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class LockTimeoutError extends LockTimeoutError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -170,14 +238,21 @@ declare const StatementTimeoutError_base: Schema.Class<StatementTimeoutError, Sc
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for a statement or query timeout; marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class StatementTimeoutError extends StatementTimeoutError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
@@ -188,23 +263,37 @@ declare const UnknownError_base: Schema.Class<UnknownError, Schema.TaggedStruct<
     operation: Schema.optional<Schema.String>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * SQL error reason for an unclassified database failure; not marked retryable.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class UnknownError extends UnknownError_base {
     /**
+     * Marks this value as a structured SQL error reason for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [ReasonTypeId]: "~effect/sql/SqlError/Reason";
     /**
+     * Indicates whether retrying the failed SQL operation may succeed.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
 }
 /**
+ * Union of structured SQL error reasons, each carrying the original cause plus
+ * optional message and operation metadata.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export type SqlErrorReason = ConnectionError | AuthenticationError | AuthorizationError | SqlSyntaxError | UniqueViolation | ConstraintError | DeadlockError | SerializationError | LockTimeoutError | StatementTimeoutError | UnknownError;
 /**
+ * Schema union for encoding and decoding `SqlErrorReason` values.
+ *
+ * @category schemas
  * @since 4.0.0
  */
 export declare const SqlErrorReason: Schema.Union<[
@@ -224,31 +313,49 @@ declare const SqlError_base: Schema.Class<SqlError, Schema.TaggedStruct<"SqlErro
     readonly reason: Schema.Union<[typeof ConnectionError, typeof AuthenticationError, typeof AuthorizationError, typeof SqlSyntaxError, typeof UniqueViolation, typeof ConstraintError, typeof DeadlockError, typeof SerializationError, typeof LockTimeoutError, typeof StatementTimeoutError, typeof UnknownError]>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * Top-level SQL error wrapper whose `message`, `cause`, and `isRetryable`
+ * values are derived from its `SqlErrorReason`.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class SqlError extends SqlError_base {
     /**
+     * Marks this value as the top-level SQL error wrapper for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [TypeId]: "~effect/sql/SqlError";
     /**
+     * Exposes the structured SQL reason as the JavaScript error cause.
+     *
      * @since 4.0.0
      */
     readonly cause: ConnectionError | AuthenticationError | AuthorizationError | SqlSyntaxError | UniqueViolation | ConstraintError | DeadlockError | SerializationError | LockTimeoutError | StatementTimeoutError | UnknownError;
     /**
+     * Uses the reason message when present, otherwise falls back to the reason tag.
+     *
      * @since 4.0.0
      */
     get message(): string;
     /**
+     * Delegates retryability to the underlying SQL error reason.
+     *
      * @since 4.0.0
      */
     get isRetryable(): boolean;
 }
 /**
+ * Returns `true` when a value is a `SqlError`.
+ *
+ * @category guards
  * @since 4.0.0
  */
 export declare const isSqlError: (u: unknown) => u is SqlError;
 /**
+ * Returns `true` when a value is a `SqlErrorReason`.
+ *
+ * @category guards
  * @since 4.0.0
  */
 export declare const isSqlErrorReason: (u: unknown) => u is SqlErrorReason;
@@ -257,6 +364,10 @@ type SqliteClassifyOptions = {
     readonly operation?: string | undefined;
 };
 /**
+ * Classifies a native SQLite error cause into a `SqlErrorReason` using its
+ * `code` or `errno`, with optional message and operation metadata.
+ *
+ * @category converting
  * @since 4.0.0
  */
 export declare const classifySqliteError: (cause: unknown, { message, operation }?: SqliteClassifyOptions) => SqlErrorReason;
@@ -265,10 +376,16 @@ declare const ResultLengthMismatch_base: Schema.Class<ResultLengthMismatch, Sche
     readonly actual: Schema.Number;
 }>, import("../../Cause.ts").YieldableError>;
 /**
+ * Error raised when an ordered batched SQL resolver receives a different number
+ * of result rows than requests.
+ *
+ * @category errors
  * @since 4.0.0
  */
 export declare class ResultLengthMismatch extends ResultLengthMismatch_base {
     /**
+     * Explains the mismatch between expected and actual batched SQL result counts.
+     *
      * @since 4.0.0
      */
     get message(): string;

package/dist/unstable/sql/SqlError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SqlError.d.ts","sourceRoot":"","sources":["../../../src/unstable/sql/SqlError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,QAAA,MAAM,MAAM,EAAG,sBAA+B,CAAA;AAC9C,QAAA,MAAM,YAAY,EAAG,6BAAsC,CAAA;;;;;;AAQ3D;;GAEG;AACH,qBAAa,eAAgB,SAAQ,oBAGpC;IACC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,wBAEH;IACpC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,uBAEH;IACnC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,mBAGnC;IACC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;;AAOD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,oBAGpC;IACC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,oBAGpC;IACC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,kBAGlC;IACC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,uBAEH;IACnC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,qBAGrC;IACC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,0BAEH;IACtC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,iBAGjC;IACC;;OAEG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,eAAe,GACf,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,eAAe,GACf,aAAa,GACb,kBAAkB,GAClB,gBAAgB,GAChB,qBAAqB,GACrB,YAAY,CAAA;AAEhB;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,KAAK,CAAC;IACxC,OAAO,eAAe;IACtB,OAAO,mBAAmB;IAC1B,OAAO,kBAAkB;IACzB,OAAO,cAAc;IACrB,OAAO,eAAe;IACtB,OAAO,eAAe;IACtB,OAAO,aAAa;IACpB,OAAO,kBAAkB;IACzB,OAAO,gBAAgB;IACvB,OAAO,qBAAqB;IAC5B,OAAO,YAAY;CACpB,CAYC,CAAA;;;;AAEF;;GAEG;AACH,qBAAa,QAAS,SAAQ,aAE5B;IACA;;OAEG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,yBAAS;IAE1B;;OAEG;IACH,SAAkB,KAAK,iNAAc;IAErC;;OAEG;IACH,IAAa,OAAO,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,QAA4C,CAAA;AAEzF;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,cAAwD,CAAA;AAE3G,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACxC,CAAA;AAgED;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,OAAO,EACd,yBAAwB,qBAA0B,KACjD,cAmDF,CAAA;;;;;AAED;;GAEG;AACH,qBAAa,oBACX,SAAQ,yBAGN;IAEF;;OAEG;IACH,IAAa,OAAO,WAEnB;CACF"}
+{"version":3,"file":"SqlError.d.ts","sourceRoot":"","sources":["../../../src/unstable/sql/SqlError.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,QAAA,MAAM,MAAM,EAAG,sBAA+B,CAAA;AAC9C,QAAA,MAAM,YAAY,EAAG,6BAAsC,CAAA;;;;;;AAQ3D;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,oBAGpC;IACC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;;GAMG;AACH,qBAAa,mBAAoB,SAAQ,wBAEH;IACpC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;;GAMG;AACH,qBAAa,kBAAmB,SAAQ,uBAEH;IACnC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,mBAGnC;IACC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;;AAOD;;;;;;GAMG;AACH,qBAAa,eAAgB,SAAQ,oBAGpC;IACC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,oBAGpC;IACC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,kBAGlC;IACC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;;GAMG;AACH,qBAAa,kBAAmB,SAAQ,uBAEH;IACnC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,qBAGrC;IACC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,0BAEH;IACtC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;;;;;;AAED;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,iBAGjC;IACC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,gCAAe;IAEtC;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GACtB,eAAe,GACf,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,eAAe,GACf,aAAa,GACb,kBAAkB,GAClB,gBAAgB,GAChB,qBAAqB,GACrB,YAAY,CAAA;AAEhB;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,KAAK,CAAC;IACxC,OAAO,eAAe;IACtB,OAAO,mBAAmB;IAC1B,OAAO,kBAAkB;IACzB,OAAO,cAAc;IACrB,OAAO,eAAe;IACtB,OAAO,eAAe;IACtB,OAAO,aAAa;IACpB,OAAO,kBAAkB;IACzB,OAAO,gBAAgB;IACvB,OAAO,qBAAqB;IAC5B,OAAO,YAAY;CACpB,CAYC,CAAA;;;;AAEF;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,aAE5B;IACA;;;;OAIG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,yBAAS;IAE1B;;;;OAIG;IACH,SAAkB,KAAK,iNAAc;IAErC;;;;OAIG;IACH,IAAa,OAAO,IAAI,MAAM,CAE7B;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,QAA4C,CAAA;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,cAAwD,CAAA;AAE3G,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACxC,CAAA;AAgED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,OAAO,EACd,yBAAwB,qBAA0B,KACjD,cAmDF,CAAA;;;;;AAED;;;;;;GAMG;AACH,qBAAa,oBACX,SAAQ,yBAGN;IAEF;;;;OAIG;IACH,IAAa,OAAO,WAEnB;CACF"}