DbClient

Defined in: packages/db/src/client.ts:348

Constructors#

Constructor#

new DbClient(options): DbClient;

Defined in: packages/db/src/client.ts:375

Parameters#

options#

DbClientOptions = {}

Returns#

DbClient

Accessors#

activeTransaction#

Get Signature#

get activeTransaction(): 
  | Transaction<Record<string, unknown>>
  | undefined;

Defined in: packages/db/src/client.ts:393

Returns#

| Transaction<Record<string, unknown>> | undefined

Methods#

_assertLiveQuerySources()#

_assertLiveQuerySources(queryHash, sources): void;

Defined in: packages/db/src/client.ts:831

Internal

Reject a local stream whose hash already names different sources.

Parameters#

queryHash#

string

sources#

readonly AnyCollection[]

Returns#

void

_bindLiveQueryObserver()#

_bindLiveQueryObserver<T, TKey>(
   collection, 
   queryHash, 
   suspendUntilReady, 
host): LiveQueryObserverClient<T, TKey>;

Defined in: packages/db/src/client.ts:729

Internal

Supply transport behavior without coupling ordinary observers to SSR.

Type Parameters#

T#

T extends object

TKey#

TKey extends string | number

Parameters#

collection#

Collection<T, TKey, any, StandardSchemaV1<unknown, unknown>, T> | null

queryHash#

string | undefined

suspendUntilReady#

boolean

host#

LiveQueryObserverClientHost<T, TKey>

Returns#

LiveQueryObserverClient<T, TKey>

_captureServerQuery()#

_captureServerQuery(
   queryHash, 
   snapshot, 
   sources?): void;

Defined in: packages/db/src/client.ts:861

Internal

Capture the first server view without starting acquisition.

Parameters#

queryHash#

string

snapshot#

DehydratedLiveQueryResult

sources?#

readonly AnyCollection[]

Returns#

void

_consumeLiveQueryResult()#

_consumeLiveQueryResult(queryHash, dehydratedAt): void;

Defined in: packages/db/src/client.ts:853

Internal

Parameters#

queryHash#

string

dehydratedAt#

number

Returns#

void

_failPendingLiveQueries()#

_failPendingLiveQueries(error): void;

Defined in: packages/db/src/client.ts:939

Internal

Parameters#

error#

unknown

Returns#

void

_getLiveQuery()#

_getLiveQuery(queryHash, forServerSnapshot): DbClientLiveQuery | undefined;

Defined in: packages/db/src/client.ts:820

Internal

Parameters#

queryHash#

string

forServerSnapshot#

boolean = false

Returns#

DbClientLiveQuery | undefined

_hasSsrCollectionSnapshot()#

_hasSsrCollectionSnapshot(collection): boolean;

Defined in: packages/db/src/client.ts:745

Internal

Normalized source transport carries rows, not readiness.

Parameters#

collection#

AnyCollection

Returns#

boolean

_isSsrServerCleanupEnabled()#

_isSsrServerCleanupEnabled(): boolean;

Defined in: packages/db/src/client.ts:815

Internal

Returns#

boolean

_isSsrStreamingEnabled()#

_isSsrStreamingEnabled(): boolean;

Defined in: packages/db/src/client.ts:805

Internal

Returns#

boolean

_materializeCollectionForRender()#

_materializeCollectionForRender<T, TKey, TSchema, TUtils>(options): Collection<T, TKey, TUtils, TSchema, [TSchema] extends [never] ? T : InferSchemaInput<TSchema>>;

Defined in: packages/db/src/client.ts:541

Internal

Type Parameters#

T#

T extends object

TKey#

TKey extends string | number

TSchema#

TSchema extends StandardSchemaV1<unknown, unknown>

TUtils#

TUtils extends UtilsRecord

Parameters#

options#

CollectionOptions<T, TKey, TSchema, TUtils>

Returns#

Collection<T, TKey, TUtils, TSchema, [TSchema] extends [never] ? T : InferSchemaInput<TSchema>>

_registerLiveQuery()#

_registerLiveQuery(
   queryHash, 
   promise, 
sources?): Promise<void>;

Defined in: packages/db/src/client.ts:894

Internal

Parameters#

queryHash#

string

promise#

Promise<DehydratedLiveQueryResult<object, string | number>>

sources?#

readonly AnyCollection[]

Returns#

Promise<void>

_registerLiveQueryResource()#

_registerLiveQueryResource(owner, cleanup): () => void;

Defined in: packages/db/src/client.ts:926

Internal

Parameters#

owner#

object

cleanup#

() => Promise<void>

Returns#

(): void;

Returns#

void

_setSsrServerCleanupEnabled()#

_setSsrServerCleanupEnabled(enabled): void;

