maggma icon indicating copy to clipboard operation
maggma copied to clipboard

Feature Request: add examples and references for Mongo query syntax to Docs

Open rkingsbury opened this issue 3 years ago • 2 comments

The documentation currently makes reference to PyMongo query syntax without providing any links or examples. We should add a tutorial page to the docs describing the basics of pymongo queries, with a link to more advanced tutorials such as this page.

I hereby assign this to myself, unless someone else beats me to it :)

rkingsbury avatar Aug 04 '22 18:08 rkingsbury

Commenting to say that I agree this is an important aspect missing from the docs. I do not hereby assign myself to it, however, at least for the time being. 😉

Andrew-S-Rosen avatar Oct 23 '23 06:10 Andrew-S-Rosen

As a baby step that you can use in the mean time, I've created a tutorial notebook for pyEQL (which uses a maggma Store) which contains instructions for using query, distinct, and count. I will probably draw heavily from this to add something to the maggma docs.

https://pyeql.readthedocs.io/en/latest/examples/pyeql_tutorial_database.html#How-to-Search-the-Database

rkingsbury avatar Nov 14 '23 16:11 rkingsbury