db.watch()
정의
db.watch( pipeline, options )
복제본 세트 및 샤딩된 클러스터 전용
데이터베이스 에 대한 변경 스트림 커서 를 열어
system
이 아닌 모든 컬렉션에 대해 보고합니다.Parameter유형설명pipeline
배열선택 사항입니다. 다음 집계 단계 중 하나 이상으로 구성된 집계 파이프라인:
변경 이벤트 출력을 필터링/수정할 파이프라인을 지정합니다.
MongoDB 4.2부터 변경 스트림 집계 파이프라인이 이벤트의 _id 필드를 수정하면 변경 스트림이 예외를 스로우합니다.
options
문서options
문서에는 다음과 같은 필드 및 값이 포함될 수 있습니다.필드유형설명resumeAfter
문서선택 사항입니다. 변경 스트림의 논리적 시작점으로 재개 토큰 을 지정합니다.
invalidate
이벤트 이후에 변경 스트림을 재개하는 데 사용할 수 없습니다.resumeAfter
의 경우startAfter
및startAtOperationTime
과 상호 배타적입니다.startAfter
문서선택 사항입니다. 변경 스트림의 논리적 시작점으로 재개 토큰을 지정합니다.
resumeAfter
와 달리startAfter
는 새로운 변경 스트림을 생성하여invalidate
이벤트 후에 알림을 재개할 수 있습니다.startAfter
의 경우resumeAfter
및startAtOperationTime
과 상호 배타적입니다.fullDocument
문자열선택 사항입니다. 기본적으로
db.watch()
는 업데이트된 전체 문서 대신 업데이트 작업으로 수정된 필드의 델타를 반환합니다.fullDocument
를"updateLookup"
로 설정하여db.watch()
가 업데이트된 문서의 가장 최근에 대다수 커밋된 버전을 찾도록 지시합니다.db.watch()
는updateDescription
델타에 더해 문서 조회가 있는fullDocument
필드를 반환합니다.MongoDB 6.0부터
fullDocument
를 다음으로 설정할 수 있습니다."whenAvailable"
은 문서를 삽입, 교체, 업데이트한 후 문서 사후 이미지(사용 가능한 경우)로 출력합니다."required"
문서가 삽입, 교체 또는 업데이트된 후의 문서 사후 이미지를 출력합니다. 사후 이미지를 사용할 수 없는 경우 오류가 발생합니다.
fullDocumentBeforeChange
문자열선택 사항입니다. 기본값은
"off"
입니다.MongoDB 6.0부터는 새로운
fullDocumentBeforeChange
필드를 사용하여 다음과 같이 설정할 수 있습니다:"whenAvailable"
문서를 교체, 업데이트 또는 삭제하기 전에 사전 이미지 문서(사용 가능한 경우)를 출력합니다."required"
는 문서가 교체, 업데이트, 삭제되기 전의 문서 사전 이미지를 출력합니다. 사전 이미지를 사용할 수 없는 경우 오류가 발생합니다."off"
을(를) 입력하여 문서 사전 이미지를 표시하지 않도록 합니다. 기본값은"off"
입니다.
batchSize
int선택 사항입니다. MongoDB cluster의 각 응답 배치에서 반환할 최대 변경 이벤트 수를 지정합니다.
maxAwaitTimeMS
int선택 사항입니다. 서버가 빈 배치를 반환하기 전에 변경 스트림 커서에 보고할 새 데이터 변경 내용을 기다리는 최대 시간(밀리초)입니다.
기본값은
1000
밀리초입니다.collation
문서startAtOperationTime
타임스탬프선택 사항입니다. 변경 스트림의 시작 지점입니다. 지정된 시작점이 과거인 경우 oplog의 시간 범위 내에 있어야 합니다. oplog의 시간 범위를 확인하려면
rs.printReplicationInfo()
를 참조하십시오.startAtOperationTime
의 경우resumeAfter
및startAfter
과 상호 배타적입니다.반환합니다: 변경 이벤트 문서 위에 커서가 있습니다. 변경 이벤트 문서의 예는 변경 이벤트에서 확인하세요.
가용성
배포
db.watch()
은(는) 복제본 세트와 샤딩된 클러스터에 사용할 수 있습니다.
복제본 집합의 경우 데이터를 보유한 모든 멤버에
db.watch()
를 발행할 수 있습니다.샤딩된 클러스터의 경우
mongos
인스턴스에서db.watch()
를 발행해야 합니다.
스토리지 엔진
Wired Tiger 스토리지 엔진에는 db.watch()
만 사용할 수 있습니다.
읽기 고려 majority
지원
MongoDB 4.2부터 변경 스트림은 "majority"
읽기 고려 지원과 무관하게 이용 가능합니다. 즉, 읽기 고려 majority
지원은 변경 스트림 사용 시 활성화(기본값)하거나 비활성화할 수 있습니다.
MongoDB 4.0 이하 버전에서는 읽기 우려 지원을 "majority"
를 활성화한 경우에만변경 스트림을 사용할 수 있습니다(기본값).
행동
admin
,local
, 또는config
데이터베이스에서는db.watch()
를 실행할 수 없습니다.db.watch()
대부분의 데이터 보유 멤버에게 지속된 데이터 변경 사항에 대해서만 알립니다.변경 스트림 커서는 다음 중 하나가 발생할 때까지 열려 있습니다.
커서가 명시적으로 닫힙니다.
무효화 이벤트가 발생합니다. 예를 들어 컬렉션 제거 또는 이름 바꾸기가 있습니다.
MongoDB 배포에 대한 연결이 닫히거나 시간 초과됩니다. 자세한 내용은 Cursor Behaviors를 참조하십시오.
배포가 샤딩된 클러스터인 경우 분할 제거로 인해 열린 변경 스트림 커서가 닫힐 수 있으며 닫힌 변경 스트림 커서가 완전히 재개되지 않을 수 있습니다.
존재하지 않는 데이터베이스에 대해
db.watch()
를 실행할 수 있습니다. 하지만 데이터베이스가 생성된 후 데이터베이스를 제거하면 변경 스트림 커서가 닫힙니다.
재개 가능성
MongoDB 드라이버와 달리 mongosh
는 오류 후 변경 스트림 커서를 재개하려고 자동으로 시도하지 않습니다. MongoDB 드라이버는 특정 오류 발생 후 변경 스트림 커서를 자동으로 다시 시작하려고 한 번 시도합니다.
db.watch()
는 oplog에 저장된 정보를 사용하여 변경 이벤트 설명을 생성하고 해당 작업과 관련된 재개 토큰을 생성합니다. 재개 토큰으로 식별되어 resumeAfter
또는 startAfter
옵션에 전달된 작업이 이미 oplog에서 제거된 경우, db.watch()
는 변경 스트림을 재개할 수 없습니다.
변경 스트림 재개에 대한 자세한 내용은 변경 스트림 재개를 참조하십시오.
참고
무효화 이벤트(예: 컬렉션 제거 또는 이름 바꾸기)로 인해 스트림이 닫힌 후에는
resumeAfter
를 사용하여 변경 스트림을 다시 시작할 수 없습니다. 대신 무효화 이벤트 후 startAfter를 사용하여 새 변경 스트림을 시작할 수 있습니다.배포가 샤딩된 클러스터인 경우 분할 제거로 인해 열린 변경 스트림 커서가 닫힐 수 있으며 닫힌 변경 스트림 커서가 완전히 재개되지 않을 수 있습니다.
참고
무효화 이벤트(예: 컬렉션 제거 또는 이름 바꾸기)로 인해 스트림이 닫힌 후에는 resumeAfter
를 사용하여 변경 스트림을 다시 시작할 수 없습니다. 대신 무효화 이벤트 후 startAfter를 사용하여 새 변경 스트림을 시작할 수 있습니다.
업데이트 작업의 전체 문서 조회
기본적으로 변경 스트림 커서는 업데이트 작업에 대한 특정 필드 변경 사항/델타를 반환합니다. 또한 변경된 문서의 현재 과반수가 커밋된 버전을 조회하고 반환하도록 변경 스트림을 구성할 수 있습니다. 업데이트와 조회 사이에 발생했을 수 있는 다른 쓰기 작업에 따라 반환된 문서는 업데이트 당시의 문서와 크게 다를 수 있습니다.
업데이트 작업 중에 적용된 변경 사항 수와 전체 문서의 크기에 따라 업데이트 작업에 대한 변경 이벤트 문서의 크기가 16MB BSON 문서 제한보다 클 위험이 있습니다. 이런 일이 발생하면 서버는 변경 스트림 커서를 닫고 오류를 반환합니다.
액세스 제어
액세스 제어를 사용하여 실행하는 경우 사용자에게 데이터베이스 리소스에 대한 find
및 changeStream
권한 작업이 있어야 합니다. 즉, 사용자의 역할이 다음 권한을 부여해야 합니다.
{ resource: { db: <dbname>, collection: "" }, actions: [ "find", "changeStream"] }
기본 제공 read
역할은 적절한 권한을 제공합니다.
커서 반복
MongoDB는 커서를 반복하는 다양한 방법을 제공합니다.
cursor.hasNext()
메서드는 다음 이벤트를 차단하고 기다립니다. watchCursor
커서를 모니터링하고 이벤트를 반복하려면 hasNext()
를 다음과 같이 사용합니다.
while (!watchCursor.isClosed()) { if (watchCursor.hasNext()) { firstChange = watchCursor.next(); break; } }
cursor.tryNext()
메서드는 비차단입니다. watchCursor
커서를 모니터링하고 이벤트를 반복하려면 tryNext()
를 다음과 같이 사용합니다.
while (!watchCursor.isClosed()) { let next = watchCursor.tryNext() while (next !== null) { printjson(next); next = watchCursor.tryNext() } }
예시
mongosh
에서 다음 작업은 hr
데이터베이스에서 변경 스트림 커서를 엽니다. 반환된 커서는 해당 데이터베이스의 system
이 아닌 모든 컬렉션에 대한 데이터 변경 사항을 보고합니다.
watchCursor = db.getSiblingDB("hr").watch()
커서를 반복하여 새 이벤트를 확인합니다. 2} 메서드를 cursor.isClosed()
메서드와 함께 cursor.tryNext()
를 사용하여 변경 스트림 커서가 닫혀 있고 최신 배치에 객체가 남아 있지 않은 경우에만 루프가 종료되도록 합니다:
while (!watchCursor.isClosed()) { let next = watchCursor.tryNext() while (next !== null) { printjson(next); next = watchCursor.tryNext() } }
변경 스트림 출력에 대한 전체 문서는 변경 이벤트를 참조하십시오.
참고
변경 스트림에는 isExhausted()
를 사용할 수 없습니다.