-
Notifications
You must be signed in to change notification settings - Fork 1.7k
DOCS-564 added collection-naming conventions #281
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.
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -303,6 +303,60 @@ See: :issue:`SERVER-6961` for more information. | |
Behavioral Changes | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
Restrictions on Collection Names | ||
```````````````````````````````` | ||
|
||
In version 2.2, collection names cannot contain the ``$`` character. The | ||
character is still allowed for collection names in MongoDB versions | ||
prior to 2.2. | ||
|
||
The following is a full list of collection-name restrictions. Collection | ||
names can be any UTF-8 string with the following exceptions: | ||
|
||
- A collection name should begin with a letter or an underscore. | ||
|
||
- The empty string ("") is not a valid collection name. | ||
|
||
- Collection names cannot contain the ``$`` character. (version 2.2 only) | ||
|
||
- Collection names cannot contain the null character: ``\0`` | ||
|
||
- Do not name a collection using the ``system.`` prefix. The ``system.`` | ||
prefix is reserved for system collections, such as the | ||
``system.indexes`` collection. | ||
|
||
- The maximum size of a collection name is 128 characters, including the | ||
name of the db and indexes. A best practice is to keep your collection | ||
names below 80 characters. | ||
|
||
If your collection name includes special characters, such as the | ||
underscore character, then to access the collection use the | ||
:method:`db.getCollection()` method or a :api:`similar method for your | ||
driver <>`. | ||
|
||
.. example:: To create a collection ``_foo`` and populate it with | ||
document ``{ a : 1 }``, you would issue the following command: | ||
|
||
.. code-block:: javascript | ||
|
||
db.getCollection("_foo").insert( { a : 1 } ) | ||
|
||
To query the collection, you would issue the following command and | ||
get the following result: | ||
|
||
.. code-block:: javascript | ||
|
||
db.getCollection("_foo").find() | ||
{ "_id" : ObjectId("506dbf800f70bf70d1ca613b"), "a" : 1 } | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. omit the final example. |
||
If you were to query the ``_foo`` collection with dot notation, you | ||
would receive an error, as shown here: | ||
|
||
.. code-block:: javascript | ||
|
||
db._foo.find() | ||
Thu Oct 4 12:56:01 TypeError: db._foo has no properties (shell):1 | ||
|
||
Restrictions on Database Names for Windows | ||
`````````````````````````````````````````` | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needs literals