Update docs to use list_collection_names method #401
Closed
Conversation
This file contains 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
I encountered DeprecationWarning: collection_names is deprecated. This is a simple name change, but we could also explain the deprecation in detail in an aside or blockquote.
ShaneHarvey
reviewed
Mar 23, 2019
| @@ -142,7 +142,7 @@ of the collections in our database: | |||
|
|
|||
| .. doctest:: | |||
|
|
|||
| >>> db.collection_names(include_system_collections=False) | |||
| >>> db.list_collection_names(include_system_collections=False) | |||
There was a problem hiding this comment.
Thanks for finding this issue! It also made me realize that we didn't properly implement the Enumerate Collections Specification. I fixed that by adding support for filter argument in https://jira.mongodb.org/browse/PYTHON-1784.
Can you replace the include_system_collections parameter with a filter that only matches non-system collections, like this:
>>> db.list_collection_names(filter={"name": {"$regex": r"^(?!system\.)"}})
[u'posts']
There was a problem hiding this comment.
I just realized that for this doctest it's fine to just remove the include_system_collections=False. We only run the doctests on 4.0+ so we don't need to worry about system collections like (system.indexes) showing up in the results.
ShaneHarvey
pushed a commit
that referenced
this pull request
Mar 28, 2019
db.collection_names() is deprecated.
ShaneHarvey
pushed a commit
that referenced
this pull request
Mar 28, 2019
db.collection_names() is deprecated. (cherry picked from commit 66eb6da)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I encountered DeprecationWarning: collection_names is deprecated.
This is a simple name change, but we could also explain the
deprecation in detail in an aside or blockquote.