disqualifier
51592567e1
- update_document_field/update_document_operator/document_pop_array return matched_count > 0, so an idempotent write that matched a doc but changed nothing ( to the same value, of an absent value) reports success instead of False (L19) - document the bare-proxy escape hatch is mongo.collection(name) not mongo[name], and that get_document_hashmap/get_document_fields skip docs missing the key (nits). Signed-off-by: disqualifier <dev@disqualifier.me>
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
# mongo
|
|
|
|
Async MongoDB wrapper over [motor](https://motor.readthedocs.io/). Thin, opinionated
|
|
helpers for the common paths, with a raw escape hatch for everything else.
|
|
|
|
## Install
|
|
|
|
`requirements.txt`:
|
|
|
|
```
|
|
mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.2
|
|
```
|
|
|
|
Direct:
|
|
|
|
```bash
|
|
pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.2"
|
|
```
|
|
|
|
Requires `motor` and `pymongo` (pulled transitively).
|
|
|
|
## Usage
|
|
|
|
**Object (preferred)** — one client per process:
|
|
|
|
```python
|
|
from mongo import Mongo
|
|
|
|
db = Mongo(conn_string, database) # attach as bot.db / app.db
|
|
users = await db.get_documents("users", {"active": True})
|
|
db.close() # on shutdown (sync)
|
|
```
|
|
|
|
**Module proxy (back-compat)** — arm once, then call bare:
|
|
|
|
```python
|
|
import mongo # NOT `from mongo import ...`
|
|
mongo.init(conn_string, database)
|
|
users = await mongo.get_documents("users", {"active": True})
|
|
```
|
|
|
|
Both styles share one client. The proxy exists so legacy call sites keep working
|
|
after a one-line `init()`; new code should use the object.
|
|
|
|
## Error contract
|
|
|
|
- **Wrapped methods** log-and-swallow exceptions and return a safe default
|
|
(`False` / `[]` / `{}` / `0` / `None`). Branch on the result.
|
|
- **`db.collection(name)`** (or `db[name]`) returns the raw motor collection:
|
|
full driver surface, no swallowing, **raises**. Use it for anything not wrapped
|
|
(`find_one_and_*` beyond what's exposed, change streams, complex bulk ops).
|
|
|
|
## API
|
|
|
|
See the module docstring and method docstrings in `mongo.py` — that's the source
|
|
of truth. Grouped as: collection/index management, create, read, update, delete,
|
|
bulk, checks. Atomic ops (`find_one_and_update/replace/delete`) and `bulk_write`
|
|
are included.
|
|
|
|
## Gotchas
|
|
|
|
- `from mongo import func` won't see the proxy (resolved at import, before `init`).
|
|
Use `import mongo` then `mongo.func(...)`.
|
|
- `find_one_and_update` returns the **after** image by default (`return_after=True`).
|
|
- `bulk_write` takes pymongo ops the caller builds:
|
|
```python
|
|
from pymongo import UpdateOne
|
|
ops = [UpdateOne({"_id": i}, {"$set": {...}}, upsert=True) for i in ids]
|
|
await db.bulk_write("col", ops)
|
|
```
|
|
|
|
## Versioning
|
|
|
|
Tagged `vX.Y.Z`. Pin the tag in `requirements.txt`; bump deliberately. |