DOCSP-21884 updated config uri name (#123)

* updated config uri name

(cherry picked from commit 425976871af14898b1e516781a86ca4b2e5edbe0)

Author: kyuan-mongodb

source/configuration/read.txt

@@ -31,14 +31,14 @@ You can configure the following properties to read from MongoDB:
    * - Property name
      - Description
 
-   * - ``uri``
+   * - ``connection.uri``
      - **Required.**
        The connection string in the form
        ``mongodb://host:port/``. The ``host`` can be a hostname, IP
        address, or UNIX domain socket. If the connection string doesn't
        specify a ``port``, it uses the default MongoDB port, ``27017``.
 
-       You can append the other remaining read options to the ``uri``
+       You can append the other remaining read options to the ``connection.uri``
        setting. See :ref:`configure-input-uri`.
 
    * - ``database``
@@ -342,13 +342,13 @@ Change Streams
 
 .. _configure-input-uri:
 
-``uri`` Configuration Setting
------------------------------
+``connection.uri`` Configuration Setting
+----------------------------------------
 
-You can set all :ref:`spark-input-conf` via the read ``uri`` setting.
+You can set all :ref:`spark-input-conf` via the read ``connection.uri`` setting.
 
 For example, consider the following example which sets the read
-``uri`` setting via ``SparkConf``:
+``connection.uri`` setting via ``SparkConf``:
 
 .. note::
 
@@ -357,24 +357,24 @@ For example, consider the following example which sets the read
 
 .. code:: cfg
 
-   spark.mongodb.read.uri=mongodb://127.0.0.1/databaseName.collectionName?readPreference=primaryPreferred
+  spark.mongodb.read.connection.uri=mongodb://127.0.0.1/databaseName.collectionName?readPreference=primaryPreferred
 
 The configuration corresponds to the following separate configuration
 settings:
 
 .. code:: cfg
 
-   spark.mongodb.read.uri=mongodb://127.0.0.1/
+  spark.mongodb.read.connection.uri=mongodb://127.0.0.1/
    spark.mongodb.read.database=databaseName
    spark.mongodb.read.collection=collectionName
    spark.mongodb.read.readPreference.name=primaryPreferred
 
-If you specify a setting both in the ``uri`` and in a separate
-configuration, the ``uri`` setting overrides the separate
+If you specify a setting both in the ``connection.uri`` and in a separate
+configuration, the ``connection.uri`` setting overrides the separate
 setting. For example, given the following configuration, the
 database for the connection is ``foobar``:
 
 .. code:: cfg
 
-   spark.mongodb.read.uri=mongodb://127.0.0.1/foobar
+  spark.mongodb.read.connection.uri=mongodb://127.0.0.1/foobar
    spark.mongodb.read.database=bar

source/configuration/write.txt

@@ -31,7 +31,7 @@ The following options for writing to MongoDB are available:
    * - Property name
      - Description
 
-   * - ``uri``
+   * - ``connection.uri``
      - **Required.** 
        The connection string in the form
        ``mongodb://host:port/``. The ``host`` can be a hostname, IP
@@ -40,7 +40,7 @@ The following options for writing to MongoDB are available:
 
        .. note:: 
 
-          The other remaining options may be appended to the ``uri``
+          The other remaining options may be appended to the ``connection.uri``
           setting. See :ref:`configure-output-uri`.
 
    * - ``database``
@@ -102,13 +102,13 @@ The following options for writing to MongoDB are available:
 
 .. _configure-output-uri:
 
-``uri`` Configuration Setting
------------------------------
+``connection.uri`` Configuration Setting
+----------------------------------------
 
-You can set all :ref:`spark-output-conf` via the write ``uri``.
+You can set all :ref:`spark-output-conf` via the write ``connection.uri``.
 
 For example, consider the following example which sets the write
-``uri`` setting via ``SparkConf``:
+``connection.uri`` setting via ``SparkConf``:
 
 .. note::
 
@@ -117,23 +117,23 @@ For example, consider the following example which sets the write
 
 .. code:: cfg
 
-   spark.mongodb.write.uri=mongodb://127.0.0.1/test.myCollection
+  spark.mongodb.write.connection.uri=mongodb://127.0.0.1/test.myCollection
 
 The configuration corresponds to the following separate configuration
 settings:
 
 .. code:: cfg
 
-   spark.mongodb.write.uri=mongodb://127.0.0.1/
+  spark.mongodb.write.connection.uri=mongodb://127.0.0.1/
    spark.mongodb.write.database=test
    spark.mongodb.write.collection=myCollection
 
-If you specify a setting both in the ``uri`` and in a separate
-configuration, the ``uri`` setting overrides the separate
+If you specify a setting both in the ``connection.uri`` and in a separate
+configuration, the ``connection.uri`` setting overrides the separate
 setting. For example, given the following configuration, the
 database for the connection is ``foobar``:
 
 .. code:: cfg
 
-   spark.mongodb.write.uri=mongodb://127.0.0.1/foobar
+  spark.mongodb.write.connection.uri=mongodb://127.0.0.1/foobar
    spark.mongodb.write.database=bar

source/includes/extracts-command-line.yaml

@@ -17,11 +17,11 @@ content: |
 ---
 ref: list-configuration-explanation
 content: |
-   - The :ref:`spark.mongodb.read.uri <spark-input-conf>` specifies the
+   - The :ref:`spark.mongodb.read.connection.uri <spark-input-conf>` specifies the
      MongoDB server address (``127.0.0.1``), the database to connect
      (``test``), and the collection (``myCollection``) from which to read
      data, and the read preference.
-   - The :ref:`spark.mongodb.write.uri <spark-output-conf>` specifies the
+   - The :ref:`spark.mongodb.write.connection.uri <spark-output-conf>` specifies the
      MongoDB server address (``127.0.0.1``), the database to connect
      (``test``), and the collection (``myCollection``) to which to write
      data. Connects to port ``27017`` by default.
@@ -37,8 +37,8 @@ content: |
 
    .. code-block:: sh
 
-      ./bin/spark-shell --conf "spark.mongodb.read.uri=mongodb://127.0.0.1/test.myCollection?readPreference=primaryPreferred" \
-                        --conf "spark.mongodb.write.uri=mongodb://127.0.0.1/test.myCollection" \
+      ./bin/spark-shell --conf "spark.mongodb.read.connection.uri=mongodb://127.0.0.1/test.myCollection?readPreference=primaryPreferred" \
+                        --conf "spark.mongodb.write.connection.uri=mongodb://127.0.0.1/test.myCollection" \
                         --packages org.mongodb.spark:mongo-spark-connector:{+current-version+}
  
    .. include:: /includes/extracts/list-configuration-explanation.rst
@@ -54,8 +54,8 @@ content: |
 
    .. code-block:: sh
 
-      ./bin/pyspark --conf "spark.mongodb.read.uri=mongodb://127.0.0.1/test.myCollection?readPreference=primaryPreferred" \
-                    --conf "spark.mongodb.write.uri=mongodb://127.0.0.1/test.myCollection" \
+      ./bin/pyspark --conf "spark.mongodb.read.connection.uri=mongodb://127.0.0.1/test.myCollection?readPreference=primaryPreferred" \
+                    --conf "spark.mongodb.write.connection.uri=mongodb://127.0.0.1/test.myCollection" \
                     --packages org.mongodb.spark:mongo-spark-connector:{+current-version+}
  
    .. include:: /includes/extracts/list-configuration-explanation.rst
@@ -71,8 +71,8 @@ content: |
 
    .. code-block:: sh
 
-      ./bin/sparkR  --conf "spark.mongodb.read.uri=mongodb://127.0.0.1/test.myCollection?readPreference=primaryPreferred" \
-                    --conf "spark.mongodb.write.uri=mongodb://127.0.0.1/test.myCollection" \
+      ./bin/sparkR  --conf "spark.mongodb.read.connection.uri=mongodb://127.0.0.1/test.myCollection?readPreference=primaryPreferred" \
+                    --conf "spark.mongodb.write.connection.uri=mongodb://127.0.0.1/test.myCollection" \
                     --packages org.mongodb.spark:mongo-spark-connector:{+current-version+}
 
    .. include:: /includes/extracts/list-configuration-explanation.rst

source/java/api.txt

@@ -48,21 +48,21 @@ Configuration
        SparkSession spark = SparkSession.builder()
          .master("local")
          .appName("MongoSparkConnectorIntro")
-         .config("spark.mongodb.read.uri", "mongodb://127.0.0.1/test.myCollection")
-         .config("spark.mongodb.write.uri", "mongodb://127.0.0.1/test.myCollection")
+         .config("spark.mongodb.read.connection.uri", "mongodb://127.0.0.1/test.myCollection")
+         .config("spark.mongodb.write.connection.uri", "mongodb://127.0.0.1/test.myCollection")
          .getOrCreate();
 
        // Application logic
 
      }
    }
 
