DbClient

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

Constructors

Constructor

new DbClient(options): DbClient;

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

Parameters

options

DbClientOptions = {}

Returns

DbClient

Accessors

activeTransaction

Get Signature

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

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

Returns

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

Methods

_consumeLiveQueryResult()

_consumeLiveQueryResult(queryHash, dehydratedAt): void;

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

Internal

Parameters

queryHash

string

dehydratedAt

number

Returns

void

_failPendingLiveQueries()

_failPendingLiveQueries(error): void;

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

Internal

Parameters

error

unknown

Returns

void

_getLiveQuery()

_getLiveQuery(queryHash): DbClientLiveQuery | undefined;

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

Internal

Parameters

queryHash

string

Returns

DbClientLiveQuery | undefined

_isSsrServerCleanupEnabled()

_isSsrServerCleanupEnabled(): boolean;

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

Internal

Returns

boolean

_isSsrStreamingEnabled()

_isSsrStreamingEnabled(): boolean;

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

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:442

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): Promise<void>;

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

Internal

Parameters

queryHash

string

promise

Promise<DehydratedLiveQueryResult<object, string | number>>

Returns

Promise<void>

_registerLiveQueryResource()

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

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

Internal

Parameters

owner

object

cleanup

() => Promise<void>

Returns

(): void;

Returns

void

_setSsrServerCleanupEnabled()

_setSsrServerCleanupEnabled(enabled): void;

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

Internal

Parameters

enabled

boolean

Returns

void

_setSsrStreamingEnabled()

_setSsrStreamingEnabled(enabled): void;

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

Internal

Parameters

enabled

boolean

Returns

void

applyCollectionChunk()

applyCollectionChunk(chunk): void;

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

Parameters

chunk

DehydratedCollectionChunk

Returns

void

cleanup()

cleanup(): Promise<void>;

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

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:398

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:408

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:418

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:426

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:356

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:532

Parameters

options

DehydrateDbClientOptions = {}

Returns

DehydratedDbState

getDependency()

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

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

Type Parameters

T

T

Parameters

key

string

Returns

T | undefined

hydrate()

hydrate(state): void;

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

Parameters

state

DehydratedDbState

Returns

void

preloadLiveQuery()

preloadLiveQuery(options): Promise<void>;

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

Parameters

options

LiveQueryOptions

Returns

Promise<void>

requireDependency()

requireDependency<T>(key): T;

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

Type Parameters

T

T

Parameters

key

string

Returns

T

subscribe()

subscribe(listener): () => void;

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

Parameters

listener

(event) => void

Returns

(): void;

Returns

void