Class Search

redis/commands/search/__init__.py:16–113

Create a client for talking to search. It abstracts the API of the module and lets you just use the engine.

class Search(SearchCommands):
    class="st">"""
    Create a client for talking to search.
    It abstracts the API of the module and lets you just use the engine.
    class="st">"""

    class BatchIndexer:
        class="st">"""
        A batch indexer allows you to automatically batch
        document indexing in pipelines, flushing it every N documents.
        class="st">"""

        def __init__(self, client, chunk_size=1000):
            self.client = client
            self.execute_command = client.execute_command
            self._pipeline = client.pipeline(transaction=False, shard_hint=None)
            self.total = 0
            self.chunk_size = chunk_size
            self.current_chunk = 0

        def __del__(self):
            if self.current_chunk:
                self.commit()

        def add_document(
            self,
            doc_id,
            nosave=False,
            score=1.0,
            payload=None,
            replace=False,
            partial=False,
            no_create=False,
            **fields,
        ):
            class="st">"""
            Add a document to the batch query
            class="st">"""
            self.client._add_document(
                doc_id,
                conn=self._pipeline,
                nosave=nosave,
                score=score,
                payload=payload,
                replace=replace,
                partial=partial,
                no_create=no_create,
                **fields,
            )
            self.current_chunk += 1
            self.total += 1
            if self.current_chunk >= self.chunk_size:
                self.commit()

        def add_document_hash(self, doc_id, score=1.0, replace=False):
            class="st">"""
            Add a hash to the batch query
            class="st">"""