search

nayaverdier / dyntastic

A DynamoDB library on top of Pydantic and boto3.
MIT License
55 stars 12 forks source link

docs: update README with filter expression #3

Closed cooncesean closed 1 year ago

cooncesean commented 1 year ago

Overview

Tweak to the root README to include documentation around filtering index queries when optional filter expressions are present.

Motivation

The desire to add this comes from having to dig into the code to understand the mechanics of Dyntastic.query() to figure out how to dynamically pass a filter_expression into the query function -- which I imagine is a common use case when processing a FastAPI request with optional filter query params.

Hope this helps; if you don't feel this is appropriately useful or clutters the README, feel free to disregard - no feelings hurt on my end. Thanks for this library - it's been supremely useful to us 👍 🚀 🙏

nayaverdier commented 1 year ago

@cooncesean Thanks for the PR!