MongoDBCollection<T>클래스

MongoDB database에 있는 원격 문서 collection입니다.

유형 매개변수

생성자

생성자

속성

컬렉션 이름 데이터베이스 이름 함수 서비스이름

접근자

이름

방법

집계 카운트 deleteMany 하나삭제 찾기 하나 찾기 하나 찾기및삭제 하나 찾기 및 바꾸기 찾기및업데이트 insertMany 1 삽입 updateMany 업데이트 1 시계

생성자

생성자

속성

Private Readonly 컬렉션 이름

컬렉션 이름: any

Readonly 데이터베이스 이름

데이터베이스 이름: 문자열

Private 함수

함수: any

Readonly 서비스이름

서비스이름: 문자열

접근자

이름

  • 이름 가져오기 (): 문자열

  • 컬렉션의 이름입니다.

    문자열반환

방법

집계

  • 집계(파이프라인): Promise<알 수 없음>

  • 이 collection에 대해 집계 프레임워크 파이프라인을 실행합니다.

    매개변수

    Promise<알 수 없음>반환

    애그리게이션 결과로 확인되는 promise입니다.

카운트

  • 카운트(필터?, 옵션?): Promise<number>

  • 이 collection에서 제공된 필터와 일치하는 문서 수를 계산합니다.

    참고: 필터 없이 이를 호출하면 컬렉션의 메타데이터를 기반으로 결과를 반환하므로 문서 수가 정확하지 않을 수 있으며, 이로 인해 대략적인 개수가 나올 수 있습니다. 특히 다음과 같습니다.

    • 샤딩된 클러스터에서는 결과 개수가 고아 문서를 제대로 필터링하지 못합니다.
    • 비정상 종료 또는 파일 복사 기반 초기 동기화 후에는 개수가 정확하지 않을 수 있습니다.

    매개변수

    • Optional 필터: 필터

      결과의 범위를 좁히기 위해 적용되는 선택적 필터입니다.

    • Optional options: CountOptions

      적용할 추가 옵션입니다.

    Promise<숫자>반환

    필터와 일치하는 문서 수로 확인되는 promise입니다.

deleteMany

  • deleteMany(필터?): Promise<DeleteResult>

  • 여러 문서를 삭제합니다.

    매개변수

    • Optional 필터: 필터

      결과의 범위를 좁히기 위해 적용된 필터입니다. 생략하면 기본값은 collection의 모든 문서를 삭제하는 {} 입니다.

    Promise<DeleteResult>반환

    삭제된 문서 수(deletedCount)를 포함하는 객체로 확인되는 프로미스입니다.

하나삭제

  • 하나삭제(필터?): Promise<DeleteResult>

  • collection에서 일치하는 단일 문서를 삭제합니다.

    매개변수

    • Optional 필터: 필터

      결과의 범위를 좁히기 위해 적용된 필터입니다.

    Promise<DeleteResult>반환

    삭제된 문서 수(deletedCount)를 포함하는 객체로 확인되는 프로미스입니다.

찾기

  • 찾기(필터?, 옵션?): Promise<T[]>

  • 제공된 쿼리와 일치하는 문서를 찾습니다.

    매개변수

    • Optional 필터: 필터

      결과의 범위를 좁히기 위해 적용되는 선택적 필터입니다.

    • Optional options: FindOptions

      적용할 추가 옵션입니다.

    Promise<T[]>반환

    발견된 문서로 확인되는 promise입니다.

하나 찾기

  • 하나 찾기(필터?, 옵션?): Promise<null | T>

  • 제공된 필터와 일치하는 문서를 찾습니다.

    매개변수

    • Optional 필터: 필터

      결과의 범위를 좁히기 위해 적용된 필터입니다.

    • Optional options: FindOneOptions

      적용할 추가 옵션입니다.

    Promise < null | T >

    발견된 문서로 확인되는 promise입니다.

하나 찾기및삭제

  • 하나 찾기및삭제(필터?, 옵션?): Promise<null | T>

  • 제공된 필터와 일치하는 문서를 찾아 삭제합니다.

    매개변수

    • Optional 필터: 필터

      결과의 범위를 좁히기 위해 적용된 필터입니다.

    • Optional options: FindOneOptions

      적용할 추가 옵션입니다.

    Promise < null | T >

    삭제되기 전에 발견된 문서로 확인되는 promise입니다.

