U 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 @seZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dyddZ dze eeeee eeeeeedddZe edddZd{edddZd|d!d"Zd}d#d$Zed%d&d'd~eeeeeeeeee ed( d)d*Zed%d&d'dd+d,Zed%d-d'dd.d/Zd0d1Zed%d-d'd2d3Zd4d5Ze e!ee ee"ee#ffdfd6d7d8Z$e e!ee ee"ee#ffdfd6d9d:Z%de ee&fe e!ee ee"ee#ffdfd;dd?Z(e ee&fd@dAdBZ)de ee&fe!ee ee"effd;dCdDZ*e e ee&e+fedEdFdGZ,de e&e+feee!ee ee"effdHdIdJZ-ddKdLZ.ee edMdNdOZ/ee edMdPdQZ0edRdSdTZ1edUdVd'eeedWdXdYZ2edUdZd'eed[d\d]Z3ed^d_d`Z4edadbdcZ5edadddeZ6edadfdgZ7dhdiZ8ee"djdkdlZ9eee"dmdndoZ:deeee"eee e;dqdrdsZdS)SearchCommandszSearch commands.cKs8t|jdkr"|dkrt|S|S|j||f|SdS)N3r)r clientrZ_RESP2_MODULE_CALLBACKS)selfcmdreskwargsr.B/tmp/pip-unpacked-wheel-4avdqdik/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_aggregateWszSearchCommands._parse_aggregatecKsZ|d}t|tr(||d||j}n"t|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]X}t|tr,|dkr,qt|dkr:q|dsDq|ddsRqdd|dD||d<q|S)Nrr(r cSsg|]}|d|ddqS)rr )score suggestionr.).0Z_itemr.r.r/ sz4SearchCommands._parse_spellcheck..r )rCintlen)r*r,r-Z correctionsZ _correctionr.r.r/_parse_spellcheckis   z SearchCommands._parse_spellcheckcKs|rdd|DSiS)NcSsi|]}|d|dqS)rr r.)rIZkvsr.r.r/ sz4SearchCommands._parse_config_get..r.r>r.r.r/_parse_config_getsz SearchCommands._parse_config_getc sfddtdtdDS)Ncsi|]}||dqS)r r.)rIir,r.r/rNsz1SearchCommands._parse_syndump..rr )rangerLr>r.rQr/_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*rUr.r.r/ batch_indexerszSearchCommands.batch_indexerFN)fieldsno_term_offsetsno_field_flags stopwords definition no_highlightno_term_frequenciesskip_initial_scanc Cs.t|jg} |dk r| |j7} |r*| t|dk rPt|trP| t| ||r^| t|rl| t |rz| t | r| t | r| t |dk rt|t ttfr| tt|g7} t|dkr| t |7} | dz | t tjdd|D7} Wn"tk r"| |7} YnX|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. NrSCHEMAcss|]}|VqdSr1 redis_argsrIfr.r.r/ sz.SearchCommands.create_index..) CREATE_CMD index_nameargsappendrrCrKrrrrrr!listtuplesetr rL itertoolschain TypeErrorraexecute_command) r*rWrXrYrZr[Zmax_text_fields temporaryr\r]r^rgr.r.r/ create_indexs8'              zSearchCommands.create_index)rWcCsZt|jddg}z |ttjdd|D7}Wn tk rN||7}YnX|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 `_. r_ZADDcss|]}|VqdSr1r`rbr.r.r/rdsz2SearchCommands.alter_schema_add..) ALTER_CMDrfrirlrmrnraro)r*rWrgr.r.r/alter_schema_adds  zSearchCommands.alter_schema_add)delete_documentscCs<t|jg}t|tr |dkr dnd}|r2|||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_CMDrfrCboolrhro)r*rtrgZ delete_strr.r.r/ dropindexs  zSearchCommands.dropindex?c Ks|s| r d}t|j||g} |r(| d|dk rD| d| ||rn| d|r`| d| rn| d|r~| d|g7} | d | ttj| 7} |dk r|j| S|j| S) zS Internal add_document used for both batch and single doc indexing TZNOSAVENPAYLOADREPLACEPARTIALZNOCREATELANGUAGEZFIELDS)ADD_CMDrfrhrirlrmitemsro) r*doc_idconnnosaverGpayloadreplacepartiallanguage no_createrWrgr.r.r/ _add_document s*         zSearchCommands._add_documentcCsHt|j||g}|r|d|r,|d|g7}|dk r>|j|S|j|S)zX Internal add_document_hash used for both batch and single doc indexing r|r~N) ADDHASH_CMDrfrhro)r*rrrGrrrgr.r.r/_add_document_hash7s   z!SearchCommands._add_document_hashz2.0.0z2deprecated since redisearch 2.0, call hset insteadversionreason) rrrGrrrrrrWc 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)rrrGrrrrr)r) r*rrrGrrrrrrWr.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)rrGrr)r)r*rrGrrr.r.r/add_document_hashsz SearchCommands.add_document_hashzdeprecated since redisearch 2.0cCs6t|j|g}|r|d|dk r,|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 ruN)DEL_CMDrfrhro)r*rrZdelete_actual_documentrgr.r.r/delete_documents   zSearchCommands.delete_documentcCsT|j|}dd|D}|}z |d=Wntk r@YnXtfd|i|S). Load a single document by id cSsi|]\}}t|t|qSr.r rIkvr.r.r/rNsz0SearchCommands.load_document..idr)ZhgetallrKeyErrorrr*rrWf2r.r.r/ load_documents  zSearchCommands.load_documentcGs|jt|jf|S)z Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )roMGET_CMDrf)r*idsr.r.r/gets zSearchCommands.getcCs|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 `_. roINFO_CMDrfr0r*r,r.r.r/infoszSearchCommands.info query_paramscCsb|dkr gSg}t|dkr^|d|t|d|D]\}}||||q@|S)Nrparamsr )rLrhr)r*rrgkeyvaluer.r.r/get_params_argss    zSearchCommands.get_params_argscCsX|jg}t|trt|}t|ts6tdt|||7}|||7}||fS)NzBad query type )rfrCstrr ValueErrortypeget_argsr)r*r7rrgr.r.r/_mk_query_argss   zSearchCommands._mk_query_argsr7rcCsr|j||d\}}t}i}t|jdkr4d|t<|jtf||}t|t rT|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)rro SEARCH_CMDrCrr0r*r7rrgstoptionsr,r.r.r/searchs zSearchCommands.searchcCs"|j||d\}}|jtf|S)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. r)rro EXPLAIN_CMD)r*r7rrgZ query_textr.r.r/explains zSearchCommands.explain)r7cCs tddS)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r*r7r.r.r/ explain_cliszSearchCommands.explain_clicCst|tr(t|j}t|jg|}n.t|trLd}td|jg|}n t 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@ rCrrxrD AGGREGATE_CMDrf build_argsr CURSOR_CMDrrror0r*r7rr@r+rawr.r.r/ aggregates     zSearchCommands.aggregate)rr7r@cCsz|r4t|tr|d|_|}n t|d}|d}nd}t|tr^|jr^|d}|dd}nd}|dd}t|||S)Nr rr )rCrZcidrZ _with_schemar)r*rr7r@cursorZschemaZrowsr.r.r/rA?s     z$SearchCommands._get_aggregate_result)r7limitedrcCst}t|jdg}|r"|d|dt|trLd|d<||7}n6t|trzd|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. rvZLIMITEDZQUERYZ AGGREGATEr ZSEARCHz5Must provide AggregateRequest object or Query object.rr)rr PROFILE_CMDrfrhrCrrrrrrror0)r*r7rrrr+r,r.r.r/profileUs(       zSearchCommands.profilecCs\t|j|g}|r|d|g|r2|dd|g|rF|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_CMDrfextendror0r*r7Zdistanceincludeexcluder+r,r.r.r/ spellcheck}s  zSearchCommands.spellcheck)nametermscGst|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_CMDrror*rrr+r.r.r/dict_adds  zSearchCommands.dict_addcGst|g}|||j|S)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_CMDrrorr.r.r/dict_dels  zSearchCommands.dict_del)rcCst|g}|j|S)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDro)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_CMDror*rrr+rr.r.r/ config_sets  zSearchCommands.config_setDdeprecated since Redis 8.0, call config_get from core module insteadrrcCs 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 `_. GETrror0r*rr+r,r.r.r/ config_gets  zSearchCommands.config_get)tagfieldcCs|t|j|S)z Return a list of all possible tag values ### Parameters - **tagfield**: Tag field name For more information see `FT.TAGVALS `_. )ro TAGVALS_CMDrf)r*rr.r.r/tagvalss zSearchCommands.tagvals)aliascCs|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 `_. )ro ALIAS_ADD_CMDrfr*rr.r.r/aliasadds zSearchCommands.aliasaddcCs|t||jS)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 `_. )roALIAS_UPDATE_CMDrfrr.r.r/ aliasupdates zSearchCommands.aliasupdatecCs |t|S)z Removes an alias to a search index ### Parameters - **alias**: Name of the alias to delete For more information see `FT.ALIASDEL `_. )ro ALIAS_DEL_CMDrr.r.r/aliasdel s zSearchCommands.aliasdelcOsl|jdd}|D]N}t||j|jg}|dr8|d|jrT|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_COMMANDstringrGrrhrroexecuter*rZ suggestionsr-pipeZsugrgr.r.r/sugadds      zSearchCommands.sugadd)rrcCs |t|S)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )roSUGLEN_COMMAND)r*rr.r.r/suglen.szSearchCommands.suglen)rrrcCs|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 `_. )roSUGDEL_COMMAND)r*rrr.r.r/sugdel6szSearchCommands.sugdel rprefixfuzzynumr: with_payloadsrc Csht||d|g}|r|t|r*|t|r8|t|j|}g} |sN| 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 `_. MAXcSsg|]}|qSr.r.rIsr.r.r/rJusz)SearchCommands.sugget..SUGGET_COMMANDrhr#r"r$ror) r*rrrrr:rrgr,resultsparserr.r.r/sugget?s(     zSearchCommands.sugget)groupid skipinitialrcGs0t|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_CMDrfrro)r*rr rr+r.r.r/ synupdatews    zSearchCommands.synupdatecCs|t|j}|t|S)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 `_. )ro SYNDUMP_CMDrfr0rr.r.r/syndumps zSearchCommands.syndump)rT) FFNNFNFFF)F)NFrzNFFNF)NrzNF)FrzNFFNF)rzNF)NF)N)N)N)FN)NNN)FrFF)F)?__name__ __module__ __qualname____doc__r0r6r?rBrFrMrOrSrVrrrxrrrrqrsryrrrfloatrrrrrrrrrKbytesrrrrrrrrrArrrrrrrrrrrr r rrrr"r$r.r.r.r/r%@s" %   F + 5          #    !    (         8r%c @seZdZddZdeeefeeeeee ffdddZ deeefeeeeee ffdddZ d d d Z e d d d eeedddZe d dd eedddZddZddZd!eeeeeeeedddZdS)"AsyncSearchCommandscs |t|jIdH}|t|S)rNrrr.r.r/rszAsyncSearchCommands.infoNrcsx|j||d\}}t}i}t|jdkr4d|t<|jtf||IdH}t|t rZ|S|j t||t|ddS)rrr&TNrrrrr.r.r/rs zAsyncSearchCommands.searchcst|tr(t|j}t|jg|}n.t|trLd}td|jg|}n t d||| |7}|j |IdH}|j t|||dS)rTrrNrrrr.r.r/rs    zAsyncSearchCommands.aggregatecsbt|j|g}|r|d|g|r2|dd|g|rF|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.spellcheckrrrrcs$td||g}|j|IdH}|dkS)rrNrrrr.r.r/rs zAsyncSearchCommands.config_setrrcs*td|g}i}|j|IdH}|t|S)rrNrrr.r.r/rs zAsyncSearchCommands.config_getcsZ|j|IdH}dd|D}|}z |d=Wntk rFYnXtfd|i|S)rNcSsi|]\}}t|t|qSr.r rr.r.r/rN-sz5AsyncSearchCommands.load_document..rrrr.r.r/r(s z!AsyncSearchCommands.load_documentcsr|jdd}|D]N}t||j|jg}|dr8|d|jrT|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 `_. Frrrr{Nrrr r.r.r/r 7s      zAsyncSearchCommands.sugaddFrrc snt||d|g}|r|t|r*|t|r8|t|j|IdH}g} |sT| St|||} dd| DS)rrNcSsg|]}|qSr.r.rr.r.r/rJsz.AsyncSearchCommands.sugget..r) r*rrrrr:rrgretrrr.r.r/rNs(    zAsyncSearchCommands.sugget)N)N)NNN)FrFF)r%r&r'rrrrrrKr)rrrrrxrrrr rrrr.r.r.r/r+sJ  #  r+)MrlrtypingrrrrZ redis.clientrrZ redis.utilsrZhelpersr Z_utilr Z aggregationrrrdocumentrfieldrZindex_definitionrZprofile_informationrr7rrErrHrrrerrrrrrwrZEXPLAINCLI_CMDrrrrrrrrrrrrrrrrrr rr!r#rrrrrrr r!r"r#r$r%r+r.r.r.r/s~          b