Query Utility for Elasticsearch
Project description
Query Utility for Elasticsearch
Utility library for creating elasticsearch query proxies using FastAPI.
from fastapi_elasticsearch import ElasticsearchAPIQueryBuilder
query_builder = ElasticsearchAPIQueryBuilder()
# Decorate a function as a filter.
# The filter can declare parameters.
@query_builder.filter()
def filter_category(c: Optional[str] = Query(None)):
return {
"term": {
"category": c
}
} if c is not None else None
# Decorate a function as a matcher
# (will contribute to the query scoring).
# Parameters can also be used.
@query_builder.matcher()
def match_fields(q: Optional[str] = Query(None)):
return {
"multi_match": {
"query": q,
"fuzziness": "AUTO",
"fields": [
"name^2",
"description"
]
}
} if q is not None else None
# Decorate a function as a sorter.
# Parameters can be declared.
@query_builder.sorter()
def sort_by(direction: Optional[str] = Query(None)):
return {
"name": direction
} if direction is not None else None
# Decorate a function as a highlighter.
# Parameters can also be declared.
@query_builder.highlighter()
def highlight(q: Optional[str] = Query(None),
h: bool = Query(False):
return {
"name": {}
} if q is not None and h else None
app = FastAPI()
# Create a route using the query builder as dependency.
@app.get("/search")
async def search(query_body: Dict = Depends(query_builder.build())) -> JSONResponse:
# Search using the Elasticsearch client.
return es.search(
body=query_body,
index=index_name
)
It is possible to customize the generated query body using the decorator @search_builder.
from typing import List, Dict
@query_builder.search_builder()
def build_search_body(size: int = 10,
start_from: int = 0,
source: Union[List, Dict, str] = None,
minimum_should_match: int = 1,
filters: List[Dict] = [],
matchers: List[Dict] = [],
highlighters: List[Dict] = [],
sorters: List[Dict] = []) -> Dict:
return {
"query": {
...
},
...
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for fastapi-elasticsearch-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 993683ce699997e255f962c0fa503d97f82d01c3f4d309ede36ed6d7df21ee7e |
|
MD5 | ff3c396a05ea9b767102e8a1f883b22b |
|
BLAKE2b-256 | 555d7930ef5722f9f2ca20fdb6f4d52812b063dcd02af4d0c7b1514fb63bc826 |
Close
Hashes for fastapi_elasticsearch-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bcc2ee37d6272d8ba04f6ff4c4c4060fbb10849acbd7b0ea7fcf8728122b260 |
|
MD5 | 7a777ccc5cec728a3a26688b551e6cc7 |
|
BLAKE2b-256 | bc6e77aef6e2e1dd1c80c7812e7c243a01afbbcaebc8746639cadef3bb2ed49a |