Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-16097

[SERVER] Document better the limitations of using "." inside field names

    XMLWordPrintableJSON

Details

    Description

      The documentation at Field Names with Periods (.) and Dollar Signs ($) — MongoDB Manual documents the changes done to version 5.0 as part of the PM-1856 initiative. The scope document (Scope: Mitigate pain of using field names with dots and dollars - Google Docs) says:

       

      • We should clearly state in our documentation that field names with dots and dollars are allowed, but discouraged, since some of the features may not be supported with such fields, such as indexing and FLE. Performance may also be suboptimal if field names have to be re-evaluated from an expression for each input document.

       

      but the documentation convert this action into a section

       

      General Restrictions

      In addition to the storage validation rules above, there are some general restrictions on using dollar ($) prefixed field names. These fields cannot:

      • Be indexed
      • Be used as part of a shard key
      • Be be modified with an escape sequence
      • Be used as a subfield in an _id document

       

      that begins with the "restrictions on using dollar ($) prefixed field names", hinting that fields containing dots in the name can be indexed or encrypted.

      The preamble to the restrictions section should be widened to include dots, without leaving the user with the doubt whether the entire page is for both cases or only for $-prefixed names

      Attachments

        Activity

          People

            Unassigned Unassigned
            alberto.massari@mongodb.com Alberto Massari
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              39 weeks, 5 days ago