하나찾기 및 바꾸기

  • 하나찾기 및 바꾸기(필터, 교체, 옵션?): Promise<null | T>

  • 제공된 필터와 일치하는 문서를 찾아 새 문서로 바꿉니다.

    매개변수

    • 필터: 필터

      결과의 범위를 좁히기 위해 적용된 필터입니다.

    • 대체: 알 수 없음

      새 대체 문서입니다.

    • Optional options: FindOneAndModifyOptions

      적용할 추가 옵션입니다.

    Promise < null | T >

    교체 전에 발견된 문서로 해석되는 프로미스(Promise)입니다.

찾기및업데이트

  • 찾기및업데이트(필터, 업데이트, 옵션?): Promise<null | T>

  • 제공된 쿼리와 일치하는 문서를 찾고 개별 필드에 원하는 업데이트를 수행합니다.

    매개변수

    Promise < null | T >

    업데이트를 적용하기 전에 발견된 문서로 확인되는 프로미스입니다.

insertMany

  • insertMany(문서): Promise<InsertManyResult<t["_id"]>>

  • collection에 문서 배열을 삽입합니다. 식별자가 누락된 값이 있으면 서버에서 해당 값을 생성합니다.

    매개변수

    • 문서: NewDocument<T>[]

      삽입할 문서의 배열입니다.

    Promise<InsertManyResult<T["_id"]>를 반환합니다.

    삽입된 ID 배열(insertedIds)을 포함하는 객체로 확인되는 프로미스입니다.

1 삽입

  • 1 삽입(문서): Promise<InsertOneResult<t["_id"]>>

  • 단일 문서를 collection에 삽입합니다. 참고: 문서에 _id가 누락된 경우 서버에서 해당 문서에 대해 생성합니다.

    매개변수

    Promise<InsertOneResult<T["_id"]>를 반환합니다.

    삽입된 객체 ID(insertedId)가 포함된 객체를 확인하는 프로미스입니다.

updateMany

  • updateMany(필터, 업데이트, 옵션?): Promise<UpdateResult<T["_id"]>>

  • 이 collection에 제공된 필터와 일치하는 여러 문서를 업데이트합니다.

    매개변수

    • 필터: 필터

      결과의 범위를 좁히기 위해 적용된 필터입니다.

    • update : 업데이트

      문서의 새 값입니다.

    • Optional options: UpdateOptions

      적용할 추가 옵션입니다.

    Promise<UpdateResult<T["_id"]>>를 반환합니다.

    다음을 포함하는 객체로 확인되는 프로미스:

    {
     matchedCount: number;
     modifiedCount: number;
     upsertedId: IdType | undefined;
    }

업데이트 1

  • 업데이트 1(필터, 업데이트, 옵션?): Promise<UpdateResult<T["_id"]>>

  • 이 collection에 제공된 필터와 일치하는 단일 문서를 업데이트합니다.

    매개변수

    • 필터: 필터

      결과의 범위를 좁히기 위해 적용된 필터입니다.

    • update : 업데이트

      문서의 새 값입니다.

    • Optional options: UpdateOptions

      적용할 추가 옵션입니다.

    Promise<UpdateResult<T["_id"]>>를 반환합니다.

    다음을 포함하는 객체로 확인되는 프로미스:

    {
     matchedCount: number;
     modifiedCount: number;
     upsertedId: IdType | undefined;
    }

시계

  • 시계(): AsyncGenerator<ChangeEvent<t>, any, 알 수 없음>

  • 이 collection의 변경 사항을 모니터링하는 비동기 change stream을 만듭니다.

    기본적으로 이 collection에 대한 모든 변경 이벤트를 반환합니다. filter 또는 ids 옵션 중 하나만 지정할 수 있습니다.

    중요 참고 사항: React Native에서 사용하려면 다음을 설치해야 합니다.

    1. fetch 및 ReadableStream 에 대한 폴리필: https://www.npmjs.com/package/react-native-polyfill-globals
    2. 비동기 생성기 구문을 활성화하는 바벨 플러그인: https://npmjs.com/package/@babel/plugin-proposal-async-generator-functions

    AsyncGenerator<ChangeEvent<T>, 모두, 알 수 없음>을 반환합니다.

    변경 이벤트의 비동기 생성기입니다.

    ~를 참조하세요.

    https://mongodb.com/ko-KR/docs/manual/reference/change-events/

  • 시계(옵션): AsyncGenerator<ChangeEvent<t>, any, 알 수 없음>

  • 매개변수

    AsyncGenerator<ChangeEvent<T>, 모두, 알 수 없음>을 반환합니다.

  • 시계(옵션): AsyncGenerator<ChangeEvent<t>, any, 알 수 없음>

  • 매개변수

    AsyncGenerator<ChangeEvent<T>, 모두, 알 수 없음>을 반환합니다.

설정

테마

이 페이지의 내용

TypeDoc을 사용하여 생성됨