Skip to content

Commit 7885e15

Browse files
docsp-34430 - add schema note (#190) (#191)
(cherry picked from commit 344ce63) Co-authored-by: Mike Woofter <[email protected]>
1 parent 45d7bce commit 7885e15

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

Diff for: source/streaming-mode/streaming-read-config.txt

+14-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Streaming Read Configuration Options
1010
:depth: 1
1111
:class: singlecol
1212

13+
.. facet::
14+
:name: genre
15+
:values: reference
16+
17+
.. meta::
18+
:keywords: change stream, customize
19+
1320
.. _spark-streaming-input-conf:
1421

1522
Overview
@@ -150,15 +157,20 @@ You can configure the following properties when reading a change stream from Mon
150157
- | Specifies whether to publish the changed document or the full
151158
change stream document.
152159
|
160+
| When this setting is ``false``, you must specify a schema. The schema
161+
must include all fields that you want to read from the change stream. You can
162+
use optional fields to ensure that the schema is valid for all change-stream
163+
events.
164+
|
153165
| When this setting is ``true``, the connector exhibits the following behavior:
154166

155167
- The connector filters out messages that
156-
omit the ``fullDocument`` field and only publishes the value of the
168+
omit the ``fullDocument`` field and publishes only the value of the
157169
field.
158170
- If you don't specify a schema, the connector infers the schema
159171
from the change stream document rather than from the underlying collection.
160172

161-
**Default**: ``false``
173+
**Default**: ``false``
162174

163175
.. note::
164176

0 commit comments

Comments
 (0)