-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathChangeStreamShardCollectionDocument.html
31 lines (31 loc) · 19.2 KB
/
ChangeStreamShardCollectionDocument.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChangeStreamShardCollectionDocument | mongodb</title><meta name="description" content="Documentation for mongodb"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">mongodb</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mongodb</a></li><li><a href="ChangeStreamShardCollectionDocument.html">ChangeStreamShardCollectionDocument</a></li></ul><h1>Interface ChangeStreamShardCollectionDocument</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://www.mongodb.com/docs/manual/reference/change-events/">https://www.mongodb.com/docs/manual/reference/change-events/</a></p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ChangeStreamDocumentCommon.html" class="tsd-signature-type" data-tsd-kind="Interface">ChangeStreamDocumentCommon</a></li><li><a href="ChangeStreamDocumentCollectionUUID.html" class="tsd-signature-type" data-tsd-kind="Interface">ChangeStreamDocumentCollectionUUID</a></li><li><a href="ChangeStreamDocumentOperationDescription.html" class="tsd-signature-type" data-tsd-kind="Interface">ChangeStreamDocumentOperationDescription</a><ul class="tsd-hierarchy"><li><span class="target">ChangeStreamShardCollectionDocument</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#_id" class="tsd-kind-icon">_id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#clusterTime" class="tsd-kind-icon">cluster<wbr/>Time</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#collectionUUID" class="tsd-kind-icon">collectionUUID</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#lsid" class="tsd-kind-icon">lsid</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#operationDescription" class="tsd-kind-icon">operation<wbr/>Description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChangeStreamShardCollectionDocument.html#operationType" class="tsd-kind-icon">operation<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#txnNumber" class="tsd-kind-icon">txn<wbr/>Number</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link">_id<a href="#_id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">_id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChangeStreamDocumentCommon.html">ChangeStreamDocumentCommon</a>.<a href="ChangeStreamDocumentCommon.html#_id">_id</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/change_stream.ts#L171">src/change_stream.ts:171</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The id functions as an opaque token for use when resuming an interrupted
change stream.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="clusterTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> cluster<wbr/>Time<a href="#clusterTime" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">cluster<wbr/>Time<span class="tsd-signature-symbol">?:</span> <a href="../classes/BSON.Timestamp.html" class="tsd-signature-type" data-tsd-kind="Class">Timestamp</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChangeStreamDocumentCommon.html">ChangeStreamDocumentCommon</a>.<a href="ChangeStreamDocumentCommon.html#clusterTime">clusterTime</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/change_stream.ts#L180">src/change_stream.ts:180</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The timestamp from the oplog entry associated with the event.
For events that happened as part of a multi-document transaction, the associated change stream
notifications will have the same clusterTime value, namely the time when the transaction was committed.
On a sharded cluster, events that occur on different shards can have the same clusterTime but be
associated with different transactions or even not be associated with any transaction.
To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="collectionUUID" class="tsd-anchor"></a><h3 class="tsd-anchor-link">collectionUUID<a href="#collectionUUID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">collectionUUID<span class="tsd-signature-symbol">:</span> <a href="../classes/BSON.Binary.html" class="tsd-signature-type" data-tsd-kind="Class">Binary</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChangeStreamDocumentCollectionUUID.html">ChangeStreamDocumentCollectionUUID</a>.<a href="ChangeStreamDocumentCollectionUUID.html#collectionUUID">collectionUUID</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/change_stream.ts#L209">src/change_stream.ts:209</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The UUID (Binary subtype 4) of the collection that the operation was performed on.</p>
</div><div><p>Only present when the <code>showExpandedEvents</code> flag is enabled.</p>
<p><strong>NOTE:</strong> collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers
flag is enabled.</p>
</div><dl class="tsd-comment-tags"><dt>sinceserverversion</dt><dd><p>6.1.0</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="lsid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> lsid<a href="#lsid" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">lsid<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#ServerSessionId" class="tsd-signature-type" data-tsd-kind="Type alias">ServerSessionId</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChangeStreamDocumentCommon.html">ChangeStreamDocumentCommon</a>.<a href="ChangeStreamDocumentCommon.html#lsid">lsid</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/change_stream.ts#L194">src/change_stream.ts:194</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The identifier for the session associated with the transaction.
Only present if the operation is part of a multi-document transaction.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="operationDescription" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> operation<wbr/>Description<a href="#operationDescription" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">operation<wbr/>Description<span class="tsd-signature-symbol">?:</span> <a href="BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChangeStreamDocumentOperationDescription.html">ChangeStreamDocumentOperationDescription</a>.<a href="ChangeStreamDocumentOperationDescription.html#operationDescription">operationDescription</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/change_stream.ts#L221">src/change_stream.ts:221</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>An description of the operation.</p>
</div><div><p>Only present when the <code>showExpandedEvents</code> flag is enabled.</p>
</div><dl class="tsd-comment-tags"><dt>sinceserverversion</dt><dd><p>6.1.0</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="operationType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">operation<wbr/>Type<a href="#operationType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">operation<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"shardCollection"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/change_stream.ts#L422">src/change_stream.ts:422</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Describes the type of operation represented in this change notification</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="txnNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> txn<wbr/>Number<a href="#txnNumber" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">txn<wbr/>Number<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChangeStreamDocumentCommon.html">ChangeStreamDocumentCommon</a>.<a href="ChangeStreamDocumentCommon.html#txnNumber">txnNumber</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/change_stream.ts#L188">src/change_stream.ts:188</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The transaction number.
Only present if the operation is part of a multi-document transaction.</p>
</div><div><p><strong>NOTE:</strong> txnNumber can be a Long if promoteLongs is set to false</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="label tsd-is-external"><span>Internals</span></li><li class="label tsd-is-external"><span>Externals</span></li><li class=" tsd-kind-namespace tsd-is-external"><a href="../modules/BSON.html">BSON</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ChangeStreamShardCollectionDocument.html" class="tsd-kind-icon">Change<wbr/>Stream<wbr/>Shard<wbr/>Collection<wbr/>Document</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#_id" class="tsd-kind-icon">_id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#clusterTime" class="tsd-kind-icon">cluster<wbr/>Time</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#collectionUUID" class="tsd-kind-icon">collectionUUID</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#lsid" class="tsd-kind-icon">lsid</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#operationDescription" class="tsd-kind-icon">operation<wbr/>Description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChangeStreamShardCollectionDocument.html#operationType" class="tsd-kind-icon">operation<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChangeStreamShardCollectionDocument.html#txnNumber" class="tsd-kind-icon">txn<wbr/>Number</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>