)JfddlZddlZddlmZmZmZmZddlmZddl m Z ddl m Z m Z ddlmZdd lmZmZmZdd lmZdd lmZdd lmZdd lmZdZdZdZdZdZ dZ!dZ"dZ#dZ$dZ%dZ&dZ'dZ(dZ)dZ*dZ+dZ,dZ-d Z.d!Z/d"Z0d#Z1d$Z2d%Z3d&Z4d'Z5d(Z6d)Z7d*Z8d+Z9d,Z:d-Z;d.Zd1Z?d2Z@d3ZAd4ZBd5ZCd6ZDd7ZEd8ZFGd9d:ZGGd;dZ1d?efd@Z2dAefdBZ3dAefdCZ4dAefdDZ5dEZ6dFedr?r )r)r+r,r8results r-_parse_profilezSearchCommands._parse_profileXsw e- . . //Au}MMFFA%% +!0!. F}SV,,,,r/c i}|dkr|S|D]e}t|tr|dkrt|dkr2|ds;|ddsJd|dD||d<f|S)Nrr&r c0g|]}|d|ddS)rr )score suggestion).0_items r- z4SearchCommands._parse_spellcheck..s5+++@E%(%(;;+++r/r )rGintlen)r)r+r, corrections _corrections r-_parse_spellcheckz SearchCommands._parse_spellcheckgs !88   K+s++  q0@0@;1$$q> q>!$ "++ITUV+++K A ' 'r/c "|r d|DniS)Nc,i|]}|d|dS)rr rO)rPkvss r- z4SearchCommands._parse_config_get..s"...3AA...r/rOr@s r-_parse_config_getz SearchCommands._parse_config_gets!25=..#....2=r/c XfdtdtdDS)Nc4i|]}||dzS)r rO)rPir+s r-r[z1SearchCommands._parse_syndump..s'BBBqAAE BBBr/rr )rangerTr@s ` r-_parse_syndumpzSearchCommands._parse_syndumps/BBBBE!SXXq,A,ABBBBr/dc0|||S)zT Create a new batch indexer from the client with a given chunk size ) chunk_size) BatchIndexer)r)rds r- batch_indexerzSearchCommands.batch_indexers  * ===r/FNc t|jg} | | |jz } |r| t|Dt |t r/| t| ||r| t|r| t|r| t| r| t| r| t|`t |tttfr>| t t#|gz } t#|dkr| t|z } | d | tt%jd|Dz } n'#t($r| |z } YnwxYw|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 `_. NrSCHEMAc3>K|]}|VdSr1 redis_argsrPfs r- z.SearchCommands.create_index..**J*Ja1<<>>*J*J*J*J*J*Jr/) CREATE_CMD index_nameargsappendrrGrSrrrrrrlisttuplesetrrT itertoolschain TypeErrorrkexecute_command) r)fieldsno_term_offsetsno_field_flags stopwords definitionmax_text_fields temporary no_highlightno_term_frequenciesskip_initial_scanrrs r- create_indexzSearchCommands.create_indexsPDO,  ! JO #D  ' KK & & &  Z 3%?%? KK " " " KK " " "  # KK " " "   KK     " KK ! ! !  ! KK  ) KK ( ( (  Z D%;M%N%N YI/ /D9~~!!Y' H ( D*J*J6*J*J*JKLL LDD ( ( ( F%%'' 'DDD ($t#T**s(F**!G Gr{ct|jddg} |ttjd|Dz }n'#t $r||z }YnwxYw|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 `_. rhADDc3>K|]}|VdSr1rjrls r-rnz2SearchCommands.alter_schema_add..ror/) ALTER_CMDrqrtrwrxryrkrz)r)r{rrs r-alter_schema_addzSearchCommands.alter_schema_adds4?He< ( D*J*J6*J*J*JKLL LDD ( ( ( F%%'' 'DDD ($t#T**s(;!AAdelete_documentscP|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)rz DROPINDEX_CMDrq)r)r delete_strs r- dropindexzSearchCommands.dropindexs,.5TT2 ##M4?JOOOr/?c  |s| rd}t|j||g} |r| d|*| d| ||rC| d|r| d| r| d|r| d|gz } | d | tt j| z } | |j| S|j| S) zS Internal add_document used for both batch and single doc indexing TNOSAVENPAYLOADREPLACEPARTIALNOCREATELANGUAGEFIELDS)ADD_CMDrqrsrtrwrxitemsrz) r)doc_idconnnosaverMpayloadreplacepartiallanguage no_creater{rrs r- _add_documentzSearchCommands._add_documents*"  i G&%8  " KK ! ! !   KK " " " KK  ( KK " " " ' I&&& ( J'''  + Z* *D H Y_fllnn5666  '4'. .#t#T**r/ct|j||g}|r|d|r|d|gz }| |j|S|j|S)zX Internal add_document_hash used for both batch and single doc indexing rr) ADDHASH_CMDrqrsrz)r)rrrMrrrrs r-_add_document_hashz!SearchCommands._add_document_hash,skT_fe<  # KK " " "  + Z* *D  '4'. .#t#T**r/z2.0.0z2deprecated since redisearch 2.0, call hset instead)versionreasonrrrMrrrrrc 0|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)rrrMrrrrr)r) r)rrrMrrrrrr{s r- add_documentzSearchCommands.add_document@sKV"t!         r/c6||d|||S)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)rrMrr)r)r)rrMrrs r-add_document_hashz SearchCommands.add_document_hashxs, && UXw'   r/czt|j|g}|r|d| |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 r)DEL_CMDrqrsrz)r)rrdelete_actual_documentrrs r-delete_documentzSearchCommands.delete_documentsR&1 !  KK     '4'. .#t#T**r/c|j|}d|D}|} |d=n#t$rYnwxYwt dd|i|S). Load a single document by id cNi|]"\}}t|t|#SrOr rPkvs r-r[z0SearchCommands.load_document..* D D DTQillIaLL D D Dr/idrOr'hgetallrKeyErrorrr)rr{f2s r- load_documentzSearchCommands.load_documents$$R(( D DV\\^^ D D D t     D ((2((((sA A  A c4|jt|jg|RS)z Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )rzMGET_CMDrq)r)idss r-getzSearchCommands.gets#$t#HdoDDDDDr/cx|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 `_. rzINFO_CMDrqr.r)r+s r-infozSearchCommands.infos1""8T_==""8S111r/ query_paramsc4|gSg}t|dkr~|d|t|dz|D]/\}}||||0|S)Nrparamsr )rTrsr)r)rrrkeyvalues r-get_params_argszSearchCommands.get_params_argss  I |  q KK ! ! ! KKL))A- . . .*0022 # # U C    E"""" r/c(|jg}t|trt|}t|tst dt |||z }|||z }||fS)NzBad query type )rqrGstrr ValueErrortypeget_argsr)r)r8rrrs r-_mk_query_argszSearchCommands._mk_query_argss  eS ! ! !%LLE%'' >`_. r@@r8r9rtimerz SEARCH_CMDrGrr.r)r8rrrstr+s r-searchzSearchCommands.searchs ))%l)KK e Y[["d":5555 c8 $ $ J"" 5DIKK"4D3N#   r/c\|||\}}|jtg|RS)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. r)rrz EXPLAIN_CMD)r)r8rrr query_texts r-explainzSearchCommands.explains< ..u<.PPj#t#K7$7777r/c td)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r)r8s r- explain_clizSearchCommands.explain_cli s!"GHHHr/ct|tr8t|j}t|jg|z}nLt|tr'd}td|jg|z}ntd||| |z }|j |}| t|||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 queryr8rC rGrboolrH AGGREGATE_CMDrq build_argsr CURSOR_CMDrrrzr.r)r8rrCr*raws r- aggregatezSearchCommands.aggregate s" e- . . 1em,,J $/2U5E5E5G5GGCC v & & 1Jvt7%:J:J:L:LLCC[%00 0 t##L111"d"C("" 3e #   r/rrCc(|rCt|tr|d|_|}nt|d}|d}nd}t|tr|jr|d}|dd}n d}|dd}t |||S)Nr rr )rGrcidr _with_schemar)r)rr8rCcursorschemarowss r-rDz$SearchCommands._get_aggregate_result-s  %(( (F Aa&CCF e- . . 53E VFqrr7DDFqrr7DtVV444r/limitedc2tj}t|jdg}|r|d|dt |t rd|d<||z }nYt |tr5d|d<||z }|| |z }ntd|j |}| t||tj|z dz 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. rLIMITEDQUERY AGGREGATEr SEARCHz5Must provide AggregateRequest object or Query object.rr) r PROFILE_CMDrqrsrGrrrrrrrzr.)r)r8rrrr*r+s r-profilezSearchCommands.profileCs$Y[[DOR0  " JJy ! ! ! 7 e- . . V CF 5##%% %CC u % % VCF 5>>## #C 4'' 55 5CCTUU U"d"C("" ETY[[25E4O#   r/ct|j|g}|r|d|g|r|dd|g|r|dd|g|j|}|t|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 `_. DISTANCETERMSINCLUDEEXCLUDESPELLCHECK_CMDrqextendrzr.r)r8distanceincludeexcluder*r+s r- spellcheckzSearchCommands.spellcheckkst6  / JJ H- . . .  6 JJG4 5 5 5  6 JJG4 5 5 5"d"C("">3777r/nametermscRt|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_CMDr rzr)rrr*s r-dict_addzSearchCommands.dict_add0T" 5#t#S))r/cRt|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_CMDr rzrs r-dict_delzSearchCommands.dict_delrr/c(t|g}|j|S)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDrz)r)rr*s r- dict_dumpzSearchCommands.dict_dumpsd##t#S))r/optionrreturnc8td||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_CMDrzr)rrr*rs r- config_setzSearchCommands.config_sets+5&%0"d"C(d{r/c`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 `_. GETr&rzr.r)rr*r+s r- config_getzSearchCommands.config_gets55&)"d"C("":s333r/tagfieldcD|t|j|S)z Return a list of all possible tag values ### Parameters - **tagfield**: Tag field name For more information see `FT.TAGVALS `_. )rz TAGVALS_CMDrq)r)r/s r-tagvalszSearchCommands.tagvalss##K(KKKr/aliascD|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 `_. )rz ALIAS_ADD_CMDrqr)r3s r-aliasaddzSearchCommands.aliasadds##M5$/JJJr/cD|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 `_. )rzALIAS_UPDATE_CMDrqr6s r- aliasupdatezSearchCommands.aliasupdates##$4eT_MMMr/c8|t|S)z Removes an alias to a search index ### Parameters - **alias**: Name of the alias to delete For more information see `FT.ALIASDEL `_. )rz ALIAS_DEL_CMDr6s r-aliasdelzSearchCommands.aliasdels##M5999r/cj|d}|D]}t||j|jg}|dr|d|jr/|d||j|j||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 `_. F transaction incrementINCRr pipelineSUGADD_COMMANDstringrMrrsrrzexecuter)r suggestionsr,pipesugrrs r-sugaddzSearchCommands.sugadds}}}// ( (C"CSY?Dzz+&& $ F###{ ) I&&& CK((( D $ ' ' '||~~b!!r/rc8|t|S)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )rzSUGLEN_COMMAND)r)rs r-suglenzSearchCommands.suglens ##NC888r/rGc:|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 `_. )rzSUGDEL_COMMAND)r)rrGs r-sugdelzSearchCommands.sugdels##NC@@@r/ prefixfuzzynumr< with_payloadsct||d|g}|r|t|r|t|r|t|j|}g} |s| St |||} d| 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 `_. MAXcg|]}|SrOrOrPss r-rRz)SearchCommands.sugget..["""a"""r/SUGGET_COMMANDrsr rr!rzr) r)rrUrVrWr<rXrrr+resultsparsers r-suggetzSearchCommands.sugget%sPVUC8   KK     $ KK # # #  & KK % % %"d"D) N!+}cBB""6""""r/groupid skipinitialct|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_CMDrqr rz)r)rerfrr*s r- synupdatezSearchCommands.synupdate]sR$dow7  , JJ)* + + + 5#t#S))r/cx|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 `_. )rz SYNDUMP_CMDrqr.rs r-syndumpzSearchCommands.syndumpus1"";@@"";444r/)rb) FFNNFNFFF)F)NFrNFFNF)NrNF)FrNFFNF)rNF)NFr1)FNNNNFrTFF)=__name__ __module__ __qualname____doc__r.r6rArErJrWr\rarfrrrrrrrrrfloatrrrrrrrrrrSbytesrrrrrrrrrDrrrrrr(r.r2r7r:r=rMrPrSrrdrirlrOr/r-r#r#?s?DDD !!!   VVV - - -###J>>>CCC>>>>!E+E+E+E+N+tCy++++( P P$ P P P P$(+(+(+(+VDI++++( T "&3 3 3 3  3  3  3 3 3-3 3 s)3 3 3 3 j T    "++++& ) ) ) E E E 2 2 2 !$sE#sE52H,I'I"JD"PQ    #(c5c5%9O3P.P)QSW)W#X&OS  S%Z  DeCeU,B&C!CDdJK    <;? 8 8S%Z  83c3o 667 8 8 8 8IsEz!2IIII ;?  S%Z  3c3o 667    @55 %c52B&B C5QU55552DH & & S%!112& & tCsC)?$?@A & & & & P88888 *S *$s) * * * * *S *$s) * * * * *c * * * *  S T     4 4 4 4 4 4 L L L L L Kc K K K K N N N N N :c : : : :""".9#9#9999A#AsAsAAAA!#6#6# 6#6# 6#  6#  6#6#  6#6#6#6#p***4*c****0 5 5 5 5 5r/r#ceZdZdZ ddeeefdeeeeee fffdZ ddeeefdeeeeee fffdZ ddZ ded ed e fd Zded efd Zd ZdZ ddedede dede de d eefdZdS)AsyncSearchCommandscK|t|jd{V}|t|S)rNrrs r-rzAsyncSearchCommands.infosG((4?CCCCCCCC""8S111r/Nr8rc*K|||\}}tj}|jtg|Rd{V}t |t r|S|t||tj|z dzS)rrNrrrrs r-rzAsyncSearchCommands.searchs ))%l)KK e Y[[(D(;d;;;;;;;;; c8 $ $ J"" 5DIKK"4D3N#   r/cKt|tr8t|j}t|jg|z}nLt|tr'd}td|jg|z}ntd||| |z }|j |d{V}| t|||S)rTrrNrrrs r-rzAsyncSearchCommands.aggregates" e- . . 1em,,J $/2U5E5E5G5GGCC v & & 1Jvt7%:J:J:L:LLCC[%00 0 t##L111(D(#......."" 3e #   r/cKt|j|g}|r|d|g|r|dd|g|r|dd|g|j|d{V}|t|S)rrrrr Nr r s r-rzAsyncSearchCommands.spellcheckst6  / JJ H- . . .  6 JJG4 5 5 5  6 JJG4 5 5 5(D(#......."">3777r/rrr cHKtd||g}|j|d{V}|dkS)r"r#Nr$r%r's r-r(zAsyncSearchCommands.config_setsA5&%0(D(#.......d{r/ctKtd|g}i}|j|d{V}|t|S)r*r+Nr,r-s r-r.zAsyncSearchCommands.config_getsP5&)(D(#......."":s333r/cK|j|d{V}d|D}|} |d=n#t$rYnwxYwt dd|i|S)rNcNi|]"\}}t|t|#SrOr rs r-r[z5AsyncSearchCommands.load_document..rr/rrOrrs r-rz!AsyncSearchCommands.load_documents{**2........ D DV\\^^ D D D t     D ((2((((sA AAczK|d}|D]}t||j|jg}|dr|d|jr/|d||j|j||d{VdS)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?rArBrNrCrDrIs r-rMzAsyncSearchCommands.sugadds}}}// ( (C"CSY?Dzz+&& $ F###{ ) I&&& CK((( D $ ' ' 'llnn$$$$$$b))r/FrTrrUrVrWr<rXc,Kt||d|g}|r|t|r|t|r|t|j|d{V}g} |s| St |||} d| DS)rZr[Ncg|]}|SrOrOr]s r-rRz.AsyncSearchCommands.sugget..]r_r/r`) r)rrUrVrWr<rXrrretrbrcs r-rdzAsyncSearchCommands.sugget'sPVUC8   KK     $ KK # # #  & KK % % %(D($/////// N!+}cBB""6""""r/r1rmrn)rorprqrrrrrrSrsrrrrr(r.rrMrrrdrOr/r-rvrvs 2 2 2;?  S%Z  3c3o 667    <;?  S%Z  3c3o 667    @88888 s 3 4     4s 4s 4 4 4 4 ) ) )***6!#6#6# 6#6# 6#  6#  6#6#  6#6#6#6#6#6#r/rv)Irwrtypingrrrr redis.clientr redis.utilsrhelpersr r _utilr aggregationrrrdocumentrr8rrIrrNrrrprrrrDROP_CMDrrEXPLAINCLI_CMDrrrrr rrrGET_CMDrr&r1r5r9r<rrFrRrOrarhrkrrrrrrrrrr r!r#rvrOr/r-rs9 ............!!!!!!++++++99999999BBBBBBBBBB((((((                      #         #   @ 5@ 5@ 5@ 5@ 5@ 5@ 5@ 5F[#[#[#[#[#.[#[#[#[#[#r/