Defined in: packages/db/src/client.ts:810

Internal

Parameters#

enabled#

boolean

Returns#

void

_setSsrStreamingEnabled()#

_setSsrStreamingEnabled(enabled): void;

Defined in: packages/db/src/client.ts:759

Internal

Parameters#

enabled#

boolean

Returns#

void

_waitForSsrLiveQuery()#

_waitForSsrLiveQuery(queryHash, forHydration): Promise<void> | undefined;

Defined in: packages/db/src/client.ts:775

Internal

Wait for transport without claiming or starting a local source.

Parameters#

queryHash#

string

forHydration#

boolean = false

Returns#

Promise<void> | undefined

applyCollectionChunk()#

applyCollectionChunk(chunk): void;

Defined in: packages/db/src/client.ts:719

Parameters#

chunk#

DehydratedCollectionChunk

Returns#

void

cleanup()#

cleanup(): Promise<void>;

Defined in: packages/db/src/client.ts:947

Returns#

Promise<void>

collection()#

Call Signature#

collection<T, TKey, TUtils>(options, materializeOptions?): Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & NonSingleResult;

Defined in: packages/db/src/client.ts:497

Type Parameters#

T#

T extends StandardSchemaV1<unknown, unknown>

TKey#

TKey extends string | number

TUtils#

TUtils extends UtilsRecord

Parameters#

options#

CollectionOptions<InferSchemaOutput<T>, TKey, T, TUtils> & NonSingleResult

materializeOptions?#

CollectionMaterializeOptions<InferSchemaInput<T>>

Returns#

Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & NonSingleResult

Call Signature#

collection<T, TKey, TUtils>(options, materializeOptions?): Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & SingleResult;

Defined in: packages/db/src/client.ts:507

Type Parameters#

T#

T extends StandardSchemaV1<unknown, unknown>

TKey#

TKey extends string | number

TUtils#

TUtils extends UtilsRecord

Parameters#

options#

CollectionOptions<InferSchemaOutput<T>, TKey, T, TUtils> & SingleResult

materializeOptions?#

CollectionMaterializeOptions<InferSchemaInput<T>>

Returns#

Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & SingleResult

Call Signature#

collection<T, TKey, TUtils>(options, materializeOptions?): Collection<T, TKey, TUtils, never, T> & NonSingleResult;

Defined in: packages/db/src/client.ts:517

Type Parameters#

T#

T extends object

TKey#

TKey extends string | number = string | number

TUtils#

TUtils extends UtilsRecord = UtilsRecord

Parameters#

options#

CollectionOptions<T, TKey, never, TUtils> & NonSingleResult

materializeOptions?#

CollectionMaterializeOptions<T>

Returns#

Collection<T, TKey, TUtils, never, T> & NonSingleResult

Call Signature#

collection<T, TKey, TUtils>(options, materializeOptions?): Collection<T, TKey, TUtils, never, T> & SingleResult;

Defined in: packages/db/src/client.ts:525

Type Parameters#

T#

T extends object

TKey#

TKey extends string | number = string | number

TUtils#

TUtils extends UtilsRecord = UtilsRecord

Parameters#

options#

CollectionOptions<T, TKey, never, TUtils> & SingleResult

materializeOptions?#

CollectionMaterializeOptions<T>

Returns#

Collection<T, TKey, TUtils, never, T> & SingleResult

createTransaction()#

createTransaction<T>(config): Transaction<T>;

Defined in: packages/db/src/client.ts:397

Type Parameters#

T#

T extends object = Record<string, unknown>

Parameters#

config#

TransactionConfig<T>

Returns#

Transaction<T>

dehydrate()#

dehydrate(options): DehydratedDbState;

Defined in: packages/db/src/client.ts:632

Parameters#

options#

DehydrateDbClientOptions = {}

Returns#

DehydratedDbState

getDependency()#

getDependency<T>(key): T | undefined;

Defined in: packages/db/src/client.ts:377

Type Parameters#

T#

T

Parameters#

key#

string

Returns#

T | undefined

hydrate()#

hydrate(state): void;

Defined in: packages/db/src/client.ts:700

Parameters#

state#

DehydratedDbState

Returns#

void

preloadLiveQuery()#

preloadLiveQuery(options): Promise<void>;

Defined in: packages/db/src/client.ts:403

Parameters#

options#

LiveQueryOptions

Returns#

Promise<void>

requireDependency()#

requireDependency<T>(key): T;

Defined in: packages/db/src/client.ts:381

Type Parameters#

T#

T

Parameters#

key#

string

Returns#

T

subscribe()#

subscribe(listener): () => void;

Defined in: packages/db/src/client.ts:723

Parameters#

listener#

(event) => void

Returns#

(): void;

Returns#

void