pymongoexplain 1.2.0

关于

此包提供了一个ExplainableCollection类，允许解释PyMongo的集合方法

PyMongoExplain大大简化了解释命令所需的工作量。例如，假设我们想要解释以下update_one

collection.update_one({"quantity": 1057, "category": "apparel"},{"$set": {"reorder": True}})

在PyMongoExplain之前，需要将update_one转换为等效的MongoDB命令

collection.database.command(SON([('explain', SON([('update', 'products'), ('updates', [{'q': {'quantity': 1057, 'category': 'apparel'}, 'upsert': False, 'multi': False, 'u': {'$set': {'reorder': True}}}])])), ('verbosity', 'queryPlanner')]))

在PyMongoExplain之后

ExplainableCollection(collection).update_one({"quantity": 1057, "category": "apparel"},{"$set": {"reorder": True}})

安装

要安装此包，请使用pip

pip install pymongoexplain

支持/反馈

有关问题、讨论或一般技术支持，请访问MongoDB社区论坛。MongoDB社区论坛是与其他MongoDB用户建立联系、提出问题和获取答案的集中地点。

错误/功能请求

发现了一个bug吗？想在PyMongoExplain中看到新功能？请在此GitHub仓库上提交一个问题。

依赖项

PyMongoExplain需要CPython 3.5+和PyPy3.5+。

PyMongoExplain需要PyMongo>=3.10,<4

测试

运行测试的最简单方法是运行分发根目录下的python setup.py test。

教程

可以通过将现有的应用程序代码中的Collection对象替换为ExplainableCollection对象来解释PyMongo操作。该ExplainableCollection类提供了PyMongo的Collection提供的所有CRUD API方法，但使用此类运行操作会对它们进行解释，而不是执行它们。

要对命令运行解释，首先从原始用于运行命令的Collection对象实例化一个ExplainableCollection

from pymongoexplain import ExplainableCollection

collection = client.db.products
explain = ExplainableCollection(collection)

如果您想配置解释命令本身的可选参数，像这样将它们传递给ExplainableCollection构造函数

explain = ExplainableCollection(collection, verbosity="queryPlanner",
                                comment="I'm a comment")

有关更多信息，请参阅explain命令的文档。

现在您可以为一些命令进行解释了。请记住，解释一个命令并不会执行它

result = explain.update_one({"quantity": 1057, "category": "apparel"}, {"$set": {"reorder": True}})

现在result将包含运行给定update_one命令的解释输出

{'ok': 1.0,
 'operationTime': Timestamp(1595603051, 3),
 'queryPlanner': {'indexFilterSet': False,
                  'namespace': 'db.products',
                  'parsedQuery': {'$and': [{'category': {'$eq': 'apparel'}},
                                           {'quantity': {'$eq': 1057}}]},
                  'planCacheKey': 'CD8F6D8F',
                  'plannerVersion': 1,
                  'queryHash': 'CD8F6D8F',
                  'rejectedPlans': [],
                  'winningPlan': {'inputStage': {'direction': 'forward',
                                                 'filter': {'$and': [{'category': {'$eq': 'apparel'}},
                                                                     {'quantity': {'$eq': 1057}}]},
                                                 'stage': 'COLLSCAN'},
                                  'stage': 'UPDATE'}},
 'serverInfo': {'gitVersion': '27f5c1ee9f513f29fe30b8ebefed99581428c6e1',
                'host': 'Juliuss-MBP.verizon.net',
                'port': 27017,
                'version': '4.4.0-rc13'}}

由于ExplainableCollection实例提供了与Collection实例相同的方法，因此在您的应用程序代码中解释操作只需简单地将应用程序代码中的Collection实例替换为ExplainableCollection实例。

python3 -m pymongoexplain <path/to/your/script.py>

python3 -m pymongoexplain <path/to/your/script.py> [PARAMS] [--optname OPTS]

ExplainableCollection(collection).find({}).sort(...)

ExplainableCollection(collection).find({}, sort=...)