pymongoexplain 1.2.0

关于

这个包提供了一个ExplainableCollection类，可以解释PyMongo 的 Collection 方法

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')]))

在 PyMongo 之后解释：

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

安装

要安装这个包，只需使用 pip：

pip install pymongoexplain

支持/反馈

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

错误/功能请求

认为你发现了一个错误？想查看 PyMongoExplain 中的新功能吗？请在此GitHub 存储库上打开一个问题。

依赖项

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

PyMongoExplain 需要PyMongo>=3.10,<4

测试

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

教程

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

要对命令运行解释，首先从最初用于运行命令的Collection对象中实例化一个ExplainableCollection ：

from pymongoexplain import ExplainableCollection

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

如果您希望为 explain 命令本身配置选项，请将它们传递给ExplainableCollection构造函数，如下所示：

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

有关详细信息，请参阅说明命令的文档。

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

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

现在结果将包含在给定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=...)