| 1 |
from enum import Enum |
| 2 |
|
| 3 |
|
| 4 |
class IndexType(Enum): |
| 5 |
"""Enum of the currently supported index types.""" |
| 6 |
|
| 7 |
HASH = 1 |
| 8 |
JSON = 2 |
| 9 |
|
| 10 |
|
| 11 |
class IndexDefinition: |
| 12 |
"""IndexDefinition is used to define a index definition for automatic |
| 13 |
indexing on Hash or Json update.""" |
| 14 |
|
| 15 |
def __init__( |
| 16 |
self, |
| 17 |
prefix=[], |
| 18 |
filter=None, |
| 19 |
language_field=None, |
| 20 |
language=None, |
| 21 |
score_field=None, |
| 22 |
score=1.0, |
| 23 |
payload_field=None, |
| 24 |
index_type=None, |
| 25 |
): |
| 26 |
self.args = [] |
| 27 |
self._append_index_type(index_type) |
| 28 |
self._append_prefix(prefix) |
| 29 |
self._append_filter(filter) |
| 30 |
self._append_language(language_field, language) |
| 31 |
self._append_score(score_field, score) |
| 32 |
self._append_payload(payload_field) |
| 33 |
|
| 34 |
def _append_index_type(self, index_type): |
| 35 |
"""Append `ON HASH` or `ON JSON` according to the enum.""" |
| 36 |
if index_type is IndexType.HASH: |
| 37 |
self.args.extend(["ON", "HASH"]) |
| 38 |
elif index_type is IndexType.JSON: |
| 39 |
self.args.extend(["ON", "JSON"]) |
| 40 |
elif index_type is not None: |
| 41 |
raise RuntimeError(f"index_type must be one of {list(IndexType)}") |
| 42 |
|
| 43 |
def _append_prefix(self, prefix): |
| 44 |
"""Append PREFIX.""" |
| 45 |
if len(prefix) > 0: |
| 46 |
self.args.append("PREFIX") |
| 47 |
self.args.append(len(prefix)) |
| 48 |
for p in prefix: |
| 49 |
self.args.append(p) |
| 50 |
|
| 51 |
def _append_filter(self, filter): |
| 52 |
"""Append FILTER.""" |
| 53 |
if filter is not None: |
| 54 |
self.args.append("FILTER") |
| 55 |
self.args.append(filter) |
| 56 |
|
| 57 |
def _append_language(self, language_field, language): |
| 58 |
"""Append LANGUAGE_FIELD and LANGUAGE.""" |
| 59 |
if language_field is not None: |
| 60 |
self.args.append("LANGUAGE_FIELD") |
| 61 |
self.args.append(language_field) |
| 62 |
if language is not None: |
| 63 |
self.args.append("LANGUAGE") |
| 64 |
self.args.append(language) |
| 65 |
|
| 66 |
def _append_score(self, score_field, score): |
| 67 |
"""Append SCORE_FIELD and SCORE.""" |
| 68 |
if score_field is not None: |
| 69 |
self.args.append("SCORE_FIELD") |
| 70 |
self.args.append(score_field) |
| 71 |
if score is not None: |
| 72 |
self.args.append("SCORE") |
| 73 |
self.args.append(score) |
| 74 |
|
| 75 |
def _append_payload(self, payload_field): |
| 76 |
"""Append PAYLOAD_FIELD.""" |
| 77 |
if payload_field is not None: |
| 78 |
self.args.append("PAYLOAD_FIELD") |
| 79 |
self.args.append(payload_field) |