Skip to content

Commit 06c6fd0

Browse files
committed
docsp-30967 - add comment option (#167)
(cherry picked from commit a191cd5)
1 parent 1e862a2 commit 06c6fd0

File tree

2 files changed

+30
-19
lines changed

2 files changed

+30
-19
lines changed

source/configuration/read.txt

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ You can configure the following properties to read from MongoDB:
2121

2222
.. note::
2323

24-
2524
If you use ``SparkConf`` to set the connector's read configurations,
2625
prefix ``spark.mongodb.read.`` to each property.
2726

@@ -31,15 +30,7 @@ You can configure the following properties to read from MongoDB:
3130

3231
* - Property name
3332
- Description
34-
35-
* - ``mongoClientFactory``
36-
- | MongoClientFactory configuration key.
37-
| You can specify a custom implementation which must implement the
38-
``com.mongodb.spark.sql.connector.connection.MongoClientFactory``
39-
interface.
40-
|
41-
| **Default:** ``com.mongodb.spark.sql.connector.connection.DefaultMongoClientFactory``
42-
33+
4334
* - ``connection.uri``
4435
- | **Required.**
4536
| The connection string configuration key.
@@ -54,6 +45,20 @@ You can configure the following properties to read from MongoDB:
5445
- | **Required.**
5546
| The collection name configuration.
5647

48+
* - ``comment``
49+
- | The comment to append to the read operation. Comments appear in the
50+
:manual:`output of the Database Profiler. </reference/database-profiler>`
51+
|
52+
| **Default:** None
53+
54+
* - ``mongoClientFactory``
55+
- | MongoClientFactory configuration key.
56+
| You can specify a custom implementation which must implement the
57+
``com.mongodb.spark.sql.connector.connection.MongoClientFactory``
58+
interface.
59+
|
60+
| **Default:** ``com.mongodb.spark.sql.connector.connection.DefaultMongoClientFactory``
61+
5762
* - ``partitioner``
5863
- | The partitioner full class name.
5964

source/configuration/write.txt

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,27 +30,33 @@ The following options for writing to MongoDB are available:
3030

3131
* - Property name
3232
- Description
33+
34+
* - ``connection.uri``
35+
- | **Required.**
36+
| The connection string configuration key.
37+
|
38+
| **Default:** ``mongodb://localhost:27017/``
39+
40+
* - ``database``
41+
- | **Required.**
42+
| The database name configuration.
3343

3444
* - ``collection``
3545
- | **Required.**
3646
| The collection name configuration.
3747

38-
* - ``connection.uri``
39-
- | **Required.**
40-
| The connection string configuration key.
48+
* - ``comment``
49+
- | The comment to append to the write operation. Comments appear in the
50+
:manual:`output of the Database Profiler. </reference/database-profiler>`
4151
|
42-
| **Default:** ``mongodb://localhost:27017/``
52+
| **Default:** None
4353

4454
* - ``convertJson``
4555
- | When ``true``, the connector parses the string and converts extended JSON
4656
into BSON.
4757
|
4858
| **Default:** ``false``
49-
50-
* - ``database``
51-
- | **Required.**
52-
| The database name configuration.
53-
59+
5460
* - ``idFieldList``
5561
- | Field or list of fields by which to split the collection data. To
5662
specify more than one field, separate them using a comma as shown

0 commit comments

Comments
 (0)