RawQueryOptions
Defined in: packages/client/src/index.ts:1959
The structured-clone-safe subset of pgwasm’s QueryOptions the inspection surface carries. Kept
narrow ON PURPOSE: on a worker-attached client the options object crosses the bridge via
postMessage, so function-valued options (parsers, serializers, onNotice) can never be part
of this contract. rowMode: "array" is what @pgxsinkit/pgwasm-repl asks for on every exec.
blob diverges from pgwasm’s own type for the same reason: pgwasm takes a Blob, which is neither
transferable nor (usefully) clonable, so this contract carries BYTES and wraps them into the Blob at
the pgwasm call (ADR-0061).
Properties
Section titled “Properties”
optionalblob?:Uint8Array<ArrayBuffer>
Defined in: packages/client/src/index.ts:1973
The bytes pgwasm reads when the statement is a COPY … FROM '/dev/blob' — the single-statement form
of RawStatement.blob, for a bulk load that needs no surrounding transaction. Build the
statement AND these bytes together with buildCopyFromBlobStatement; any other statement
ignores this option.
On a worker-attached client the buffer is TRANSFERRED, not copied: it is detached the moment the call dispatches, so the caller must NOT read or reuse it afterwards (build a fresh one per chunk).
Typed over a real ArrayBuffer (not the default ArrayBufferLike) because that IS the contract: a
SharedArrayBuffer-backed view can neither be transferred nor read as a Blob part.
rowMode?
Section titled “rowMode?”
optionalrowMode?:"object"|"array"
Defined in: packages/client/src/index.ts:1960