Skip to content

MONGOID-5590 - Docs: Clarify that shard key dot limitation comes from MongoDB server (not the ODM) #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

MONGOID-5590 - Docs: Clarify that shard key dot limitation comes from MongoDB server (not the ODM) #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions source/configuration/sharding.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ key called ``country_id``, {+odm+} shards by that field:
:start-after: # start-shard-key-association
:end-before: # end-shard-key-association

You can specify a shard key on an embedded document by using dot notation to
delimit the field names. The following example creates a shard key on the
You can specify a shard key on an embedded document by using dot notation (``.``)
to delimit the field names. The following example creates a shard key on the
``address.city`` field:

.. literalinclude:: /includes/configuration/sharding.rb
Expand All @@ -121,9 +121,9 @@ delimit the field names. The following example creates a shard key on the

.. note::

Because the period (``.``) character is used to delimit embedded fields, {+odm+} does
not support creating shard keys on fields with names that contain a period
character.
Because the period (``.``) character is reserved for delimiting embedded fields,
MongoDB does not support creating shard keys on fields with names that contain a
period character.

Sharding Management Rake Tasks
------------------------------
Expand Down
Loading