Realm JavaScript

Realm.MongoDBCollection

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

멤버

이름

collection의 이름을 가져옵니다.

방법

집계(파이프라인)Promise<[object>, ...]

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

매개변수:
  • 파이프라인
    • 유형: [object, ...]

    • 집계 파이프라인 단계의 배열입니다.

반환값: Promise<[object>, ...] 결과입니다.
카운트(필터, 옵션)Promise<number>

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

매개변수:
  • 필터 옵션
    • 유형: object

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

  • 옵션 옵션
    • 유형: object

    • 적용할 추가 옵션입니다.

      • limit 옵션
        • 유형: number

        • 반환할 문서의 최대 개수입니다.

반환값: Promise<number>
deleteMany(필터)Promise<DeleteResult>

여러 문서를 삭제합니다.

매개변수:
  • 필터
    • 유형: object

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

반환값: Promise<DeleteResult>
deleteOne(필터)Promise<DeleteResult>

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

매개변수:
  • 필터
    • 유형: object

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

반환값: Promise<DeleteResult>
찾기(필터, 옵션)Promise<[object>, ...]

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

매개변수:
  • 필터 옵션
    • 유형: object

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

  • 옵션 옵션
    • 유형: object

    • 적용할 추가 옵션입니다.

      • sort 옵션
        • 유형: object

        • 일치하는 문서를 반환하는 순서입니다.

      • limit 옵션
        • 유형: number

        • 반환할 문서의 최대 개수입니다.

반환값: Promise<[object>, ...] 문서.
findOne(필터, 옵션)Promise<object>

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

매개변수:
  • 필터 옵션
    • 유형: object

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

  • 옵션 옵션
    • 유형: object

    • 적용할 추가 옵션입니다.

      • sort 옵션
        • 유형: object

        • 일치하는 문서를 반환하는 순서입니다.

반환 값: Promise<object> 문서 또는 일치하는 항목이 없는 경우 null을 반환합니다.
findOneAndDelete(필터, 옵션)Promise<object>

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

매개변수:
  • 필터
    • 유형: object

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

  • 옵션 옵션
    • 유형: object

    • 적용할 추가 옵션입니다.

      • sort 옵션
        • 유형: object

        • 일치하는 문서를 반환하는 순서입니다.

반환 값: Promise<object> 문서 또는 일치하는 항목이 없는 경우 null을 반환합니다.
findOneAndReplace(필터, 교체, 옵션)Promise<?object>

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

매개변수:
  • 필터
    • 유형: object

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

  • 교체
    • 유형: object

    • 문서의 새 값입니다.

  • 옵션 옵션
    • 유형: object

    • 적용할 추가 옵션입니다.

      • sort 옵션
        • 유형: object

        • 일치하는 문서를 반환하는 순서입니다.

      • 업서트 옵션
        • 유형: boolean
        • 기본값입니다: false

        • true이면 쿼리가 collection의 기존 문서와 일치하지 않는 경우 MongoDB가 쿼리 필터와 일치하는 새 문서를 삽입해야 함을 나타냅니다.

      • returnNewDocument 옵션
        • 유형: boolean
        • 기본값입니다: false

        • true인 경우 조치가 업데이트 전 원래 형식 대신 업데이트된 형식으로 문서를 반환해야 함을 나타냅니다.

반환 값: Promise<?object> 문서(수정 전 또는 후) 또는 일치하는 항목이 없는 경우 null을 반환합니다.
findOneAndUpdate(필터, 업데이트, 옵션)Promise<?object>

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

매개변수:
  • 필터
    • 유형: object

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

  • update
    • 유형: object

    • 문서의 새 값입니다.

  • 옵션 옵션
    • 유형: object

    • 적용할 추가 옵션입니다.

      • sort 옵션
        • 유형: object

        • 일치하는 문서를 반환하는 순서입니다.

      • 업서트 옵션
        • 유형: boolean
        • 기본값입니다: false

        • true이면 쿼리가 collection의 기존 문서와 일치하지 않는 경우 MongoDB가 쿼리 필터와 일치하는 새 문서를 삽입해야 함을 나타냅니다.

      • returnNewDocument 옵션
        • 유형: boolean
        • 기본값입니다: false

        • true인 경우 조치가 업데이트 전 원래 형식 대신 업데이트된 형식으로 문서를 반환해야 함을 나타냅니다.

반환 값: Promise<?object> 문서(수정 전 또는 후) 또는 일치하는 항목이 없는 경우 null을 반환합니다.
insertMany(문서)Promise<InsertManyResult>

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

매개변수:
  • 문서
    • 유형: [object, ...]

    • 문서 배열입니다.

반환 값: Promise<InsertManyResult> 삽입된 문서의 ID.
insertOne(문서)Promise<InsertOneResult>

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

매개변수:
  • 문서
    • 유형: object

    • 문서입니다.

반환 값: Promise<InsertOneResult> 삽입된 문서의 _id입니다.
updateMany(필터, 업데이트, 옵션)Promise<UpdateResult>

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

