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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d1c1cbe1bbf32bf8a0126bdc6db28d2f2b743f4f0e30e078ebbd8a3959e0531 |
|
MD5 | aadbd597ef0f9dbe318f33e254835663 |
|
BLAKE2b-256 | 48cc8a759840a953d7c8734552f98be2151d25be2c4ee100b60bacea7dda8dc9 |
Close
Hashes for fastapi_elasticsearch-0.5.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d3d3195863290e0cdaa718dcb8c7e894fc7478c26578384ae3cec4c49d30f7c |
|
MD5 | 0ef181fd3f37ece027114b767cd9487c |
|
BLAKE2b-256 | e1f28fb580f0ec38fa15a068115771d808cd0ce4e405820f223ce197411c2b3d |