Query Utility for Elasticsearch
Project description
Query Utility for Elasticsearch
Utility library for creating elasticsearch query proxies using FastAPI.
from fastapi_elasticsearch import ElasticsearchAPIRouteBuilder
route_builder = ElasticsearchAPIRouteBuilder(
# The elasticsearch client
es_client=elasticsearch_client,
# The index or indices that your query will run.
index_name=index_name
)
# Decorate a function as a filter.
# The filter can declare parameters.
@route_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.
@route_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.
@route_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.
@route_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()
# Add the route to the app using the default endpoint.
es_route = route_builder.build("/search")
app.routes.append(es_route)
# It is possible to customize the route endpoint.
@route_builder.endpoint("/search")
async def search(query_body = Depends(route_builder.query_builder)) -> JSONResponse:
response = es_client.search(
body=query_body,
index=index_name
)
modified_response = modify_response(response)
return modified_response
# And use different parameters
@route_builder.endpoint("/search-more")
async def get_document(
req: Request,
size: Optional[int] = Query(100,
le=1000,
alias="s",
description="Defines the number of hits to return."),
start_from: Optional[int] = Query(0,
alias="f",
description="Starting document offset.")) -> JSONResponse:
query_body = route_builder.query_builder.build_body(
request=req,
size=size,
start_from=start_from,
)
return es_client.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,
scroll: str = None,
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.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fad92e7055290af4a1c475dc846f61df1a3dcb55a3a856d5866fabec67b9aae |
|
MD5 | ca1c38b94131f515b803d6c027b29e55 |
|
BLAKE2b-256 | 749c90cb5f8f51f1d7f2e186b9aebe6efa993619eb67372d5defcd0b7b0d73bd |
Close
Hashes for fastapi_elasticsearch-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f518c622e7b22c413dbb2aee92731fc0ccf0580177cd38bdd3a965f65f632073 |
|
MD5 | b151703e3781a3ac926b8507ab9338f3 |
|
BLAKE2b-256 | 069e47efa8c8010b403fcfabc79d304c2419bd0bd6a643a4936e47a18fb758fa |