U g5@sddlZddlZddlmZmZmZmZddlmZm Z ddl m Z ddl m Z mZddlmZdd lmZmZmZdd lmZdd lmZdd lmZdd lmZddlmZddlm Z dZ!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@d0ZAd1ZBd2ZCd3ZDd4ZEd5ZFd6ZGd7ZHd8ZId9ZJd:ZKGd;d<d<ZLGd=d>d>eLZMdS)?N)DictListOptionalUnion) NEVER_DECODEPipeline)deprecated_function)get_protocol_version parse_to_dict to_string)AggregateRequestAggregateResultCursor)Document)Field)IndexDefinition)Query)Result)SuggestionParserNUMERICz FT.CREATEzFT.ALTERz FT.SEARCHzFT.ADDz FT.ADDHASHzFT.DROPz FT.DROPINDEXz FT.EXPLAINz FT.EXPLAINCLIzFT.DELz FT.AGGREGATEz FT.PROFILEz FT.CURSORz FT.SPELLCHECKz FT.DICTADDz FT.DICTDELz FT.DICTDUMPzFT.GETzFT.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 @sveZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ duddZ dve eeeee eeeeeedddZe edddZdwedddZdxd!d"Zdyd#d$Zed%d&d'dzeeeeeeeeee ed( d)d*Zed%d&d'd{d+d,Zd|d-d.Zd/d0Zd1d2Zd3d4Ze e!ee ee"ee#ffdfd5d6d7Z$e e!ee ee"ee#ffdfd5d8d9Z%d}e ee&fe e!ee ee"ee#ffdfd:d;d<Z'd~e ee&fe!ee ee"effd:d=d>Z(e ee&fd?d@dAZ)de ee&fe!ee ee"effd:dBdCZ*e e ee&e+fedDdEdFZ,de ee&e+feee!ee ee"effdGdHdIZ-ddJdKZ.ee edLdMdNZ/ee edLdOdPZ0edQdRdSZ1eeedTdUdVZ2eedWdXdYZ3edZd[d\Z4ed]d^d_Z5ed]d`daZ6ed]dbdcZ7dddeZ8ee"dfdgdhZ9eee"didjdkZ:deeee"eee e;dmdndoZdS)SearchCommandszSearch commands.cKs(t|jdkr|S|j||f|SdS)N3)r clientZ_RESP2_MODULE_CALLBACKS)selfcmdreskwargsr-B/tmp/pip-unpacked-wheel-f3sx1i9r/redis/commands/search/commands.py_parse_resultsDszSearchCommands._parse_resultscKstt|}tt||SN)maprdictzip)r)r+r,itr-r-r. _parse_infoJs zSearchCommands._parse_infocKs2t||dj |d|dj|dj|djdS)Nqueryduration)r7 has_payload with_scoresZfield_encodings)r _no_content_with_payloads _with_scoresZ_return_fields_decode_asr)r+r,r-r-r. _parse_searchNs zSearchCommands._parse_searchcKs|||d|dS)Nr6 has_cursor)_get_aggregate_resultr=r-r-r._parse_aggregateXszSearchCommands._parse_aggregatecKsZ|d}t|tr(||d||j}n"t|d|j |d|j|jd}|t|dfS)Nr6rr7)r7r8r9r ) isinstancerr@_cursorrr:r;r<r )r)r+r,r6resultr-r-r._parse_profile[s 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 )rBintlen)r)r+r,Z correctionsZ _correctionr-r-r._parse_spellcheckjs   z SearchCommands._parse_spellcheckcKs|rdd|DSiS)NcSsi|]}|d|dqS)rr r-)rHZkvsr-r-r. sz4SearchCommands._parse_config_get..r-r=r-r-r._parse_config_getsz SearchCommands._parse_config_getc sfddtdtdDS)Ncsi|]}||dqS)r r-)rHir+r-r.rMsz1SearchCommands._parse_syndump..rr )rangerKr=r-rPr._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)rTr-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|]}|VqdSr0 redis_argsrHfr-r-r. sz.SearchCommands.create_index..) CREATE_CMD index_nameargsappendrrBrJrrrrrr listtuplesetrrK itertoolschain TypeErrorr`execute_command) r)rVrWrXrYrZZmax_text_fields temporaryr[r\r]rfr-r-r. create_indexs8'              zSearchCommands.create_index)rVcCsZt|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|]}|VqdSr0r_rar-r-r.rcsz2SearchCommands.alter_schema_add..) ALTER_CMDrerhrkrlrmr`rn)r)rVrfr-r-r.alter_schema_adds  zSearchCommands.alter_schema_add)delete_documentscCs|rdnd}|t|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 `_. DD)rn DROPINDEX_CMDre)r)rsZ 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_CMDrergrhrkrlitemsrn) r)doc_idconnnosaverFpayloadreplacepartiallanguage no_createrVrfr-r-r. _add_documents*         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 rzr|N) ADDHASH_CMDrergrn)r)rrrFrrrfr-r-r._add_document_hash.s   z!SearchCommands._add_document_hashz2.0.0z2deprecated since redisearch 2.0, call hset instead)versionreason) rrrFrrrrrrVc 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)rrrFrrrrr)r) r)rrrFrrrrrrVr-r-r. add_documentBs+ 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)rrFrr)r)r)rrFrrr-r-r.add_document_hashzsz SearchCommands.add_document_hashcCs6t|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 rtN)DEL_CMDrergrn)r)rrZdelete_actual_documentrfr-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 rHkvr-r-r.rMsz0SearchCommands.load_document..idr(Zhgetallr~KeyErrorrr)rrVf2r-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. )rnMGET_CMDre)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 `_. rnINFO_CMDrer/r)r+r-r-r.infoszSearchCommands.info query_paramscCsb|dkr gSg}t|dkr^|d|t|d|D]\}}||||q@|S)Nrparamsr )rKrgr~)r)rrfkeyvaluer-r-r.get_params_argss    zSearchCommands.get_params_argscCsX|jg}t|trt|}t|ts6tdt|||7}|||7}||fS)NzBad query type )rerBstrr ValueErrortypeget_argsr)r)r6rrfr-r-r._mk_query_argss   zSearchCommands._mk_query_argsr6rcCsr|j||d\}}t}i}t|jdkr4d|t<|jtf||}t|trT|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@@r6r7 rtimer r(rrn SEARCH_CMDrBrr/r)r6rrfstoptionsr+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)rrn EXPLAIN_CMD)r)r6rrfZ query_textr-r-r.explains zSearchCommands.explain)r6cCs tddS)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r)r6r-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 queryr6r? rBrboolrC AGGREGATE_CMDre build_argsr CURSOR_CMDrrrnr/r)r6rr?r*rawr-r-r. aggregates     zSearchCommands.aggregate)rr6r?cCsz|r4t|tr|d|_|}n t|d}|d}nd}t|tr^|jr^|d}|dd}nd}|dd}t|||S)Nr rr )rBrZcidrZ _with_schemar)r)rr6r?cursorZschemaZrowsr-r-r.r@4s     z$SearchCommands._get_aggregate_result)r6limitedrcCst}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`, `Query` or string. **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. ruZLIMITEDZQUERYZ AGGREGATEr ZSEARCHz5Must provide AggregateRequest object or Query object.rr) r PROFILE_CMDrergrBrrrrrrrnr/)r)r6rrrr*r+r-r-r.profileJs(       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_CMDreextendrnr/r)r6Zdistanceincludeexcluder*r+r-r-r. spellcheckrs  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_CMDrrnr)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_CMDrrnrr-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_CMDrn)r)rr*r-r-r. dict_dumps zSearchCommands.dict_dumpoptionrreturncCstd||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_CMDrnr)rrr*rr-r-r. config_sets  zSearchCommands.config_setrrcCs 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 `_. GETrrnr/r)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 `_. )rn TAGVALS_CMDre)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 `_. )rn ALIAS_ADD_CMDrer)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 `_. )rnALIAS_UPDATE_CMDrerr-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 `_. )rn ALIAS_DEL_CMDrr-r-r.aliasdels 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 incrementINCRry ZpipelineSUGADD_COMMANDstringrFrrgrrnexecuter)rZ suggestionsr,pipeZsugrfr-r-r.sugadds      zSearchCommands.sugadd)rrcCs |t|S)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )rnSUGLEN_COMMAND)r)rr-r-r.suglenszSearchCommands.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 `_. )rnSUGDEL_COMMAND)r)rrr-r-r.sugdel#szSearchCommands.sugdel rprefixfuzzynumr9 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-rHsr-r-r.rIbsz)SearchCommands.sugget..SUGGET_COMMANDrgr"r!r#rnr) r)rr r rr9rrfr+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_CMDrerrn)r)rrrr*r-r-r. synupdateds    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 `_. )rn SYNDUMP_CMDrer/rr-r-r.syndump|s zSearchCommands.syndump)rS) FFNNFNFFF)F)NFrxNFFNF)NrxNF)FrxNFFNF)rxNF)NF)N)N)N)FN)NNN)Fr FF)F)?__name__ __module__ __qualname____doc__r/r5r>rArErLrNrRrUrrrrrrrprrrwrrrfloatrrrrrrrrrJbytesrrrrrrrrr@rrrrrrrrrrrrrr rrrrr-r-r-r.r$As %   F + 5        #    !    (         8r$c @seZdZddZdeeefeeeeee ffdddZ deeefeeeeee ffdddZ dd d Z eee d d d ZeedddZddZddZdeee ee e eedddZdS)AsyncSearchCommandscs |t|jIdH}|t|S)rNrrr-r-r.rszAsyncSearchCommands.infoNrcsx|j||d\}}t}i}t|jdkr4d|t<|jtf||IdH}t|trZ|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.spellcheckrcs$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=Wntk rFYnXtfd|i|S)rNcSsi|]\}}t|t|qSr-r rr-r-r.rMsz5AsyncSearchCommands.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 `_. FrrrryNrrrr-r-r.rs      zAsyncSearchCommands.sugaddFr r c snt||d|g}|r|t|r*|t|r8|t|j|IdH}g} |sT| St|||} dd| DS)rrNcSsg|]}|qSr-r-rr-r-r.rIisz.AsyncSearchCommands.sugget..r) r)rr r rr9rrfretrrr-r-r.r3s(    zAsyncSearchCommands.sugget)N)N)NNN)Fr FF)rr r!rrrrrrJr#rrrrrrrrrrrr-r-r-r.r%s:  #  r%)NrkrtypingrrrrZ redis.clientrrZ redis.utilsrZhelpersr r _utilrZ aggregationrrrdocumentrfieldrZindexDefinitionrr6rrDrrGrrrdrqrr}rZDROP_CMDrvrZEXPLAINCLI_CMDrrrrrrrrZGET_CMDrrrrrrrrrrrrrrrrrrrrr r!r"r#r$r%r-r-r-r.s        N