-- The :ref:`spark.mongodb.read.uri <spark-input-conf>` specifies the
+- The :ref:`spark.mongodb.read.connection.uri <spark-input-conf>` specifies the
   MongoDB server  address(``127.0.0.1``), the database to connect
   (``test``), and the collection (``myCollection``) from which to read
   data, and the read preference.
 
-- The :ref:`spark.mongodb.write.uri <spark-output-conf>` specifies the
+- The :ref:`spark.mongodb.write.connection.uri <spark-output-conf>` specifies the
   MongoDB server address(``127.0.0.1``), the database to connect
   (``test``), and the collection (``myCollection``) to which to write
   data.

source/python/api.txt

@@ -19,8 +19,8 @@ Create a ``SparkSession`` Object
    ``spark`` by default. In a standalone Python application, you need
    to create your ``SparkSession`` object explicitly, as show below.
 
-If you specified the ``spark.mongodb.read.uri``
-and ``spark.mongodb.write.uri`` configuration options when you
+If you specified the ``spark.mongodb.read.connection.uri``
+and ``spark.mongodb.write.connection.uri`` configuration options when you
 started ``pyspark``, the default ``SparkSession`` object uses them.
 If you'd rather create your own ``SparkSession`` object from within
 ``pyspark``, you can use ``SparkSession.builder`` and specify different
