U d@sfddlZddlZddlmZmZmZddlmZddlm Z ddl m Z ddl m Z dd lmZmZmZdd lmZdd lmZdd lmZdd lmZdZdZdZdZdZdZdZ dZ!dZ"dZ#dZ$dZ%dZ&dZ'dZ(dZ)dZ*dZ+d Z,d!Z-d"Z.d#Z/d$Z0d%Z1d&Z2d'Z3d(Z4d)Z5d*Z6d+Z7d,Z8d-Z9d.Z:d/Z;d0Zd3Z?d4Z@d5ZAd6ZBd7ZCd8ZDGd9d:d:ZEGd;d<dZ&d?d@Z'dAdBZ(dCdDZ)dEdFZ*dGdHZ+dIdJZ,dKdLZ-dMdNZ.dcdPdQZ/dddRdSZ0dTdUZ1dS)eSearchCommandszSearch commands.dcCs|j||dS)zT Create a new batch indexer from the client with a given chunk size ) chunk_size)Z BatchIndexer)selfr!r#B/tmp/pip-unpacked-wheel-f5h5_hbx/redis/commands/search/commands.py batch_indexerBszSearchCommands.batch_indexerFNc 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 Create the search index. The index must not already exist. ### Parameters: - **fields**: a list of TextField or NumericField objects - **no_term_offsets**: If true, we will not save term offsets in the index - **no_field_flags**: If true, we will not save field flags that allow searching in specific fields - **stopwords**: If not None, we create the index with this custom stopword list. The list can be empty - **max_text_fields**: If true, we will encode indexes as if there were more than 32 text fields which allows you to add additional fields (beyond 32). - **temporary**: Create a lightweight temporary index which will expire after the specified period of inactivity (in seconds). The internal idle timer is reset whenever the index is searched or added to. - **no_highlight**: If true, disabling highlighting support. Also implied by no_term_offsets. - **no_term_frequencies**: If true, we avoid saving the term frequencies in the index. - **skip_initial_scan**: If true, we do not scan and index. For more information see `FT.CREATE `_. NrSCHEMAcss|]}|VqdSN redis_args.0fr#r#r$ sz.SearchCommands.create_index..) CREATE_CMD index_nameargsappendr isinstanceintrrrrrrlisttuplesetrlen itertoolschain TypeErrorr)execute_command) r"fieldsZno_term_offsetsZno_field_flagsZ stopwordsZ definitionZmax_text_fields temporaryZ no_highlightZno_term_frequenciesZskip_initial_scanr0r#r#r$ create_indexHs8(              zSearchCommands.create_indexcCsZt|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|]}|VqdSr'r(r*r#r#r$r-sz2SearchCommands.alter_schema_add..) ALTER_CMDr/r4r8r9r:r)r;)r"r<r0r#r#r$alter_schema_adds  zSearchCommands.alter_schema_addcCs|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)r; DROPINDEX_CMDr/)r"Zdelete_documentsZ 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_CMDr/r1r4r8r9itemsr;) r"doc_idconnnosavescorepayloadreplacepartiallanguage no_creater<r0r#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 rGrIN) ADDHASH_CMDr/r1r;)r"rLrMrOrSrQr0r#r#r$_add_document_hashs   z!SearchCommands._add_document_hashz2.0.0z2deprecated since redisearch 2.0, call hset instead)versionreasonc Ks$|j|fd|||||||d| S)a Add a single document to the index. ### Parameters - **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 i 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)rMrNrOrPrQrRrSrT)rU) r"rLrNrOrPrQrRrSrTr<r#r#r$ add_documents+ 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)rMrOrSrQ)rW)r"rLrOrSrQr#r#r$add_document_hash(sz 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 rAN)DEL_CMDr/r1r;)r"rLrMZdelete_actual_documentr0r#r#r$delete_document<s   zSearchCommands.delete_documentcCsT|j|}dd|D}|}z |d=Wntk r@YnXtfd|i|S). Load a single document by id cSsi|]\}}t|t|qSr#r r+kvr#r#r$ Tsz0SearchCommands.load_document..idclientZhgetallrKKeyErrorrr"rcr<f2r#r#r$ load_documentOs  zSearchCommands.load_documentcGs|jt|jf|S)z Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )r;MGET_CMDr/)r"idsr#r#r$get^s zSearchCommands.getcCs&|t|j}tt|}tt||S) Get info an stats about the the current index, including the number of documents, memory consumption, etc For more information see `FT.INFO `_. r;INFO_CMDr/mapr dictzipr"resitr#r#r$infojs zSearchCommands.info query_paramscCsb|dkr gSg}t|dkr^|d|t|d|D]\}}||||q@|S)Nrparamsr)r7r1rK)r"rxr0keyvaluer#r#r$get_params_argsvs    zSearchCommands.get_params_argscCsX|jg}t|trt|}t|ts6tdt|||7}|||7}||fS)NzBad query type )r/r2strr ValueErrortypeget_argsr|)r"queryrxr0r#r#r$_mk_query_argss   zSearchCommands._mk_query_argsrrxcCs^|j||d\}}t}|jtf|}t|tr8|St||j t|d|j|j dS) 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 `_. rw@@durationZ has_payload with_scores rtimer; SEARCH_CMDr2rr _no_content_with_payloads _with_scoresr"rrxr0strtr#r#r$searchs zSearchCommands.searchcCs"|j||d\}}|jtf|S)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. rw)rr; EXPLAIN_CMD)r"rrxr0Z query_textr#r#r$explains zSearchCommands.explain)rcCs tddS)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r"rr#r#r$ explain_cliszSearchCommands.explain_clicCs|t|tr(t|j}t|jg|}n.t|trLd}td|jg|}n t d||| |7}|j |}| |||S) 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 query r2r bool_cursor AGGREGATE_CMDr/ build_argsr CURSOR_CMDr~r|r;_get_aggregate_resultr"rrx has_cursorcmdrawr#r#r$ aggregates     zSearchCommands.aggregatecCsz|r4t|tr|d|_|}n t|d}|d}nd}t|tr^|jr^|d}|dd}nd}|dd}t|||S)Nr rr)r2rZcidr Z _with_schemar )r"rrrcursorZschemaZrowsr#r#r$rs     z$SearchCommands._get_aggregate_result)rlimitedrxcCst}t|jdg}|r"|d|dt|trLd|d<||7}n6t|trzd|d<||7}|| |7}nt d|j |}t|tr| |d||j }n*t|d|j t|d |j|jd }|t|d fS) 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. rBZLIMITEDZQUERYZ AGGREGATErZSEARCHz5Must provide AggregateRequest object or Query object.rrrr )r PROFILE_CMDr/r1r2r rrrr|r~r;rrrrrrr)r"rrrxrrrtresultr#r#r$profiles0        zSearchCommands.profilec Cst|j|g}|r|d|g|r2|dd|g|rF|dd|g|j|}i}|dkr`|S|D]X}t|tr||dkr|qdt|dkrqd|dsqd|ddsqddd |dD||d <qd|S)  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 `_. DISTANCETERMSINCLUDEEXCLUDErrcSsg|]}|d|ddqSrr )rO suggestionr#r+Z_itemr#r#r$ [sz-SearchCommands.spellcheck..r SPELLCHECK_CMDr/extendr;r2r3r7 r"rZdistanceincludeexcluderrZ correctionsZ _correctionr#r#r$ spellcheck#s0    zSearchCommands.spellcheckcGst|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_CMDrr;r"nametermsrr#r#r$dict_addas  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_CMDrr;rr#r#r$dict_delos  zSearchCommands.dict_delcCst|g}|j|S)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDr;)r"rrr#r#r$ dict_dump}s zSearchCommands.dict_dumpcCstd||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_CMDr;r"optionr{rrr#r#r$ config_sets  zSearchCommands.config_setcCs:td|g}i}|j|}|r6|D]}|d||d<q |S)Get runtime configuration option value. ### Parameters - **option**: the name of the configuration option. For more information see `FT.CONFIG GET `_. GETr rrr"rrrtrZkvsr#r#r$ config_gets  zSearchCommands.config_getcCs|t|j|S)z Return a list of all possible tag values ### Parameters - **tagfield**: Tag field name For more information see `FT.TAGVALS `_. )r; TAGVALS_CMDr/)r"Ztagfieldr#r#r$tagvalss zSearchCommands.tagvalscCs|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 `_. )r; ALIAS_ADD_CMDr/r"aliasr#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 `_. )r;ALIAS_UPDATE_CMDr/rr#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 `_. )r; 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 incrementINCRrF ZpipelineSUGADD_COMMANDstringrOrlr1rPr;executer"rzZ suggestionskwargspipeZsugr0r#r#r$sugadds      zSearchCommands.sugaddcCs |t|S)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )r;SUGLEN_COMMAND)r"rzr#r#r$suglenszSearchCommands.suglencCs|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 `_. )r;SUGDEL_COMMAND)r"rzrr#r#r$sugdelszSearchCommands.sugdel c 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#r+sr#r#r$r3sz)SearchCommands.sugget..SUGGET_COMMANDr1rrrr;r r"rzprefixZfuzzynumrZ with_payloadsr0retresultsparserr#r#r$suggets"     zSearchCommands.suggetcGs0t|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_CMDr/rr;)r"ZgroupidZ skipinitialrrr#r#r$ synupdate5s    zSearchCommands.synupdatecs,|t|jfddtdtdDS)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 `_. csi|]}||dqS)r r#)r+irr#r$rbWsz*SearchCommands.syndump..rr)r; SYNDUMP_CMDr/ranger7)r"r#rr$syndumpMs zSearchCommands.syndump)r ) FFNNFNFFF)F)NFrENFFNF)NrENF)FrENFFNF)rENF)NF)N)N)N)FN)NNN)FrFF)F)2__name__ __module__ __qualname____doc__r%r>r@rDrUrWrrZr[r]rirlrvrrr}r3floatr|rrrrrrrr rrrrrrrrrrrrrrrrrrrr#r#r#r$r?s  G  +  5        "      1 >      2 rc@seZdZddZdeeefeeeeee ffdddZ deeefeeeeee ffdddZ dd d Z d d Z d dZddZddZdddZdS)AsyncSearchCommandscs,|t|jIdH}tt|}tt||S)rmNrnrsr#r#r$rv[s zAsyncSearchCommands.infoNrcsd|j||d\}}t}|jtf|IdH}t|tr>|St||j t|d|j|j dS)rrwNrrrrr#r#r$rgs zAsyncSearchCommands.searchcst|tr(t|j}t|jg|}n.t|trLd}td|jg|}n t d||| |7}|j |IdH}| |||S)rTrrNrrr#r#r$rs    zAsyncSearchCommands.aggregatec st|j|g}|r|d|g|r2|dd|g|rF|dd|g|j|IdH}i}|dkrf|S|D]X}t|tr|dkrqjt|dkrqj|dsqj|ddsqjd d |dD||d <qj|S) rrrrrNrrrcSsg|]}|d|ddqSrr#rr#r#r$rsz2AsyncSearchCommands.spellcheck..r rrr#r#r$rs0   zAsyncSearchCommands.spellcheckcs$td||g}|j|IdH}|dkS)rrNrrrr#r#r$rs zAsyncSearchCommands.config_setcs@td|g}i}|j|IdH}|r<|D]}|d||d<q&|S)rrNr rrrr#r#r$rs zAsyncSearchCommands.config_getcsZ|j|IdH}dd|D}|}z |d=Wntk rFYnXtfd|i|S)r^NcSsi|]\}}t|t|qSr#r r_r#r#r$rbsz5AsyncSearchCommands.load_document..rcrdrgr#r#r$ris 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 `_. FrrrrFNrrrr#r#r$rs      zAsyncSearchCommands.sugaddFrc snt||d|g}|r|t|r*|t|r8|t|j|IdH}g} |sT| St|||} dd| DS)rrNcSsg|]}|qSr#r#rr#r#r$rHsz.AsyncSearchCommands.sugget..rrr#r#r$rs"    zAsyncSearchCommands.sugget)N)N)NNN)FrFF)rrrrvrr}rrr3rrrrrrrirrr#r#r#r$rZs*  "   /r)Gr8rtypingrrrZ redis.clientrZ redis.utilsrZhelpersrZ_utilr Z aggregationr r rdocumentrrrrrrrrr.r?rrJrVZDROP_CMDrCrZEXPLAINCLI_CMDr\rrrrrrrZGET_CMDrjrrrrrrorrrrrrrrrrrrrrrrrrrr#r#r#r$s|        !