본문으로 건너뛰기

인터페이스: LiveQueryCollectionConfig<TContext, TResult>

정의 위치: packages/db/src/query/live/types.ts:65

라이브 쿼리 컬렉션 옵션을 위한 구성 인터페이스입니다.

예제​

const config: LiveQueryCollectionConfig<any, any> = {
  // id is optional - will auto-generate "live-query-1", "live-query-2", etc.
  query: (q) => q
    .from({ comment: commentsCollection })
    .join(
      { user: usersCollection },
      ({ comment, user }) => eq(comment.user_id, user.id)
    )
    .where(({ comment }) => eq(comment.active, true))
    .select(({ comment, user }) => ({
      id: comment.id,
      content: comment.content,
      authorName: user.name,
    })),
  // getKey is optional - defaults to using stream key
  getKey: (item) => item.id,
}

타입 매개변수​

TContext​

TContext extends Context

TResult​

TResult extends object = RootQueryResult&lt;TContext>

속성​

defaultStringCollation?​

optional defaultStringCollation: StringCollationConfig;

정의 위치: packages/db/src/query/live/types.ts:121

문자열 정렬을 위한 선택적 비교 옵션입니다. 제공되면 FROM 컬렉션에서 상속하는 대신 이 옵션이 사용됩니다.

gcTime?​

optional gcTime: number;

정의 위치: packages/db/src/query/live/types.ts:110

컬렉션의 GC 시간입니다.

getKey()?​

optional getKey: (item) => string | number;

정의 위치: packages/db/src/query/live/types.ts:88

결과 항목에서 키를 추출하는 함수입니다. 제공되지 않으면 D2 스트림의 키를 사용하는 것이 기본값입니다.

매개변수​

item​

TResult

반환값​

string | number

id?​

optional id: string;

정의 위치: packages/db/src/query/live/types.ts:73

컬렉션의 고유 식별자입니다. 제공되지 않으면 자동 증가 숫자가 포함된 live-query-${number}으로 기본 설정됩니다.

onDelete?​

optional onDelete: DeleteMutationFn<TResult, string | number, UtilsRecord, any>;

정의 위치: packages/db/src/query/live/types.ts:100

onInsert?​

optional onInsert: InsertMutationFn<TResult, string | number, UtilsRecord, any>;

정의 위치: packages/db/src/query/live/types.ts:98

선택적 뮤테이션 핸들러입니다.

onUpdate?​

optional onUpdate: UpdateMutationFn<TResult, string | number, UtilsRecord, any>;

정의 위치: packages/db/src/query/live/types.ts:99

query​

query: 
  | (q) => QueryBuilder<TContext> & RootObjectResultConstraint<TContext>
| QueryBuilder<TContext> & RootObjectResultConstraint<TContext>;

정의 위치: packages/db/src/query/live/types.ts:78

라이브 쿼리를 정의하는 쿼리 빌더 함수입니다.

schema?​

optional schema: undefined;

정의 위치: packages/db/src/query/live/types.ts:93

검증을 위한 선택적 스키마입니다.

singleResult?​

optional singleResult: true;

정의 위치: packages/db/src/query/live/types.ts:115

활성화하면 컬렉션은 배열 대신 단일 객체를 반환합니다.

startSync?​

optional startSync: boolean;

정의 위치: packages/db/src/query/live/types.ts:105

동기화/쿼리를 즉시 시작합니다.