o ;h @sddlZddlZddlmZmZmZmZddlmZm Z ddl m Z ddl m Z ddlmZdd lmZmZmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddl m!Z!dZ"dZ#dZ$dZ%dZ&dZ'dZ(dZ)dZ*dZ+dZ,dZ-dZ.dZ/dZ0d Z1d!Z2d"Z3d#Z4d$Z5d%Z6d&Z7d'Z8d(Z9d)Z:d*Z;d+Zd.Z?d/Z@d0ZAd1ZBd2ZCd3ZDd4ZEd5ZFd6ZGd7ZHd8ZId9ZJGd:d;d;ZKGdN)DictListOptionalUnion) NEVER_DECODEPipeline)deprecated_function)get_protocol_version to_string)AggregateRequestAggregateResultCursor)Document)Field)IndexDefinition)ProfileInformation)Query)Result)SuggestionParserNUMERICz FT.CREATEzFT.ALTERz FT.SEARCHzFT.ADDz FT.ADDHASHz FT.DROPINDEXz FT.EXPLAINz FT.EXPLAINCLIzFT.DELz FT.AGGREGATE FT.PROFILEz FT.CURSORz FT.SPELLCHECKz FT.DICTADDz FT.DICTDELz FT.DICTDUMPzFT.MGETz FT.CONFIGz FT.TAGVALSz FT.ALIASADDzFT.ALIASUPDATEz FT.ALIASDELzFT.INFOz FT.SUGADDz FT.SUGDELz FT.SUGLENz FT.SUGGETz FT.SYNUPDATEz FT.SYNDUMP NOOFFSETSNOFIELDSNOHLNOFREQS MAXTEXTFIELDS TEMPORARY STOPWORDSSKIPINITIALSCAN WITHSCORESFUZZY WITHPAYLOADSc@s4eZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dddZ         dde edededee edeedededefdd Zde efd!d"Zdd#efd$d%Z   &     dd'd(Z dd)d*Zed+d,d-  &     dd.ed/ed0ed1ed2ed3ed4eed5ede efd6d7Zed+d,d-dd8d9Zed+d:d-dd;d<Zd=d>Zed+d:d-d?d@ZdAdBZdCe e!ee ee"ee#ffdffdDdEZ$dCe e!ee ee"ee#ffdffdFdGZ% ddHe ee&fdCe e!ee ee"ee#ffdffdIdJZ' ddHe ee&fdCe!ee ee"efffdKdLZ(dHe ee&ffdMdNZ) ddHe ee&fdCe!ee ee"efffdOdPZ*dQe dHe ee&e+fdRefdSdTZ,  ddHe e&e+fdUedCee!ee ee"efffdVdWZ-ddXdYZ.dZed[e efd\d]Z/dZed[e efd^d_Z0dZefd`daZ1edbdcd-ddedeedfefdgdhZ2edbdid-ddedfefdjdkZ3dlefdmdnZ4doefdpdqZ5doefdrdsZ6doefdtduZ7dvdwZ8dxedfe"fdydzZ9dxed{edfe"fd|d}Z:  ~  ddxededede"dededfe e;fddZdS)SearchCommandszSearch commands.cKs8t|jdvr|dkrt|S|S|j||fi|S)N3r)r clientrZ_RESP2_MODULE_CALLBACKS)selfcmdreskwargsr.Q/var/www/html/venv/lib/python3.10/site-packages/redis/commands/search/commands.py_parse_resultsCszSearchCommands._parse_resultscKstt|}tt||SN)mapr dictzip)r*r,r-itr.r.r/ _parse_infoIs zSearchCommands._parse_infocKs2t||dj |d|dj|dj|djdS)Nqueryduration)r8 has_payload with_scoresZfield_encodings)r _no_content_with_payloads _with_scoresZ_return_fields_decode_asr*r,r-r.r.r/ _parse_searchMs zSearchCommands._parse_searchcKs|||d|dS)Nr7 has_cursor)_get_aggregate_resultr>r.r.r/_parse_aggregateWzSearchCommands._parse_aggregatecKsZ|d}t|tr||d||j}nt|d|j |d|j|jd}|t|dfS)Nr7rr8)r8r9r:r ) isinstancerrA_cursorrr;r<r=r)r*r,r-r7resultr.r.r/_parse_profileZs zSearchCommands._parse_profilecKsri}|dkr|S|D],}t|tr|dkrq t|dkrq |ds"q |dds)q dd|dD||d<q |S)Nrr(r cSsg|] }|d|ddqS)rr )score suggestionr.).0Z_itemr.r.r/ sz4SearchCommands._parse_spellcheck..r )rDintlen)r*r,r-Z correctionsZ _correctionr.r.r/_parse_spellcheckis   z SearchCommands._parse_spellcheckcKs|r dd|DSiS)NcSsi|] }|d|dqS)rr r.)rJZkvsr.r.r/ sz4SearchCommands._parse_config_get..r.r>r.r.r/_parse_config_getrCz SearchCommands._parse_config_getc sfddtdtdDS)Ncsi|] }||dqS)r r.)rJir,r.r/rOz1SearchCommands._parse_syndump..rr )rangerMr>r.rRr/_parse_syndumpszSearchCommands._parse_syndumpdcCs|j||dS)zT Create a new batch indexer from the client with a given chunk size ) chunk_size)Z BatchIndexer)r*rWr.r.r/ batch_indexerszSearchCommands.batch_indexerFNfieldsno_term_offsetsno_field_flags stopwords definition no_highlightno_term_frequenciesskip_initial_scanc Cs*t|jg} |dur| |j7} |r| t|dur(t|tr(| t| ||r/| t|r6| t |r=| t | rD| t | rK| t |durkt|t ttfrk| tt|g7} t|dkrk| t |7} | dz| t tjdd|D7} Wnty| |7} Ynw|j| S)a Creates the search index. The index must not already exist. For more information, see https://redis.io/commands/ft.create/ Args: fields: A list of Field objects. no_term_offsets: If `true`, term offsets will not be saved in the index. no_field_flags: If true, field flags that allow searching in specific fields will not be saved. stopwords: If provided, the index will be created with this custom stopword list. The list can be empty. definition: If provided, the index will be created with this custom index definition. max_text_fields: If true, indexes will be encoded as if there were more than 32 text fields, allowing for additional fields beyond 32. temporary: Creates a lightweight temporary index which will expire after the specified period of inactivity. The internal idle timer is reset whenever the index is searched or added to. no_highlight: If true, disables highlighting support. Also implied by `no_term_offsets`. no_term_frequencies: If true, term frequencies will not be saved in the index. skip_initial_scan: If true, the initial scan and indexing will be skipped. NrSCHEMAcs|]}|VqdSr1 redis_argsrJfr.r.r/ z.SearchCommands.create_index..) CREATE_CMD index_nameargsappendrrDrLrrrrrr!listtuplesetr rM itertoolschain TypeErrorrdexecute_command) r*rYrZr[r\r]Zmax_text_fields temporaryr^r_r`rkr.r.r/ create_indexs: '               zSearchCommands.create_indexcCsXt|jddg}z|ttjdd|D7}Wnty&||7}Ynw|j|S)a Alter the existing search index by adding new fields. The index must already exist. ### Parameters: - **fields**: a list of Field objects to add for the index For more information see `FT.ALTER `_. raZADDcsrbr1rcrer.r.r/rgrhz2SearchCommands.alter_schema_add..) ALTER_CMDrjrmrprqrrrdrs)r*rYrkr.r.r/alter_schema_adds    zSearchCommands.alter_schema_adddelete_documentscCs<t|jg}t|tr|durdnd}|r|||j|S)ai Drop the index if it exists. Replaced `drop_index` in RediSearch 2.0. Default behavior was changed to not delete the indexed documents. ### Parameters: - **delete_documents**: If `True`, all documents will be deleted. For more information see `FT.DROPINDEX `_. TDD) DROPINDEX_CMDrjrDboolrlrs)r*rxrkZ delete_strr.r.r/ dropindexs   zSearchCommands.dropindex?c Ks|s| rd}t|j||g} |r| d|dur"| d| ||r7| d|r0| d| r7| d|r?| d|g7} | d | ttj| 7} |durX|j| S|j| S) zS Internal add_document used for both batch and single doc indexing TZNOSAVENPAYLOADREPLACEPARTIALZNOCREATELANGUAGEZFIELDS)ADD_CMDrjrlrmrprqitemsrs) r*doc_idconnnosaverHpayloadreplacepartiallanguage no_createrYrkr.r.r/ _add_document s*          zSearchCommands._add_documentcCsHt|j||g}|r|d|r|d|g7}|dur|j|S|j|S)zX Internal add_document_hash used for both batch and single doc indexing rrN) ADDHASH_CMDrjrlrs)r*rrrHrrrkr.r.r/_add_document_hash7s    z!SearchCommands._add_document_hashz2.0.0z2deprecated since redisearch 2.0, call hset insteadversionreasonrrrHrrrrrc Ks$|j|fd|||||||d| S)a Add a single document to the index. Args: doc_id: the id of the saved document. nosave: if set to true, we just index the document, and don't save a copy of it. This means that searches will just return ids. score: the document ranking, between 0.0 and 1.0 payload: optional inner-index payload we can save for fast access in scoring functions replace: if True, and the document already is in the index, we perform an update and reindex the document partial: if True, the fields specified will be added to the existing document. This has the added benefit that any fields specified with `no_index` will not be reindexed again. Implies `replace` language: Specify the language used for document tokenization. no_create: if True, the document is only updated and reindexed if it already exists. If the document does not exist, an error will be returned. Implies `replace` fields: kwargs dictionary of the document fields to be saved and/or indexed. NOTE: Geo points shoule be encoded as strings of "lon,lat" N)rrrHrrrrr)r) r*rrrHrrrrrrYr.r.r/ add_documentKs+ zSearchCommands.add_documentcCs|j|d|||dS)a Add a hash document to the index. ### Parameters - **doc_id**: the document's id. This has to be an existing HASH key in Redis that will hold the fields the index needs. - **score**: the document ranking, between 0.0 and 1.0 - **replace**: if True, and the document already is in the index, we perform an update and reindex the document - **language**: Specify the language used for document tokenization. N)rrHrr)r)r*rrHrrr.r.r/add_document_hashs z SearchCommands.add_document_hashzdeprecated since redisearch 2.0cCs6t|j|g}|r |d|dur|j|S|j|S)a Delete a document from index Returns 1 if the document was deleted, 0 if not ### Parameters - **delete_actual_document**: if set to True, RediSearch also delete the actual document if it is in the index ryN)DEL_CMDrjrlrs)r*rrZdelete_actual_documentrkr.r.r/delete_documents    zSearchCommands.delete_documentcCsR|j|}dd|D}|}z|d=Wn tyYnwtdd|i|S). Load a single document by id cSi|] \}}t|t|qSr.r rJkvr.r.r/rOrSz0SearchCommands.load_document..idNr.r)ZhgetallrKeyErrorrr*rrYf2r.r.r/ load_documents   zSearchCommands.load_documentcGs|jt|jg|RS)z Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )rsMGET_CMDrj)r*Zidsr.r.r/gets zSearchCommands.getcC|t|j}|t|S) Get info an stats about the the current index, including the number of documents, memory consumption, etc For more information see `FT.INFO `_. rsINFO_CMDrjr0r*r,r.r.r/infos zSearchCommands.info query_paramscCsb|durgSg}t|dkr/|d|t|d|D]\}}||||q |S)Nrparamsr )rMrlr)r*rrkkeyvaluer.r.r/get_params_argss    zSearchCommands.get_params_argscCsX|jg}t|tr t|}t|tstdt|||7}|||7}||fS)NzBad query type )rjrDstrr ValueErrortypeget_argsr)r*r7rrkr.r.r/_mk_query_argss   zSearchCommands._mk_query_argsr7cCsx|j||d\}}t}i}t|jdvrd|t<|jtg|Ri|}t|t r-|S|j t||t|ddS) Search the index for a given query, and return a result of documents ### Parameters - **query**: the search query. Either a text for simple queries with default parameters, or a Query object for complex queries. See RediSearch's documentation on query format For more information see `FT.SEARCH `_. rr&T@@r7r8 rtime monotonicr r)rrs SEARCH_CMDrDrr0r*r7rrkstoptionsr,r.r.r/searchs zSearchCommands.searchcCs$|j||d\}}|jtg|RS)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. r)rrs EXPLAIN_CMD)r*r7rrkZ query_textr.r.r/explains zSearchCommands.explaincCstd)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r*r7r.r.r/ explain_cliszSearchCommands.explain_clicCst|trt|j}t|jg|}nt|tr&d}td|jg|}nt d||| |7}|j |}|j t|||dS) Issue an aggregation query. ### Parameters **query**: This can be either an `AggregateRequest`, or a `Cursor` An `AggregateResult` object is returned. You can access the rows from its `rows` property, which will always yield the rows of the result. For more information see `FT.AGGREGATE `_. TREAD Bad queryr7r@ rDrr|rE AGGREGATE_CMDrj build_argsr CURSOR_CMDrrrsr0r*r7rr@r+rawr.r.r/ aggregates     zSearchCommands.aggregaterr@cCsz|rt|tr|d|_|}nt|d}|d}nd}t|tr/|jr/|d}|dd}nd}|dd}t|||S)Nr rr )rDrZcidrZ _with_schemar)r*rr7r@cursorZschemarowsr.r.r/rA?s      z$SearchCommands._get_aggregate_resultlimitedcCst}t|jdg}|r|d|dt|tr&d|d<||7}nt|tr=d|d<|| 7}|| |7}nt d|j |}|j t||t|dd S) a Performs a search or aggregate command and collects performance information. ### Parameters **query**: This can be either an `AggregateRequest` or `Query`. **limited**: If set to True, removes details of reader iterator. **query_params**: Define one or more value parameters. Each parameter has a name and a value. rzZLIMITEDZQUERYZ AGGREGATEr ZSEARCHz5Must provide AggregateRequest object or Query object.rr)rr PROFILE_CMDrjrlrDrrrrrrrsr0)r*r7rrrr+r,r.r.r/profileUs"       zSearchCommands.profilecCs\t|j|g}|r|d|g|r|dd|g|r#|dd|g|j|}|t|S)a Issue a spellcheck query Args: query: search query. distance: the maximal Levenshtein distance for spelling suggestions (default: 1, max: 4). include: specifies an inclusion custom dictionary. exclude: specifies an exclusion custom dictionary. For more information see `FT.SPELLCHECK `_. DISTANCETERMSINCLUDEEXCLUDESPELLCHECK_CMDrjextendrsr0r*r7Zdistanceincludeexcluder+r,r.r.r/ spellcheck}s   zSearchCommands.spellchecknametermscGt|g}|||j|S)zAdds terms to a dictionary. ### Parameters - **name**: Dictionary name. - **terms**: List of items for adding to the dictionary. For more information see `FT.DICTADD `_. ) DICT_ADD_CMDrrsr*rrr+r.r.r/dict_add  zSearchCommands.dict_addcGr)aDeletes terms from a dictionary. ### Parameters - **name**: Dictionary name. - **terms**: List of items for removing from the dictionary. For more information see `FT.DICTDEL `_. ) DICT_DEL_CMDrrsrr.r.r/dict_delrzSearchCommands.dict_delcCst|g}|j|S)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDrs)r*rr+r.r.r/ dict_dumps zSearchCommands.dict_dump8.0.0Ddeprecated since Redis 8.0, call config_set from core module insteadoptionrreturncCstd||g}|j|}|dkS)Set runtime configuration option. ### Parameters - **option**: the name of the configuration option. - **value**: a value for the configuration option. For more information see `FT.CONFIG SET `_. SETOK CONFIG_CMDrsr*rrr+rr.r.r/ config_sets  zSearchCommands.config_setDdeprecated since Redis 8.0, call config_get from core module insteadcCs td|g}|j|}|t|S)Get runtime configuration option value. ### Parameters - **option**: the name of the configuration option. For more information see `FT.CONFIG GET `_. GETrrsr0r*rr+r,r.r.r/ config_gets  zSearchCommands.config_gettagfieldcCs|t|j|S)z Return a list of all possible tag values ### Parameters - **tagfield**: Tag field name For more information see `FT.TAGVALS `_. )rs TAGVALS_CMDrj)r*rr.r.r/tagvals zSearchCommands.tagvalsaliascC|t||jS)z Alias a search index - will fail if alias already exists ### Parameters - **alias**: Name of the alias to create For more information see `FT.ALIASADD `_. )rs ALIAS_ADD_CMDrjr*rr.r.r/aliasaddrzSearchCommands.aliasaddcCr)z Updates an alias - will fail if alias does not already exist ### Parameters - **alias**: Name of the alias to create For more information see `FT.ALIASUPDATE `_. )rsALIAS_UPDATE_CMDrjrr.r.r/ aliasupdaterzSearchCommands.aliasupdatecC |t|S)z Removes an alias to a search index ### Parameters - **alias**: Name of the alias to delete For more information see `FT.ALIASDEL `_. )rs ALIAS_DEL_CMDrr.r.r/aliasdel s zSearchCommands.aliasdelcOsl|jdd}|D]'}t||j|jg}|dr|d|jr*|d||j|j|q|dS)aJ Add suggestion terms to the AutoCompleter engine. Each suggestion has a score and string. If kwargs["increment"] is true and the terms are already in the server's dictionary, we increment their scores. For more information see `FT.SUGADD `_. FZ transaction incrementINCRr ZpipelineSUGADD_COMMANDstringrHrrlrrsexecuter*rZ suggestionsr-pipeZsugrkr.r.r/sugadds       zSearchCommands.sugaddrcCr)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )rsSUGLEN_COMMAND)r*rr.r.r/suglen.s zSearchCommands.suglenrcCs|t||S)z Delete a string from the AutoCompleter index. Returns 1 if the string was found and deleted, 0 otherwise. For more information see `FT.SUGDEL `_. )rsSUGDEL_COMMAND)r*rrr.r.r/sugdel6szSearchCommands.sugdel prefixfuzzynumr: with_payloadsc Csht||d|g}|r|t|r|t|r|t|j|}g} |s'| St|||} dd| DS)t Get a list of suggestions from the AutoCompleter, for a given prefix. Parameters: prefix : str The prefix we are searching. **Must be valid ascii or utf-8** fuzzy : bool If set to true, the prefix search is done in fuzzy mode. **NOTE**: Running fuzzy searches on short (<3 letters) prefixes can be very slow, and even scan the entire index. with_scores : bool If set to true, we also return the (refactored) score of each suggestion. This is normally not needed, and is NOT the original score inserted into the index. with_payloads : bool Return suggestion payloads num : int The maximum number of results we return. Note that we might return less. The algorithm trims irrelevant suggestions. Returns: list: A list of Suggestion objects. If with_scores was False, the score of all suggestions is 1. For more information see `FT.SUGGET `_. MAXcSg|]}|qSr.r.rJsr.r.r/rKuz)SearchCommands.sugget..SUGGET_COMMANDrlr#r"r$rsr) r*rrrrr:rrkr,resultsparserr.r.r/sugget?s(     zSearchCommands.suggetgroupid skipinitialcGs0t|j|g}|r|dg|||j|S)a Updates a synonym group. The command is used to create or update a synonym group with additional terms. Only documents which were indexed after the update will be affected. Parameters: groupid : Synonym group id. skipinitial : bool If set to true, we do not scan and index. terms : The terms. For more information see `FT.SYNUPDATE `_. r!) SYNUPDATE_CMDrjrrs)r*r(r)rr+r.r.r/ synupdatews    zSearchCommands.synupdatecCr)a Dumps the contents of a synonym group. The command is used to dump the synonyms data structure. Returns a list of synonym terms and their synonym group ids. For more information see `FT.SYNDUMP `_. )rs SYNDUMP_CMDrjr0rr.r.r/syndumps zSearchCommands.syndump)rV) FFNNFNFFF)F)NFr~NFFNF)Nr~NF)Fr~NFFNF)r~NF)NFr1)FNNNNFrFF)?__name__ __module__ __qualname____doc__r0r6r?rBrGrNrPrUrXrrr|rrrrurwr}rrrfloatrrrrrrrrrLbytesrrrrrrrrrArrrrrrrrrrrrrrrr'r+r-r.r.r.r/r%@sX %      F +   5           #          (        8 r%c@seZdZddZ d%deeefdeeeeee fffddZ d%deeefdeeeeee fffdd Z d&d d Z e d d ddededefddZe d dddedefddZddZddZ    d'dededed ed!ed"edeefd#d$ZdS)(AsyncSearchCommandscs"|t|jIdH}|t|S)rNrrr.r.r/rs zAsyncSearchCommands.infoNr7rcs|j||d\}}t}i}t|jdvrd|t<|jtg|Ri|IdH}t|t r1|S|j t||t|ddS)rrr&TNrrrrr.r.r/rs zAsyncSearchCommands.searchcst|trt|j}t|jg|}nt|tr'd}td|jg|}nt d||| |7}|j |IdH}|j t|||dS)rTrrNrrrr.r.r/rs    zAsyncSearchCommands.aggregatecsdt|j|g}|r|d|g|r|dd|g|r$|dd|g|j|IdH}|t|S)a Issue a spellcheck query ### Parameters **query**: search query. **distance***: the maximal Levenshtein distance for spelling suggestions (default: 1, max: 4). **include**: specifies an inclusion custom dictionary. **exclude**: specifies an exclusion custom dictionary. For more information see `FT.SPELLCHECK `_. rrrrNrrr.r.r/rs  zAsyncSearchCommands.spellcheckrrrrrrcs&td||g}|j|IdH}|dkS)rrNrrrr.r.r/rs zAsyncSearchCommands.config_setrcs,td|g}i}|j|IdH}|t|S)rrNrrr.r.r/rs   zAsyncSearchCommands.config_getcsZ|j|IdH}dd|D}|}z|d=Wn ty#Ynwtdd|i|S)rNcSrr.r rr.r.r/rO-rSz5AsyncSearchCommands.load_document..rr.rrr.r.r/r(s  z!AsyncSearchCommands.load_documentcst|jdd}|D]'}t||j|jg}|dr|d|jr+|d||j|j|q |IdHdS)aI Add suggestion terms to the AutoCompleter engine. Each suggestion has a score and string. If kwargs["increment"] is true and the terms are already in the server's dictionary, we increment their scores. For more information see `FT.SUGADD `_. Fr r r rNr r rr.r.r/r7s      zAsyncSearchCommands.sugaddFrrrrrr:rc spt||d|g}|r|t|r|t|r|t|j|IdH}g} |s+| St|||} dd| DS)rrNcSrr.r.r r.r.r/rKr"z.AsyncSearchCommands.sugget..r#) r*rrrrr:rrkretr%r&r.r.r/r'Ns(    zAsyncSearchCommands.suggetr1r.r/)r0r1r2rrrrrrLr4rrrrr|rrrrrrr'r.r.r.r/r6s\  #  r6)MrprtypingrrrrZ redis.clientrrZ redis.utilsrZhelpersr Z_utilr Z aggregationrrrZdocumentrfieldrZindex_definitionrZprofile_informationrr7rrFrrIrrrirvrrrr{rZEXPLAINCLI_CMDrrrrrrrrrrrrrrrrrrr$r*r,rrrrrrr r!r"r#r$r%r6r.r.r.r/s          b