매개변수:
  • 필터
    • 유형: object

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

  • update
    • 유형: object

    • 문서의 새 값입니다.

  • 옵션 옵션
    • 유형: object

    • 적용할 추가 옵션입니다.

      • 업서트 옵션
        • 유형: boolean
        • 기본값입니다: false

        • true이면 쿼리가 collection의 기존 문서와 일치하지 않는 경우 MongoDB가 쿼리 필터와 일치하는 새 문서를 삽입해야 함을 나타냅니다.

      • 배열 필터 옵션
        • 유형: [object, ...]
        • 기본값입니다: false

        • 제공된 경우 포함된 배열을 업데이트하는 데 사용할 arrayFilters를 나타냅니다.

반환값: Promise<UpdateResult>
updateOne(필터, 업데이트, 옵션)Promise<UpdateResult>

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

매개변수:
  • 필터
    • 유형: object

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

  • update
    • 유형: object

    • 문서의 새 값입니다.

  • 옵션 옵션
    • 유형: object

    • 적용할 추가 옵션입니다.

      • 업서트 옵션
        • 유형: boolean
        • 기본값입니다: false

        • true이면 쿼리가 collection의 기존 문서와 일치하지 않는 경우 MongoDB가 쿼리 필터와 일치하는 새 문서를 삽입해야 함을 나타냅니다.

      • 배열 필터 옵션
        • 유형: [object, ...]
        • 기본값입니다: false

        • 제공된 경우 포함된 배열을 업데이트하는 데 사용할 arrayFilters를 나타냅니다.

반환값: Promise<UpdateResult>
시계(옵션)ChangeEvent

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

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

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

  1. fetch, ReadableStream 및 TextDecoder 에 대한 폴리필: https://www.npmjs.com/package/react-native-polyfill-globals
  2. 비동기 생성기 구문을 활성화하는 바벨 플러그인: https://npmjs.com/package/@babel/plugin-proposal-async-generator-functions
매개변수:
  • 옵션 옵션
    • 유형: object
    • 기본값입니다: {}
      • 필터 옵션
        • 유형: object

        • 관심 있는 변경 이벤트에 대한 필터입니다.

      • ID 옵션
        • 유형: [any, ...]

        • 시청에 관심이 있는 ID 목록

유형 정의

ChangeEvent

change stream의 이벤트입니다.

표시되는 속성은 항상 존재하는 operationType 필드와 MongoDB Server 버전에 따라 달라집니다.

유형:
object
속성:
  • _id

    • 이 이벤트의 불투명 재개 토큰입니다.

  • 작업 유형
    • 유형: string

    • 어떤 종류의 작업이었나요? "insert", "delete", "replace", "update", "drop", "rename", "dropDatabase" 또는 "invalidate" 중 하나입니다.

  • 전체 문서
    • 유형: object

    • 이 작업으로 인해 변경된 문서의 전체 사본입니다. 반환되는 문서 버전에 대한 자세한 내용은 mongodb 참고 매뉴얼을 참조하세요.

  • ns
    • 유형: object

    • 이 이벤트의 영향을 받는 컬렉션의 네임스페이스입니다.

      • db
        • 유형: string

        • 데이터베이스 이름

      • coll
        • 유형: string

        • 컬렉션 이름

  • to
    • 유형: object

    • "rename" 이벤트의 대상 네임스페이스입니다.

      • db
        • 유형: string

        • 데이터베이스 이름

      • coll
        • 유형: string

        • 컬렉션 이름

  • documentKey
    • 유형: object

    • 수정된 문서의 _id 및 샤드 키입니다. _id 은 샤드 키의 일부인 경우 중복되지 않습니다.

  • updateDescription
    • 유형: object
      • updatedFields
        • 유형: object

        • 수정된 필드 이름에서 새 값으로의 객체 매핑입니다.

      • removeFields
        • 유형: [string, ...]

        • 제거된 필드 이름 목록입니다.

  • clusterTime
    • 유형: Timestamp

    • 이벤트와 연결된 oplog 항목의 타임스탬프입니다.

  • txnNumber
    • 유형: Long

    • 트랜잭션 번호입니다. 다중 문서 트랜잭션의 일부인 경우에만 표시됩니다.

  • lsid
    • 유형: object

    • 트랜잭션의 논리적 세션 ID입니다. 다중 문서 트랜잭션의 일부인 경우에만 표시됩니다.

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

문서 삭제 결과

유형:
object
속성:
  • deleteCount
    • 유형: number

    • 삭제된 문서 수입니다.

InsertManyResult
속성:
  • insertIds
    • 유형: Array

    • 삽입된 문서의 ID

InsertOneResult
속성:
  • insertId

    • 삽입된 문서의 ID

UpdateResult

문서 업데이트 결과

유형:
object
속성:
  • matchCount
    • 유형: number

    • 필터와 일치하는 문서 수입니다.

  • modifiedCount
    • 유형: number

    • 쿼리와 일치하는 문서 수입니다.

  • upsertedId 옵션

    • 업서트가 발생한 경우 삽입된 문서의 식별자입니다.