PYTHON-3298 Add flag to create_collection to skip listCollections pre-check #1006
Conversation
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
ShaneHarvey
requested changes
Jul 15, 2022
pymongo/database.py
Outdated
| @@ -342,7 +342,8 @@ def create_collection( | |||
| All optional `create collection command`_ parameters should be passed | |||
| as keyword arguments to this method. Valid options include, but are not | |||
| limited to: | |||
|
|
|||
| - ``checkExists`` (bool): if True (the default) , send a listCollections command to check | |||
| if the collection already exists before creation. | |||
There was a problem hiding this comment.
checkExists is not a create command option so it should be an explicit check_exists argument.
| @@ -202,23 +202,14 @@ class OvertCommandListener(EventListener): | |||
| ignore_list_collections = False | |||
|
|
|||
| def started(self, event): | |||
| if self.ignore_list_collections and event.command_name.lower() == "listcollections": | |||
| self.ignore_list_collections = False | |||
| return | |||
pymongo/database.py
Outdated
| @@ -402,7 +403,7 @@ def create_collection( | |||
| enabling pre- and post-images. | |||
|
|
|||
| .. versionchanged:: 4.2 | |||
| Added the ``clusteredIndex`` and ``encryptedFields`` parameters. | |||
| Added the ``checkExists``, ``clusteredIndex``, and ``encryptedFields`` parameters. | |||
There was a problem hiding this comment.
Can you add a note in the changelog too?
ShaneHarvey
requested changes
Jul 18, 2022
test/test_database.py
Outdated
| def test_check_exists(self): | ||
| client = rs_or_single_client() | ||
| db = client[self.db.name] | ||
| with mock.patch.object(db, "list_collections") as m: |
There was a problem hiding this comment.
We should use a command listener instead of mock patching. mocking makes the driver harder to maintain since it ties the test to internal details of the driver implementation. For example, if we wanted to refactor create_collection() to call db._list_collections instead of db.list_collections we would need to update this test as well.
pymongo/database.py
Outdated
| @@ -421,6 +424,7 @@ def create_collection( | |||
| https://mongodb.com/docs/manual/reference/command/create | |||
| """ | |||
| encrypted_fields = kwargs.get("encryptedFields") | |||
|
|
|||
test/test_database.py
Outdated
| @@ -220,6 +221,18 @@ def test_list_collection_names_filter(self): | |||
| self.assertIn("nameOnly", command) | |||
| self.assertTrue(command["nameOnly"]) | |||
|
|
|||
| def test_check_exists(self): | |||
| client = rs_or_single_client() | |||
ShaneHarvey
requested changes
Jul 18, 2022
test/test_database.py
Outdated
| db = client[self.db.name] | ||
| db.drop_collection("unique") | ||
| db.create_collection("unique", check_exists=True) | ||
| self.assertIn("listCollections", [next(iter(x.command)) for x in results["started"]]) |
There was a problem hiding this comment.
We should use listeners.started_command_names() and listener.reset().
ShaneHarvey
approved these changes
Jul 18, 2022
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.
No description provided.