클래스: DbClient

정의 위치: packages/db/src/client.ts:308

생성자

생성자

new DbClient(options): DbClient;

정의 위치: packages/db/src/client.ts:326

매개변수

options

DbClientOptions = {}

반환값

DbClient

접근자

activeTransaction

가져오기 시그니처

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

정의 위치: packages/db/src/client.ts:342

반환값

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

메서드

_consumeLiveQueryResult()

_consumeLiveQueryResult(queryHash, dehydratedAt): void;

정의 위치: packages/db/src/client.ts:635

Internal

매개변수

queryHash

string

dehydratedAt

number

반환값

void

---

_failPendingLiveQueries()

_failPendingLiveQueries(error): void;

정의 위치: packages/db/src/client.ts:678

Internal

매개변수

error

unknown

반환값

void

---

_getLiveQuery()

_getLiveQuery(queryHash): DbClientLiveQuery | undefined;

정의 위치: packages/db/src/client.ts:630

Internal

매개변수

queryHash

string

반환값

DbClientLiveQuery | undefined

---

_isSsrServerCleanupEnabled()

_isSsrServerCleanupEnabled(): boolean;

정의 위치: packages/db/src/client.ts:625

Internal

반환값

boolean

---

_isSsrStreamingEnabled()

_isSsrStreamingEnabled(): boolean;

정의 위치: packages/db/src/client.ts:615

Internal

반환값

boolean

---

_materializeCollectionForRender()

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

정의 위치: packages/db/src/client.ts:432

Internal

타입 매개변수

T

T extends object

TKey

TKey extends string | number

TSchema

TSchema extends StandardSchemaV1<unknown, unknown>

TUtils

TUtils extends UtilsRecord

매개변수

options

CollectionOptions<T, TKey, TSchema, TUtils>

반환값

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

---

_registerLiveQuery()

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

정의 위치: packages/db/src/client.ts:643

Internal

매개변수

queryHash

string

promise

Promise<DehydratedLiveQueryResult<object, string | number>>

반환값

Promise<void>

---

_registerLiveQueryResource()

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

정의 위치: packages/db/src/client.ts:665

Internal

매개변수

소유자

object

정리

() => Promise<void>

반환값

(): void;

반환값

void

---

_setSsrServerCleanupEnabled()

_setSsrServerCleanupEnabled(enabled): void;

정의 위치: packages/db/src/client.ts:620

Internal

매개변수

활성화됨

boolean

반환값

void

---

_setSsrStreamingEnabled()

_setSsrStreamingEnabled(enabled): void;

정의 위치: packages/db/src/client.ts:610

Internal

매개변수

활성화됨

boolean

반환값

void

---

applyCollectionChunk()

applyCollectionChunk(chunk): void;

정의 위치: packages/db/src/client.ts:600

매개변수

청크

DehydratedCollectionChunk

반환값

void

---

cleanup()

cleanup(): Promise<void>;

정의 위치: packages/db/src/client.ts:685

반환값

Promise<void>

---

collection()

호출 시그니처

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

정의 위치: packages/db/src/client.ts:388

타입 매개변수

T

T extends StandardSchemaV1<unknown, unknown>

TKey

TKey extends string | number

TUtils

TUtils extends UtilsRecord

매개변수

옵션

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

materializeOptions?

CollectionMaterializeOptions<InferSchemaInput<T>>

반환값

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

호출 시그니처

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

정의 위치: packages/db/src/client.ts:398

타입 매개변수

T

T extends StandardSchemaV1<unknown, unknown>

TKey

TKey extends string | number

TUtils

TUtils extends UtilsRecord

매개변수

옵션

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

materializeOptions?

CollectionMaterializeOptions<InferSchemaInput<T>>

반환값

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

호출 시그니처

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

정의 위치: packages/db/src/client.ts:408

타입 매개변수

T

T extends object

TKey

TKey extends string | number = string | number

TUtils

TUtils extends UtilsRecord = UtilsRecord

매개변수

옵션

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

materializeOptions?

CollectionMaterializeOptions<T>

반환값

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

호출 시그니처

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

정의 위치: packages/db/src/client.ts:416

타입 매개변수

T

T extends object

TKey

TKey extends string | number = string | number

TUtils

TUtils extends UtilsRecord = UtilsRecord

매개변수

옵션

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

materializeOptions?

CollectionMaterializeOptions<T>

반환값

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

---

createTransaction()

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

정의 위치: packages/db/src/client.ts:346

타입 매개변수

T

T extends object = Record<string, unknown>

매개변수

config

TransactionConfig<T>

반환값

Transaction<T>

---

dehydrate()

dehydrate(options): DehydratedDbState;

정의 위치: packages/db/src/client.ts:521

매개변수

options

DehydrateDbClientOptions = {}

반환값

DehydratedDbState

---

getDependency()

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

정의 위치: packages/db/src/client.ts:328

타입 매개변수

T

T

매개변수

key

string

반환값

T | undefined

---

hydrate()

hydrate(state): void;

정의 위치: packages/db/src/client.ts:582

매개변수

상태

DehydratedDbState

반환값

void

---

preloadLiveQuery()

preloadLiveQuery(options): Promise<void>;

정의 위치: packages/db/src/client.ts:352

매개변수

options

LiveQueryOptions

반환값

Promise<void>

---

requireDependency()

requireDependency<T>(key): T;

정의 위치: packages/db/src/client.ts:332

타입 매개변수

T

T

매개변수

key

string

반환값

T

---

subscribe()

subscribe(listener): () => void;

정의 위치: packages/db/src/client.ts:604

매개변수

리스너

(event) => void

반환값

(): void;

반환값

void