Skip to content

Commit bde2a22

Browse files
authored
DOC-12522 updated admonition for sync metadata (#863)
* DOC-12522 updated admonition for sync metadata * clarify N1QL modification
1 parent 940c2f9 commit bde2a22

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

modules/ROOT/pages/sync-with-couchbase-server.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,16 +129,18 @@ As stated, mobile metadata is not kept in the document, but in a system extended
129129
The N1QL query language {fnref-cbs5x0} supports the ability to query these extended attributes (XATTRS) and hence the document's sync metadata -- see: <<simple-query>>.
130130

131131
[#simple-query]
132-
.Querying XATTRS-bsed sync metadata
132+
.Querying XATTRS-based sync metadata
133133
====
134134
[source,sql]
135135
----
136136
SELECT meta().xattrs._sync FROM scope.collection WHERE meta().id = "mydocId"
137137
----
138138
====
139139

140-
WARNING: The sync metadata is maintained internally by {sgw} and its structure can change at any time.
141-
It should not be used to drive business logic of applications. The direct use of the N1QL query is *unsupported* and must not be used in production environments.
140+
WARNING: {sgw} maintains the sync metadata internally, and its structure can change at any time.
141+
Applications must not use it for business logic.
142+
The direct use of the N1QL query or modifying the internal sync metadata contents to drive the business logic is unsupported and must not be used in production environments.
143+
The sync metadata includes the `_sync` extended attribute (XATTR) in use case documents and all `_sync:` prefixed documents in Sync Gateway connected Buckets.
142144

143145
=== Enable Shared Bucket Access
144146

0 commit comments

Comments
 (0)