Skip to content

Commit a0befac

Browse files
authored
DOCS-11661: Add a warning to discourage people from setting failIndexKeyTooLong (#3423)
1 parent 2632c40 commit a0befac

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

source/reference/parameters.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -558,6 +558,14 @@ General Parameters
558558
upgrade and then gradually resolve these indexing issues, you can
559559
use :parameter:`failIndexKeyTooLong` to disable this behavior.
560560

561+
.. important::
562+
563+
Setting :parameter:`failIndexKeyTooLong` to ``false`` is
564+
a temporary workaround, not a permanent solution to the
565+
problem of oversized index keys. Leaving
566+
indexes in place which contain oversized keys is not
567+
recommended because they may return incomplete results.
568+
561569
:parameter:`failIndexKeyTooLong` defaults to ``true``. When
562570
``false``, a 2.6 :binary:`~bin.mongod` instance will provide the 2.4
563571
behavior.

0 commit comments

Comments
 (0)