@@ -33,8 +33,8 @@ configuration options.
    my_spark = SparkSession \
        .builder \
        .appName("myApp") \
-       .config("spark.mongodb.read.uri", "mongodb://127.0.0.1/test.coll") \
-       .config("spark.mongodb.write.uri", "mongodb://127.0.0.1/test.coll") \
+       .config("spark.mongodb.read.connection.uri", "mongodb://127.0.0.1/test.coll") \
+       .config("spark.mongodb.write.connection.uri", "mongodb://127.0.0.1/test.coll") \
        .getOrCreate()
 
 You can use a ``SparkSession`` object to write data to MongoDB, read

source/python/read-from-mongodb.txt

@@ -1,6 +1,6 @@
 You can create a Spark DataFrame to hold data from the MongoDB
 collection specified in the
-:ref:`spark.mongodb.read.uri <pyspark-shell>` option which your
+:ref:`spark.mongodb.read.connection.uri <pyspark-shell>` option which your
 ``SparkSession`` option is using.
 
 .. include:: /includes/example-load-dataframe.rst

source/python/write-to-mongodb.txt

@@ -9,15 +9,15 @@ a list of tuples containing names and ages, and a list of column names:
       ("Dwalin", 169), ("Oin", 167), ("Gloin", 158), ("Fili", 82), ("Bombur", None)], ["name", "age"])
 
 Write the ``people`` DataFrame to the MongoDB database and collection
-specified in the :ref:`spark.mongodb.write.uri<pyspark-shell>` option
+specified in the :ref:`spark.mongodb.write.connection.uri<pyspark-shell>` option
 by using the ``write`` method:
 
 .. code-block:: python
 
    people.write.format("mongodb").mode("append").save()
 
 The above operation writes to the MongoDB database and collection
-specified in the :ref:`spark.mongodb.write.uri<pyspark-shell>` option
+specified in the :ref:`spark.mongodb.write.connection.uri<pyspark-shell>` option
 when you connect to the ``pyspark`` shell.
 
 To read the contents of the DataFrame, use the ``show()`` method.

source/scala/api.txt

@@ -69,8 +69,8 @@ Configuration
        val spark = SparkSession.builder()
          .master("local")
          .appName("MongoSparkConnectorIntro")
-         .config("spark.mongodb.read.uri", "mongodb://127.0.0.1/test.myCollection")
-         .config("spark.mongodb.write.uri", "mongodb://127.0.0.1/test.myCollection")
+         .config("spark.mongodb.read.connection.uri", "mongodb://127.0.0.1/test.myCollection")
+         .config("spark.mongodb.write.connection.uri", "mongodb://127.0.0.1/test.myCollection")
          .getOrCreate()
 
      }