From 890c9d0c95c88859c635bfc0277ef755432ac08b Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 14:29:01 -0500 Subject: [PATCH 01/38] DOCSP-23996 Add enableUtf8Validation Connectionstring Option --- .../advanced-connection-options/advanced-connection.txt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index 49c31ee86..ffbd82edf 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -104,6 +104,14 @@ Procedure For more information, see :manual:`Connection String Options `. + .. note:: + + There are a few connection string parameters which are supported + only by the ``nodejs`` driver. For details on all supported node + specific connection string parameters see + `Node Connection Options + `__. + .. step:: Click Connect. .. seealso:: From d040572061e02d6f8ea2a563a549a838d8ad1e83 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 15:28:33 -0500 Subject: [PATCH 02/38] * --- .../advanced-connection.txt | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index ffbd82edf..a46c0eb91 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -106,12 +106,17 @@ Procedure .. note:: - There are a few connection string parameters which are supported - only by the ``nodejs`` driver. For details on all supported node - specific connection string parameters see - `Node Connection Options - `__. + The ``enableUtf8Validation`` connection string parameter is only + supported by the ``nodejs`` driver and Compass. This option + allows Compass to display collections which have invalid UTF8 + data. To set this parameter you can pass set the ``enableUtf8Validation`` + parameter in the connection string or use the advanced connections + tab in Compass. + For example: + + ```mongodb://localhost:27017/?enableUtf8Validation=True`` + .. step:: Click Connect. .. seealso:: From 8e477aa9d5fe8f46b47d9bbec051474a0570b17c Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 15:34:00 -0500 Subject: [PATCH 03/38] * --- .../advanced-connection-options/advanced-connection.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index a46c0eb91..de6976671 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -106,7 +106,7 @@ Procedure .. note:: - The ``enableUtf8Validation`` connection string parameter is only + The ``enableUtf8Validation`` URI option is only supported by the ``nodejs`` driver and Compass. This option allows Compass to display collections which have invalid UTF8 data. To set this parameter you can pass set the ``enableUtf8Validation`` @@ -115,7 +115,7 @@ Procedure For example: - ```mongodb://localhost:27017/?enableUtf8Validation=True`` + ``mongodb://localhost:27017/?enableUtf8Validation=True`` .. step:: Click Connect. From 70e9327d2f1310b4146c883c3102f7207f74e11b Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 15:42:07 -0500 Subject: [PATCH 04/38] * --- .../advanced-connection.txt | 41 +++++++++++-------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index de6976671..3d25688c9 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -12,15 +12,25 @@ Advanced Connection Tab :depth: 1 :class: singlecol - The :guilabel:`Advanced` connection tab provides additional connection options for your deployment. These options can be used with the :ref:`General `, :ref:`Authentication `, :ref:`TLS / SSL `, and :ref:`Proxy / SSH Tunnel ` connection options. -Procedure ---------- + +About this Task +--------------- + +The ``enableUtf8Validation`` URI option is only +supported by the ``nodejs`` driver and Compass. This option +allows Compass to display collections which have invalid UTF8 +data. To set this parameter you can pass set the ``enableUtf8Validation`` +parameter in the connection string or use the advanced connections +tab in Compass. For details, see :ref:`compass-advanced-connection-examples`. + +Steps +----- .. procedure:: :style: normal @@ -104,21 +114,20 @@ Procedure For more information, see :manual:`Connection String Options `. - .. note:: - - The ``enableUtf8Validation`` URI option is only - supported by the ``nodejs`` driver and Compass. This option - allows Compass to display collections which have invalid UTF8 - data. To set this parameter you can pass set the ``enableUtf8Validation`` - parameter in the connection string or use the advanced connections - tab in Compass. - - For example: - - ``mongodb://localhost:27017/?enableUtf8Validation=True`` - .. step:: Click Connect. .. seealso:: To disconnect from your deployment, see :ref:``. + +.. _compass-advanced-connection-examples: + +Example +------- + +The following code shows an example of a connection string that uses +utf8 validation: + +.. code-block:: javascript + + mongodb://localhost:27017/?enableUtf8Validation=True From eb827f85f1822b946d2027e354b2622faee1283a Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 15:46:13 -0500 Subject: [PATCH 05/38] * --- .../advanced-connection-options/advanced-connection.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index 3d25688c9..11a6b5846 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -27,7 +27,8 @@ supported by the ``nodejs`` driver and Compass. This option allows Compass to display collections which have invalid UTF8 data. To set this parameter you can pass set the ``enableUtf8Validation`` parameter in the connection string or use the advanced connections -tab in Compass. For details, see :ref:`compass-advanced-connection-examples`. +tab in Compass. For details, see +:ref:`disable UTF-8 Validation`. Steps ----- @@ -125,9 +126,9 @@ Steps Example ------- -The following code shows an example of a connection string that uses -utf8 validation: +The following code shows an example of a connection string that disables +UTF8 validation: .. code-block:: javascript - mongodb://localhost:27017/?enableUtf8Validation=True + mongodb://localhost:27017/?enableUtf8Validation=False From 146e9a91143f6d6eef856948ef369915ec515bdc Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 15:47:49 -0500 Subject: [PATCH 06/38] * --- .../advanced-connection-options/advanced-connection.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index 11a6b5846..cc9f4d6f9 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -126,8 +126,7 @@ Steps Example ------- -The following code shows an example of a connection string that disables -UTF8 validation: +The following connection string disables UTF8 validation: .. code-block:: javascript From 2a34672bae9888178b72eb35bebe2ddfe67274ee Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 15:51:19 -0500 Subject: [PATCH 07/38] * --- .../advanced-connection-options/advanced-connection.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index cc9f4d6f9..69e991bd7 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -131,3 +131,10 @@ The following connection string disables UTF8 validation: .. code-block:: javascript mongodb://localhost:27017/?enableUtf8Validation=False + +.. note:: + + You can also disable this option in the + :guilabel:`Advanced Connection Options` by + selecting the key :guilabel:`enableUtf8Validation` and typing + the value ``False``. From aebb56386004190282a6b41e4004a440dfd8a7b0 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 15:56:06 -0500 Subject: [PATCH 08/38] * --- .../advanced-connection-options/advanced-connection.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index 69e991bd7..91ff621c8 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -25,8 +25,8 @@ About this Task The ``enableUtf8Validation`` URI option is only supported by the ``nodejs`` driver and Compass. This option allows Compass to display collections which have invalid UTF8 -data. To set this parameter you can pass set the ``enableUtf8Validation`` -parameter in the connection string or use the advanced connections +data. To set this parameter you can set the ``enableUtf8Validation`` +value in the connection string or use the advanced connections tab in Compass. For details, see :ref:`disable UTF-8 Validation`. From 5f4dd70ed3979aa50525b81a6d672b93004c341a Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 16:14:23 -0500 Subject: [PATCH 09/38] * --- .../advanced-connection-options/advanced-connection.txt | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index 91ff621c8..a4938d3b8 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -22,12 +22,9 @@ for your deployment. These options can be used with the About this Task --------------- -The ``enableUtf8Validation`` URI option is only -supported by the ``nodejs`` driver and Compass. This option -allows Compass to display collections which have invalid UTF8 -data. To set this parameter you can set the ``enableUtf8Validation`` -value in the connection string or use the advanced connections -tab in Compass. For details, see +The ``enableUtf8Validation`` URI option is supported by the ``nodejs`` +driver and Compass. This option allows Compass to display collections +which have invalid UTF8 data. For details, see :ref:`disable UTF-8 Validation`. Steps From 66568375d5284fed8f6a8eca513a9cfa27e33511 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 16:19:07 -0500 Subject: [PATCH 10/38] * --- .../advanced-connection-options/advanced-connection.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index a4938d3b8..c14ee4045 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -22,10 +22,11 @@ for your deployment. These options can be used with the About this Task --------------- -The ``enableUtf8Validation`` URI option is supported by the ``nodejs`` -driver and Compass. This option allows Compass to display collections -which have invalid UTF8 data. For details, see -:ref:`disable UTF-8 Validation`. +The ``enableUtf8Validation`` URI option is supported by the +:driver:`Node ` driver and Compass. This option allows +Compass to display collections that have invalid UTF8 data. For details, +see +:ref:`disabling UTF-8 Validation`. Steps ----- From 9492a16e4ff7db1296ffbeb6514b9227849dc88b Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 16:25:06 -0500 Subject: [PATCH 11/38] * --- .../advanced-connection-options/advanced-connection.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index c14ee4045..50551f956 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -22,10 +22,9 @@ for your deployment. These options can be used with the About this Task --------------- -The ``enableUtf8Validation`` URI option is supported by the -:driver:`Node ` driver and Compass. This option allows -Compass to display collections that have invalid UTF8 data. For details, -see +The ``enableUtf8Validation`` URI option is supported Compass. This +option allows Compass to display collections that have invalid UTF8 +data. For details, see :ref:`disabling UTF-8 Validation`. Steps From 2bc5c32138f7c45828902684ef9318e3b606cb00 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 16:28:06 -0500 Subject: [PATCH 12/38] * --- .../connect/advanced-connection-options/advanced-connection.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index 50551f956..82b70aa48 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -133,5 +133,5 @@ The following connection string disables UTF8 validation: You can also disable this option in the :guilabel:`Advanced Connection Options` by - selecting the key :guilabel:`enableUtf8Validation` and typing + selecting the key :guilabel:`enableUtf8Validation` and entering the value ``False``. From 322d4842304e4fcc74addb68c2855245e0028af1 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Mon, 6 Nov 2023 16:28:51 -0500 Subject: [PATCH 13/38] * --- .../connect/advanced-connection-options/advanced-connection.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index 82b70aa48..aeb5fbc3d 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -22,7 +22,7 @@ for your deployment. These options can be used with the About this Task --------------- -The ``enableUtf8Validation`` URI option is supported Compass. This +The ``enableUtf8Validation`` URI option is supported by Compass. This option allows Compass to display collections that have invalid UTF8 data. For details, see :ref:`disabling UTF-8 Validation`. From 82e58842cc63427bbe4db4ec9f526b6ce38651a4 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Tue, 7 Nov 2023 08:58:30 -0500 Subject: [PATCH 14/38] * --- .../advanced-connection-options/advanced-connection.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index aeb5fbc3d..34e9445ee 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -127,11 +127,11 @@ The following connection string disables UTF8 validation: .. code-block:: javascript - mongodb://localhost:27017/?enableUtf8Validation=False + mongodb://localhost:27017/?enableUtf8Validation=false .. note:: You can also disable this option in the :guilabel:`Advanced Connection Options` by selecting the key :guilabel:`enableUtf8Validation` and entering - the value ``False``. + the value ``false``. From db5184161ebad28a9efd06b0a254c359c3c69c58 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 15:56:36 -0500 Subject: [PATCH 15/38] * --- .../advanced-connection.txt | 40 ++++++++----------- 1 file changed, 16 insertions(+), 24 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index 34e9445ee..c7dde8bc3 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -18,28 +18,19 @@ for your deployment. These options can be used with the `, :ref:`TLS / SSL `, and :ref:`Proxy / SSH Tunnel ` connection options. - -About this Task ---------------- - -The ``enableUtf8Validation`` URI option is supported by Compass. This -option allows Compass to display collections that have invalid UTF8 -data. For details, see -:ref:`disabling UTF-8 Validation`. - Steps ----- .. procedure:: :style: normal - .. step:: Click :guilabel:`Advanced Connection Options`. + .. step:: Click :guilabel:`Advanced Connection Options` .. figure:: /images/compass/advanced-connection-options.png :figwidth: 690px :alt: New Advanced Connection Options - .. step:: Click the :guilabel:`Advanced` tab. + .. step:: Click the :guilabel:`Advanced` tab (Optional) Select a :guilabel:`Read Preference` from the following options: @@ -114,24 +105,25 @@ Steps .. step:: Click Connect. -.. seealso:: + .. step:: (Optional) Resolve Data Display Issues - To disconnect from your deployment, see :ref:``. + If Compass is having issues displaying data and returning the error + message ``Invalid UTF-8 string in BSON document.``, you can set the + ``enableUtf8Validation`` URI option. -.. _compass-advanced-connection-examples: + The following connection string disables UTF8 validation: -Example -------- + .. code-block:: javascript -The following connection string disables UTF8 validation: + mongodb://localhost:27017/?enableUtf8Validation=false -.. code-block:: javascript + .. note:: - mongodb://localhost:27017/?enableUtf8Validation=false + You can also disable this option in the + :guilabel:`Advanced Connection Options` by + selecting the key :guilabel:`enableUtf8Validation` and entering + the value ``false``. -.. note:: +.. seealso:: - You can also disable this option in the - :guilabel:`Advanced Connection Options` by - selecting the key :guilabel:`enableUtf8Validation` and entering - the value ``false``. + To disconnect from your deployment, see :ref:``. From f127909a39fb90803fc7b9ed677b1aae40d51cd8 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:05:24 -0500 Subject: [PATCH 16/38] * --- .../advanced-connection.txt | 19 ------------------- source/includes/fact-non-utf8-data.rst | 17 +++++++++++++++++ source/query/filter.txt | 6 ++++++ 3 files changed, 23 insertions(+), 19 deletions(-) create mode 100644 source/includes/fact-non-utf8-data.rst diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index c7dde8bc3..ad6f9f4a1 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -105,25 +105,6 @@ Steps .. step:: Click Connect. - .. step:: (Optional) Resolve Data Display Issues - - If Compass is having issues displaying data and returning the error - message ``Invalid UTF-8 string in BSON document.``, you can set the - ``enableUtf8Validation`` URI option. - - The following connection string disables UTF8 validation: - - .. code-block:: javascript - - mongodb://localhost:27017/?enableUtf8Validation=false - - .. note:: - - You can also disable this option in the - :guilabel:`Advanced Connection Options` by - selecting the key :guilabel:`enableUtf8Validation` and entering - the value ``false``. - .. seealso:: To disconnect from your deployment, see :ref:``. diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst new file mode 100644 index 000000000..940dac84c --- /dev/null +++ b/source/includes/fact-non-utf8-data.rst @@ -0,0 +1,17 @@ +If Compass is having issues displaying data and returning the error +message: ``Invalid UTF-8 string in BSON document``, you can set the +``enableUtf8Validation`` URI option to ``false``. + +The following connection string disables UTF8 validation with the URI +parameter: + +.. code-block:: javascript + + mongodb://localhost:27017/?enableUtf8Validation=false + +.. note:: + + You can also disable this option in the + :guilabel:`Advanced Connection Options` by + selecting the key :guilabel:`enableUtf8Validation` and entering + the value ``false``. diff --git a/source/query/filter.txt b/source/query/filter.txt index b33843f06..4ad6b8c56 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -374,6 +374,12 @@ Clear the Query .. include:: /includes/clear-query.rst + +Querying Invalid Collections with UTF8 Data +------------------------------------------- + +.. include:: /includes/fact-non-utf8-data.rst + How Does the Compass Query Compare to MongoDB and SQL Queries? -------------------------------------------------------------- From 8a694f7ada67977addf7cf6b4cba18bbf7e9232b Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:06:32 -0500 Subject: [PATCH 17/38] * --- .../advanced-connection-options/advanced-connection.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index ad6f9f4a1..ceb0619f0 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -18,19 +18,19 @@ for your deployment. These options can be used with the `, :ref:`TLS / SSL `, and :ref:`Proxy / SSH Tunnel ` connection options. -Steps ------ +Procedure +--------- .. procedure:: :style: normal - .. step:: Click :guilabel:`Advanced Connection Options` + .. step:: Click :guilabel:`Advanced Connection Options`. .. figure:: /images/compass/advanced-connection-options.png :figwidth: 690px :alt: New Advanced Connection Options - .. step:: Click the :guilabel:`Advanced` tab + .. step:: Click the :guilabel:`Advanced` tab. (Optional) Select a :guilabel:`Read Preference` from the following options: From 65cbd9a20a6ea029b0ef0268fcdb63c13ae02597 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:06:56 -0500 Subject: [PATCH 18/38] * --- .../connect/advanced-connection-options/advanced-connection.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/source/connect/advanced-connection-options/advanced-connection.txt b/source/connect/advanced-connection-options/advanced-connection.txt index ceb0619f0..49c31ee86 100644 --- a/source/connect/advanced-connection-options/advanced-connection.txt +++ b/source/connect/advanced-connection-options/advanced-connection.txt @@ -12,6 +12,7 @@ Advanced Connection Tab :depth: 1 :class: singlecol + The :guilabel:`Advanced` connection tab provides additional connection options for your deployment. These options can be used with the :ref:`General `, :ref:`Authentication From a147352c06c79f780abd0908e3849641495018b7 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:08:11 -0500 Subject: [PATCH 19/38] * --- source/includes/fact-non-utf8-data.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 940dac84c..09eeb35b6 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -2,8 +2,7 @@ If Compass is having issues displaying data and returning the error message: ``Invalid UTF-8 string in BSON document``, you can set the ``enableUtf8Validation`` URI option to ``false``. -The following connection string disables UTF8 validation with the URI -parameter: +The following URI disables UTF8 validation: .. code-block:: javascript From b62934f36461d08fef81e2bd890a0f53f44c2318 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:09:08 -0500 Subject: [PATCH 20/38] * --- source/query/filter.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/query/filter.txt b/source/query/filter.txt index 4ad6b8c56..81f1e15ff 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -375,7 +375,7 @@ Clear the Query .. include:: /includes/clear-query.rst -Querying Invalid Collections with UTF8 Data +Querying Collections with Invalid UTF8 Data ------------------------------------------- .. include:: /includes/fact-non-utf8-data.rst From bb2ac51ba47470af46ef41e197c89656dc13c18e Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:10:15 -0500 Subject: [PATCH 21/38] * --- source/query/filter.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/source/query/filter.txt b/source/query/filter.txt index 81f1e15ff..85b7eb0fd 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -374,6 +374,7 @@ Clear the Query .. include:: /includes/clear-query.rst +.. _compass-query-invalid-utf8-data: Querying Collections with Invalid UTF8 Data ------------------------------------------- From 19e610b79fa693014773e0a0fc6e0f7be28d29bb Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:11:28 -0500 Subject: [PATCH 22/38] * --- source/query/filter.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/query/filter.txt b/source/query/filter.txt index 85b7eb0fd..487f11636 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -376,8 +376,8 @@ Clear the Query .. _compass-query-invalid-utf8-data: -Querying Collections with Invalid UTF8 Data -------------------------------------------- +Query Collections with Invalid UTF8 Data +---------------------------------------- .. include:: /includes/fact-non-utf8-data.rst From 26bfd4ba007ced8ac8ba9a970ebe824d19146740 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:17:05 -0500 Subject: [PATCH 23/38] * --- source/includes/fact-non-utf8-data.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 09eeb35b6..959db7d53 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -1,6 +1,7 @@ -If Compass is having issues displaying data and returning the error -message: ``Invalid UTF-8 string in BSON document``, you can set the -``enableUtf8Validation`` URI option to ``false``. +If Compass encounters data display issues when querying your data +with the error message: ``Invalid UTF-8 string in BSON document``. You +can disable UTF8 validation by setting the ``enableUtf8Validation`` +URI option to false. The following URI disables UTF8 validation: From 1042cb439df7717b54f0cd239cf57cddb4a04b5c Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 8 Nov 2023 16:18:17 -0500 Subject: [PATCH 24/38] * --- source/includes/fact-non-utf8-data.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 959db7d53..f4684640b 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -1,7 +1,7 @@ If Compass encounters data display issues when querying your data with the error message: ``Invalid UTF-8 string in BSON document``. You can disable UTF8 validation by setting the ``enableUtf8Validation`` -URI option to false. +URI option to ``false``. The following URI disables UTF8 validation: From b7ec513c5dc4b61e2845f51ff24943cb3fb8e355 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:26:28 -0500 Subject: [PATCH 25/38] * --- source/includes/fact-non-utf8-data.rst | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index f4684640b..e97ab6313 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -1,6 +1,20 @@ -If Compass encounters data display issues when querying your data -with the error message: ``Invalid UTF-8 string in BSON document``. You -can disable UTF8 validation by setting the ``enableUtf8Validation`` +Compass can have issues displaying collections if documents within +the collection have invalid UTF8 characters. + +- If you query this data, the following error message displays: + +.. warning:: + + Invalid UTF-8 string in BSON document. + +- If you attempt to export the collection, the error message: + + .. warning:: + + An error occurred while loading instance info: Invalid UTF-8 + string in BSON document. + +You can disable UTF8 validation by setting the ``enableUtf8Validation`` URI option to ``false``. The following URI disables UTF8 validation: From 7d745d33d479f4975aadf10ab02e68e8378af320 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:49:19 -0500 Subject: [PATCH 26/38] * --- source/includes/fact-non-utf8-data.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index e97ab6313..5133cb356 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -3,16 +3,24 @@ the collection have invalid UTF8 characters. - If you query this data, the following error message displays: -.. warning:: + .. warning:: Invalid UTF-8 string in BSON document. - If you attempt to export the collection, the error message: .. warning:: - - An error occurred while loading instance info: Invalid UTF-8 - string in BSON document. + + .. code-block:: none + + An error occurred while loading instance info: Invalid UTF-8 + string in BSON document. + +.. error:: 10167 + + :message: "can't move shard to its current location!" + :throws: UserException + :module: :source:`src/mongo/s/chunk.cpp#L305` You can disable UTF8 validation by setting the ``enableUtf8Validation`` URI option to ``false``. From bb29a68d004193dc51056e9c220bd47c1b4a9620 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:56:41 -0500 Subject: [PATCH 27/38] * --- source/includes/fact-non-utf8-data.rst | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 5133cb356..72178a8c0 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -3,24 +3,17 @@ the collection have invalid UTF8 characters. - If you query this data, the following error message displays: - .. warning:: +.. code-block:: none - Invalid UTF-8 string in BSON document. + Invalid UTF-8 string in BSON document. -- If you attempt to export the collection, the error message: +- If you attempt to export the collection, the following error message + displays: - .. warning:: +.. code-block:: none - .. code-block:: none - - An error occurred while loading instance info: Invalid UTF-8 - string in BSON document. - -.. error:: 10167 - - :message: "can't move shard to its current location!" - :throws: UserException - :module: :source:`src/mongo/s/chunk.cpp#L305` + An error occurred while loading instance info: Invalid UTF-8 + string in BSON document. You can disable UTF8 validation by setting the ``enableUtf8Validation`` URI option to ``false``. From 578b2a91503966135120cd83829f3d7a221a00ad Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:59:09 -0500 Subject: [PATCH 28/38] * --- source/includes/fact-non-utf8-data.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 72178a8c0..ddb988f07 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -3,17 +3,17 @@ the collection have invalid UTF8 characters. - If you query this data, the following error message displays: -.. code-block:: none + .. code-block:: none - Invalid UTF-8 string in BSON document. + Invalid UTF-8 string in BSON document. - If you attempt to export the collection, the following error message displays: -.. code-block:: none + .. code-block:: none - An error occurred while loading instance info: Invalid UTF-8 - string in BSON document. + An error occurred while loading instance info: Invalid UTF-8 + string in BSON document. You can disable UTF8 validation by setting the ``enableUtf8Validation`` URI option to ``false``. From ddd8032a59b7e80c9dd402dfe10eeca40cc301a2 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:06:16 -0500 Subject: [PATCH 29/38] * --- source/includes/fact-non-utf8-data.rst | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index ddb988f07..6d41ffedd 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -1,22 +1,17 @@ Compass can have issues displaying collections if documents within the collection have invalid UTF8 characters. -- If you query this data, the following error message displays: +If you attemp to query or export this data, the following error +message displays: - .. code-block:: none +.. code-block:: none + :copyable: false - Invalid UTF-8 string in BSON document. + Invalid UTF-8 string in BSON document. -- If you attempt to export the collection, the following error message - displays: - - .. code-block:: none - - An error occurred while loading instance info: Invalid UTF-8 - string in BSON document. - -You can disable UTF8 validation by setting the ``enableUtf8Validation`` -URI option to ``false``. +In order to query or export this data, you can disable +UTF8 validation by setting the ``enableUtf8Validation`` URI option to +``false``. The following URI disables UTF8 validation: From a47913baaf9c42515715670e9679bff7b359ffd1 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:16:43 -0500 Subject: [PATCH 30/38] * --- source/includes/fact-non-utf8-data.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 6d41ffedd..d5b234d5b 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -1,7 +1,7 @@ -Compass can have issues displaying collections if documents within -the collection have invalid UTF8 characters. +Compass can have issues displaying collections if documents have +invalid UTF8 characters. -If you attemp to query or export this data, the following error +If you attempt to query or export this data, the following error message displays: .. code-block:: none From a4915f3073a96ce1348ac8f7a65ec0fdfda5b8b9 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:28:40 -0500 Subject: [PATCH 31/38] * --- source/includes/fact-non-utf8-data.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index d5b234d5b..a107d7962 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -19,6 +19,12 @@ The following URI disables UTF8 validation: mongodb://localhost:27017/?enableUtf8Validation=false +.. warning:: + + Editing data with ``enableUtf8Validation=false`` can result in + potential loss of data. This approach should be used as a temporary + workaround only. + .. note:: You can also disable this option in the From ed5ceb92bb24568c8e608dc1e8538652734e14bb Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:32:04 -0500 Subject: [PATCH 32/38] * --- source/includes/fact-non-utf8-data.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index a107d7962..8f3086233 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -13,17 +13,18 @@ In order to query or export this data, you can disable UTF8 validation by setting the ``enableUtf8Validation`` URI option to ``false``. +.. warning:: + + Editing data with ``enableUtf8Validation=false`` can result in + potential loss of data. This approach should be used as a temporary + workaround to query and export data only. + The following URI disables UTF8 validation: .. code-block:: javascript mongodb://localhost:27017/?enableUtf8Validation=false -.. warning:: - - Editing data with ``enableUtf8Validation=false`` can result in - potential loss of data. This approach should be used as a temporary - workaround only. .. note:: From b5983699c0bd60257e90d0b980139851b6066bd2 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:33:39 -0500 Subject: [PATCH 33/38] * --- source/includes/fact-non-utf8-data.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 8f3086233..53cd9792f 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -15,9 +15,9 @@ UTF8 validation by setting the ``enableUtf8Validation`` URI option to .. warning:: - Editing data with ``enableUtf8Validation=false`` can result in + *Editing data* with ``enableUtf8Validation=false`` can result in potential loss of data. This approach should be used as a temporary - workaround to query and export data only. + workaround to query or export data only. The following URI disables UTF8 validation: From 9c82933530c14a9658b4d9ff13eb515114cc4f9e Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:35:50 -0500 Subject: [PATCH 34/38] * --- source/includes/fact-non-utf8-data.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 53cd9792f..bf6cf0b0c 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -15,7 +15,7 @@ UTF8 validation by setting the ``enableUtf8Validation`` URI option to .. warning:: - *Editing data* with ``enableUtf8Validation=false`` can result in + **Editing data** with ``enableUtf8Validation=false`` can result in potential loss of data. This approach should be used as a temporary workaround to query or export data only. From d5e3d2d6101a75a2014c2e05fc61f516a74cec9e Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Thu, 16 Nov 2023 11:36:22 -0500 Subject: [PATCH 35/38] * --- source/includes/fact-non-utf8-data.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index bf6cf0b0c..f3daa86bb 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -16,8 +16,8 @@ UTF8 validation by setting the ``enableUtf8Validation`` URI option to .. warning:: **Editing data** with ``enableUtf8Validation=false`` can result in - potential loss of data. This approach should be used as a temporary - workaround to query or export data only. + potential loss of data. This approach is a temporary workaround to + query or export data only. The following URI disables UTF8 validation: From 3c957ba770422a92f43e7dabd923093214d5aa42 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Thu, 16 Nov 2023 11:41:14 -0500 Subject: [PATCH 36/38] * --- source/includes/fact-non-utf8-data.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index f3daa86bb..baa887711 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -29,6 +29,6 @@ The following URI disables UTF8 validation: .. note:: You can also disable this option in the - :guilabel:`Advanced Connection Options` by + :ref:`Advanced Connection Options ` by selecting the key :guilabel:`enableUtf8Validation` and entering the value ``false``. From 6451371c7a4f4f94f5c890f3e77e112a8d8afff3 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 6 Dec 2023 12:05:21 -0500 Subject: [PATCH 37/38] Apply suggestions from code review Co-authored-by: Sarah Olson <98367156+sarah-olson-mongodb@users.noreply.github.com> --- source/includes/fact-non-utf8-data.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index baa887711..19ab6586d 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -30,5 +30,5 @@ The following URI disables UTF8 validation: You can also disable this option in the :ref:`Advanced Connection Options ` by - selecting the key :guilabel:`enableUtf8Validation` and entering - the value ``false``. + selecting :guilabel:`enableUtf8Validation` and entering + ``false``. From be044c426992a2be6e7aa357afb70d8b0f49b8d4 Mon Sep 17 00:00:00 2001 From: ianf-mongodb <85948430+ianf-mongodb@users.noreply.github.com> Date: Wed, 6 Dec 2023 12:09:41 -0500 Subject: [PATCH 38/38] * --- source/includes/fact-non-utf8-data.rst | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/source/includes/fact-non-utf8-data.rst b/source/includes/fact-non-utf8-data.rst index 19ab6586d..3f261d5db 100644 --- a/source/includes/fact-non-utf8-data.rst +++ b/source/includes/fact-non-utf8-data.rst @@ -1,22 +1,18 @@ -Compass can have issues displaying collections if documents have -invalid UTF8 characters. - -If you attempt to query or export this data, the following error -message displays: +If you attempt to query or export data with invalid UTF8 characters +the following error message displays: .. code-block:: none :copyable: false Invalid UTF-8 string in BSON document. -In order to query or export this data, you can disable -UTF8 validation by setting the ``enableUtf8Validation`` URI option to -``false``. +To query or export this data, disable UTF8 validation by setting +the ``enableUtf8Validation`` URI option to ``false``. .. warning:: **Editing data** with ``enableUtf8Validation=false`` can result in - potential loss of data. This approach is a temporary workaround to + loss of data. This approach is a temporary workaround to query or export data only. The following URI disables UTF8 validation: