Skip to content

Plugin

Plugin for full-text search.

FullTextSearch

Bases: ScrubyPlugin

Plugin for Scruby based on Manticore Search.

Source code in src/scruby_full_text/plugin.py 
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
@final
class FullTextSearch(ScrubyPlugin):
    """Plugin for Scruby based on Manticore Search."""

    def __init__(self, scruby_self: Scruby) -> None:  # noqa: D107
        ScrubyPlugin.__init__(self, scruby_self)

    @classmethod
    async def delete_orphaned_tables(cls) -> None:
        """Delete unnecessary tables that remain due to errors."""
        db_id = ScrubySettings.db_id
        config = FullTextSettings.config
        async with manticoresearch.ApiClient(config) as api_client:
            utils_api = manticoresearch.UtilsApi(api_client)
            tables = await utils_api.sql(f"SHOW TABLES LIKE 'scruby_{db_id}%'")
            oneof_schema_1_validator = tables.oneof_schema_1_validator
            if oneof_schema_1_validator is not None:
                data = oneof_schema_1_validator[0]["data"]
                for item in data:
                    await utils_api.sql(f"DROP TABLE IF EXISTS {item['Table']}")

    @staticmethod
    async def _task_find(
        branch_number: int,
        morphology: str,
        full_text_filter: tuple[str, str],
        filter_fn: Callable,
        hash_reduce_left: str,
        db_root: str,
        class_model: Any,
        config: manticoresearch.configuration.Configuration,
        db_id: str,
    ) -> list[Any] | None:
        """Task for finding documents, using full-text search.

        This method is for internal use.

        Returns:
            List of documents or None.
        """
        branch_number_as_hash: str = f"{branch_number:08x}"[hash_reduce_left:]
        separated_hash: str = "/".join(list(branch_number_as_hash))
        leaf_path = Path(
            *(
                db_root,
                class_model.__name__,
                separated_hash,
                "leaf.json",
            ),
        )
        docs: list[Any] = []
        if await leaf_path.exists():
            data_json: bytes = await leaf_path.read_bytes()
            data: dict[str, str] = orjson.loads(data_json) or {}
            table_name: str = f"scruby_{db_id}_{str(uuid.uuid4())[:8]}"
            text_field_name: str = full_text_filter[0]
            table_field: str = f"{text_field_name} text"
            search_query = manticoresearch.SearchQuery(
                query_string=f"@{text_field_name} {full_text_filter[1]}",
            )
            search_request = manticoresearch.SearchRequest(
                table=table_name,
                query=search_query,
            )
            # Enter a context with an instance of the API client
            async with manticoresearch.ApiClient(config) as api_client:
                # Create instances of API classes
                index_api = manticoresearch.IndexApi(api_client)
                search_api = manticoresearch.SearchApi(api_client)
                utils_api = manticoresearch.UtilsApi(api_client)
                try:
                    # Create table
                    await utils_api.sql(f"CREATE TABLE {table_name}({table_field}) morphology = '{morphology}'")
                    # Start search
                    for _, val in data.items():
                        doc = class_model.model_validate_json(val)
                        if filter_fn(doc):
                            text_field_content = getattr(doc, text_field_name)
                            # Performs a search on a table
                            insert_request = manticoresearch.InsertDocumentRequest(
                                table=table_name,
                                doc={text_field_name: text_field_content or ""},
                            )
                            await index_api.insert(insert_request)
                            search_response = await search_api.search(search_request)
                            if len(search_response.hits.hits) > 0:
                                docs.append(doc)
                            # Clear table
                            await utils_api.sql(f"TRUNCATE TABLE {table_name}")
                finally:
                    # Delete table
                    await utils_api.sql(f"DROP TABLE IF EXISTS {table_name}")
        return docs or None

    async def find_one(
        self,
        morphology: str,
        full_text_filter: tuple[str, str],
        filter_fn: Callable = lambda _: True,
    ) -> Any | None:
        """Find a one document that matches the filter, using full-text search.

        Attention:
            - The search is based on the effect of a quantum loop.
            - The search effectiveness depends on the number of processor threads.

        Args:
            morphology (str): String with morphology of language.
            full_text_filter (tuple[str, str]): Filter for full-text search.
                                                full_text_filter[0] -> name of text field.
                                                full_text_filter[1] -> query string.
            filter_fn (Callable): A function that execute the conditions of filtering.

        Returns:
            Document or None.
        """
        # Get Scruby instance
        scruby_self = self.scruby_self()
        # Variable initialization
        search_task_fn: Callable = self._task_find
        branch_numbers: range = range(scruby_self._max_number_branch)
        hash_reduce_left: int = scruby_self._hash_reduce_left
        db_root: str = scruby_self._db_root
        class_model: Any = scruby_self._class_model
        config = FullTextSettings.config
        db_id = scruby_self._db_id
        # Run quantum loop
        with concurrent.futures.ThreadPoolExecutor(scruby_self._max_workers) as executor:
            for branch_number in branch_numbers:
                future = executor.submit(
                    search_task_fn,
                    branch_number,
                    morphology,
                    full_text_filter,
                    filter_fn,
                    hash_reduce_left,
                    db_root,
                    class_model,
                    config,
                    db_id,
                )
                docs = await future.result()
                if docs is not None:
                    return docs[0]
        return None

    async def find_many(
        self,
        morphology: str,
        full_text_filter: tuple[str, str],
        filter_fn: Callable = lambda _: True,
        limit_docs: int = 100,
        page_number: int = 1,
    ) -> list[Any] | None:
        """Find the many of documents that match the filter, using full-text search.

        Attention:
            - The search is based on the effect of a quantum loop.
            - The search effectiveness depends on the number of processor threads.

        Args:
            morphology (str): String with morphology of language.
            full_text_filter (tuple[str, str]): Filter for full-text search.
                                                full_text_filter[0] -> name of text field.
                                                full_text_filter[1] -> text query.
            filter_fn (Callable): A function that execute the conditions of filtering.
                                  By default it searches for all documents.
            limit_docs (int): Limiting the number of documents. By default = 100.
            page_number (int): For pagination. By default = 1.
                               Number of documents per page = limit_docs.

        Returns:
            List of documents or None.
        """
        # The `page_number` parameter must not be less than one
        assert page_number > 0, "`find_many` => The `page_number` parameter must not be less than one."
        # Get Scruby instance
        scruby_self = self.scruby_self()
        # Variable initialization
        search_task_fn: Callable = self._task_find
        branch_numbers: range = range(scruby_self._max_number_branch)
        hash_reduce_left: int = scruby_self._hash_reduce_left
        db_root: str = scruby_self._db_root
        class_model: Any = scruby_self._class_model
        config = FullTextSettings.config
        db_id = scruby_self._db_id
        counter: int = 0
        number_docs_skippe: int = limit_docs * (page_number - 1) if page_number > 1 else 0
        result: list[Any] = []
        # Run quantum loop
        with concurrent.futures.ThreadPoolExecutor(scruby_self._max_workers) as executor:
            for branch_number in branch_numbers:
                if number_docs_skippe == 0 and counter >= limit_docs:
                    return result[:limit_docs]
                future = executor.submit(
                    search_task_fn,
                    branch_number,
                    morphology,
                    full_text_filter,
                    filter_fn,
                    hash_reduce_left,
                    db_root,
                    class_model,
                    config,
                    db_id,
                )
                docs = await future.result()
                if docs is not None:
                    for doc in docs:
                        if number_docs_skippe == 0:
                            if counter >= limit_docs:
                                return result[:limit_docs]
                            result.append(doc)
                            counter += 1
                        else:
                            number_docs_skippe -= 1
        return result or None

delete_orphaned_tables() async classmethod

Delete unnecessary tables that remain due to errors.

Source code in src/scruby_full_text/plugin.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
@classmethod
async def delete_orphaned_tables(cls) -> None:
    """Delete unnecessary tables that remain due to errors."""
    db_id = ScrubySettings.db_id
    config = FullTextSettings.config
    async with manticoresearch.ApiClient(config) as api_client:
        utils_api = manticoresearch.UtilsApi(api_client)
        tables = await utils_api.sql(f"SHOW TABLES LIKE 'scruby_{db_id}%'")
        oneof_schema_1_validator = tables.oneof_schema_1_validator
        if oneof_schema_1_validator is not None:
            data = oneof_schema_1_validator[0]["data"]
            for item in data:
                await utils_api.sql(f"DROP TABLE IF EXISTS {item['Table']}")

find_many(morphology, full_text_filter, filter_fn=lambda _: True, limit_docs=100, page_number=1) async

Find the many of documents that match the filter, using full-text search.

Attention
  • The search is based on the effect of a quantum loop.
  • The search effectiveness depends on the number of processor threads.

Parameters:

Name Type Description Default
morphology str

String with morphology of language.

 required
full_text_filter tuple[str, str]

Filter for full-text search. full_text_filter[0] -> name of text field. full_text_filter[1] -> text query.

 required
filter_fn Callable

A function that execute the conditions of filtering. By default it searches for all documents.

 lambda _: True
limit_docs int

Limiting the number of documents. By default = 100.

 100
page_number int

For pagination. By default = 1. Number of documents per page = limit_docs.

 1

Returns:

Type Description
list[Any] | None

List of documents or None.
Source code in src/scruby_full_text/plugin.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
async def find_many(
    self,
    morphology: str,
    full_text_filter: tuple[str, str],
    filter_fn: Callable = lambda _: True,
    limit_docs: int = 100,
    page_number: int = 1,
) -> list[Any] | None:
    """Find the many of documents that match the filter, using full-text search.

    Attention:
        - The search is based on the effect of a quantum loop.
        - The search effectiveness depends on the number of processor threads.

    Args:
        morphology (str): String with morphology of language.
        full_text_filter (tuple[str, str]): Filter for full-text search.
                                            full_text_filter[0] -> name of text field.
                                            full_text_filter[1] -> text query.
        filter_fn (Callable): A function that execute the conditions of filtering.
                              By default it searches for all documents.
        limit_docs (int): Limiting the number of documents. By default = 100.
        page_number (int): For pagination. By default = 1.
                           Number of documents per page = limit_docs.

    Returns:
        List of documents or None.
    """
    # The `page_number` parameter must not be less than one
    assert page_number > 0, "`find_many` => The `page_number` parameter must not be less than one."
    # Get Scruby instance
    scruby_self = self.scruby_self()
    # Variable initialization
    search_task_fn: Callable = self._task_find
    branch_numbers: range = range(scruby_self._max_number_branch)
    hash_reduce_left: int = scruby_self._hash_reduce_left
    db_root: str = scruby_self._db_root
    class_model: Any = scruby_self._class_model
    config = FullTextSettings.config
    db_id = scruby_self._db_id
    counter: int = 0
    number_docs_skippe: int = limit_docs * (page_number - 1) if page_number > 1 else 0
    result: list[Any] = []
    # Run quantum loop
    with concurrent.futures.ThreadPoolExecutor(scruby_self._max_workers) as executor:
        for branch_number in branch_numbers:
            if number_docs_skippe == 0 and counter >= limit_docs:
                return result[:limit_docs]
            future = executor.submit(
                search_task_fn,
                branch_number,
                morphology,
                full_text_filter,
                filter_fn,
                hash_reduce_left,
                db_root,
                class_model,
                config,
                db_id,
            )
            docs = await future.result()
            if docs is not None:
                for doc in docs:
                    if number_docs_skippe == 0:
                        if counter >= limit_docs:
                            return result[:limit_docs]
                        result.append(doc)
                        counter += 1
                    else:
                        number_docs_skippe -= 1
    return result or None

find_one(morphology, full_text_filter, filter_fn=lambda _: True) async

Find a one document that matches the filter, using full-text search.

Attention
  • The search is based on the effect of a quantum loop.
  • The search effectiveness depends on the number of processor threads.

Parameters:

Name Type Description Default
morphology str

String with morphology of language.

 required
full_text_filter tuple[str, str]

Filter for full-text search. full_text_filter[0] -> name of text field. full_text_filter[1] -> query string.

 required
filter_fn Callable

A function that execute the conditions of filtering.

 lambda _: True

Returns:

Type Description
Any | None

Document or None.
Source code in src/scruby_full_text/plugin.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
async def find_one(
    self,
    morphology: str,
    full_text_filter: tuple[str, str],
    filter_fn: Callable = lambda _: True,
) -> Any | None:
    """Find a one document that matches the filter, using full-text search.

    Attention:
        - The search is based on the effect of a quantum loop.
        - The search effectiveness depends on the number of processor threads.

    Args:
        morphology (str): String with morphology of language.
        full_text_filter (tuple[str, str]): Filter for full-text search.
                                            full_text_filter[0] -> name of text field.
                                            full_text_filter[1] -> query string.
        filter_fn (Callable): A function that execute the conditions of filtering.

    Returns:
        Document or None.
    """
    # Get Scruby instance
    scruby_self = self.scruby_self()
    # Variable initialization
    search_task_fn: Callable = self._task_find
    branch_numbers: range = range(scruby_self._max_number_branch)
    hash_reduce_left: int = scruby_self._hash_reduce_left
    db_root: str = scruby_self._db_root
    class_model: Any = scruby_self._class_model
    config = FullTextSettings.config
    db_id = scruby_self._db_id
    # Run quantum loop
    with concurrent.futures.ThreadPoolExecutor(scruby_self._max_workers) as executor:
        for branch_number in branch_numbers:
            future = executor.submit(
                search_task_fn,
                branch_number,
                morphology,
                full_text_filter,
                filter_fn,
                hash_reduce_left,
                db_root,
                class_model,
                config,
                db_id,
            )
            docs = await future.result()
            if docs is not None:
                return docs[0]
    return None