+hzddlZddlZddlmZmZmZmZddlmZddl 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;defd?Z3d>efd@Z4d>efdAZ5dBZ6dCed9e fdDZ7dCedEed9e fdFZ8 d\dCedGedHedIe dJedKed9ee9fdLZ:dSdMedNed3eefdOZ;dPZr )r(r*r+r7results r,_parse_profilezSearchCommands._parse_profileXsw e- .//Au}}MFA%%% +!00!.. F}SV,,,r.c i}|dk(r|S|D]X}t|tr|dk(rt|dk7r(|ds.|dds7|dDcgc] }|d|ddc}||d<Z|Scc}w)Nrr%r r )score suggestion)rFintlen)r(r*r+ corrections _correction_items r,_parse_spellcheckz SearchCommands._parse_spellcheckgs !8  K+s+ q0@;1$q>q>!$$JUUV+@E%(%(;+K A '5 < +s A)c B|r|Dcic] }|d|d c}SiScc}w)Nrr )r(r*r+kvss r,_parse_config_getz SearchCommands._parse_config_gets)25#.3AA.=2=.sc htdt|dDcic]}||||dzc}Scc}w)Nrr r )rangerN)r(r*r+is r,_parse_syndumpzSearchCommands._parse_syndumps4,1!SXq,ABqAAE "BBBs/c(|j||S)zT Create a new batch indexer from the client with a given chunk size ) chunk_size) BatchIndexer)r(r\s r, batch_indexerzSearchCommands.batch_indexers  * ==r.Nc 6t|jg} || |jz } |r| jt|6t |t r&| jt| j||r| jt|r| jt|r| jt| r| jt| r| jt|Kt |tttfr0| t t#|gz } t#|dkDr| t|z } | jd | tt%j&d|Dz } |j,| S#t($r| |j+z } Y-wxYw)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 `_. rSCHEMAc3<K|]}|jywr0 redis_args.0fs r, z.SearchCommands.create_index..*Ja1<<>*J) CREATE_CMD index_nameargsappendrrFrMrrrrrrlisttuplesetrrN itertoolschain TypeErrorrcexecute_command) r(fieldsno_term_offsetsno_field_flags stopwords definitionmax_text_fields temporary no_highlightno_term_frequenciesskip_initial_scanrls r, create_indexzSearchCommands.create_indexsSPDOO,  ! JOO #D  KK &  Z 3%? KK " KK "  KK "  KK   KK !  KK  KK (  Z D%;M%N YI/ /D9~!Y' H ( D*J6*JKL LD$t##T** ( F%%' 'D (s%E99FFruct|jddg} |ttjd|Dz }|j|S#t $r||j z }Y-wxYw)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`ADDc3<K|]}|jywr0rbrds r,rgz2SearchCommands.alter_schema_add..rhri) ALTER_CMDrkrnrqrrrsrcrt)r(rurls r,alter_schema_addzSearchCommands.alter_schema_addsr4??He< ( D*J6*JKL LD$t##T** ( F%%' 'D (s%A A)(A)delete_documentscP|rdnd}|jt|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)rt DROPINDEX_CMDrk)r(r delete_strs r, dropindexzSearchCommands.dropindexs&.T2 ##M4??JOOr.c  |s| rd}t|j||g} |r| jd|"| jd| j||r7| jd|r| jd| r| jd|r| d|gz } | jd| tt j | j z } ||j| S|j| S) zS Internal add_document used for both batch and single doc indexing TNOSAVEPAYLOADREPLACEPARTIALNOCREATELANGUAGEFIELDS)ADD_CMDrkrmrnrqrritemsrt) r(doc_idconnnosaverKpayloadreplacepartiallanguage no_createrurls r, _add_documentzSearchCommands._add_documents" iG&%8  KK !   KK " KK  KK " I& J'  Z* *D H Y__flln566  '4''. .#t##T**r.ct|j||g}|r|jd|r|d|gz }||j|S|j|S)zX Internal add_document_hash used for both batch and single doc indexing rr) ADDHASH_CMDrkrmrt)r(rrrKrrrls r,_add_document_hashz!SearchCommands._add_document_hash,scT__fe<  KK "  Z* *D  '4''. .#t##T**r.z2.0.0z2deprecated since redisearch 2.0, call hset instead)versionreasonrrrKrrrrrc :|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)rrrKrrrrr)r) r(rrrKrrrrrrus r, add_documentzSearchCommands.add_document@sDV"t!!       r.c.|j|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)rrKrr)r)r(rrKrrs r,add_document_hashz SearchCommands.add_document_hashxs' && UXw'  r.ct|j|g}|r|jd||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_CMDrkrmrt)r(rrdelete_actual_documentrls r,delete_documentzSearchCommands.delete_documentsO&1 ! KK   '4''. .#t##T**r.c|jj|}|jDcic]\}}t|t|}}}|} |d=t dd|i|Scc}}w#t$rYwxYw). Load a single document by id idrTr&hgetallrr KeyErrorrr(rrukvf2s r, load_documentzSearchCommands.load_documents$$R(5;\\^ DTQilIaL( D D t (2(((E    sA$A** A65A6cF|jt|jg|S)z Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )rtMGET_CMDrk)r(idss r,getzSearchCommands.gets"$t##HdooDDDr.cn|jt|j}|jt|S) Get info an stats about the the current index, including the number of documents, memory consumption, etc For more information see `FT.INFO `_. rtINFO_CMDrkr-r(r*s r,infozSearchCommands.infos-""8T__=""8S11r. query_paramsc|gSg}t|dkDrh|jd|jt|dz|jD]'\}}|j||j|)|S)Nrparamsr )rNrmr)r(rrlkeyvalues r,get_params_argszSearchCommands.get_params_argss~  I | q KK ! KKL)A- .*002 # U C  E" # r.c|jg}t|tr t|}t|tst dt |||j z }||j|z }||fS)NzBad query type )rkrFstrr ValueErrortypeget_argsr)r(r7rrls r,_mk_query_argszSearchCommands._mk_query_argsss  eS !%LE%'tE{m<= =    $$\22U{r.r7c |j||\}}tj}|jtg|}t |t r|S|j t||tj|z dzS) 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 `_. r@@r7r8rtimert SEARCH_CMDrFrr-r(r7rrlstr*s r,searchzSearchCommands.searchs ))%l)K e YY["d"":55 c8 $J"" 5DIIK"4D3N#  r.c\|j||\}}|jtg|S)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. r)rrt EXPLAIN_CMD)r(r7rrl query_texts r,explainzSearchCommands.explains6 ..u<.Pj#t##K7$77r.ctd)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r(r7s r, explain_clizSearchCommands.explain_cli s!"GHHr.ct|tr9t|j}t|j g|j z}nCt|tr'd}td|j g|j z}n td|||j|z }|j|}|jt|||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 queryr7rB rFrboolrG AGGREGATE_CMDrk build_argsr CURSOR_CMDrrrtr-r(r7rrBr)raws r, aggregatezSearchCommands.aggregate s" e- .emm,J $//2U5E5E5GGC v &Jvt7%:J:J:LLC[%0 0 t##L11"d""C("" 3e #  r.rrBc|r1t|tr |d|_|}nt|d}|d}nd}t|tr|jr |d}|dd}nd}|dd}t |||S)Nr rr )rFrcidr _with_schemar)r(rr7rBcursorschemarowss r,rCz$SearchCommands._get_aggregate_result-s %(F Aa&CF e- .53E3EVFqr7DFqr7DtVV44r.limitedctj}t|jdg}|r|jd|jdt |t rd|d<||j z }nHt |tr-d|d<||jz }||j|z }n td|j|}|jt||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_CMDrkrmrFrrrrrrrtr-)r(r7rrrr)r*s r,profilezSearchCommands.profileCs$YY[DOOR0  JJy ! 7 e- . CF 5##% %C u %CF 5>># #C 4'' 5 5CTU U"d""C("" ETYY[25E4O#  r.ct|j|g}|r|jd|g|r|jdd|g|r|jdd|g|j|}|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_CMDrkextendrtr-r(r7distanceincludeexcluder)r*s r, spellcheckzSearchCommands.spellcheckksyt6  JJ H- .  JJG4 5  JJG4 5"d""C("">377r.nametermscRt|g}|j||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_CMDrrtr(rr r)s r,dict_addzSearchCommands.dict_add-T" 5#t##S))r.cRt|g}|j||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_CMDrrtr s r,dict_delzSearchCommands.dict_delrr.c0t|g}|j|S)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDrt)r(rr)s r, dict_dumpzSearchCommands.dict_dumps!d##t##S))r.optionrreturnc>td||g}|j|}|dk(S)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_CMDrtr(rrr)rs r, config_setzSearchCommands.config_sets.5&%0"d""C(d{r.c^td|g}|j|}|jt|S)Get runtime configuration option value. ### Parameters - **option**: the name of the configuration option. For more information see `FT.CONFIG GET `_. GETrrtr-r(rr)r*s r, config_getzSearchCommands.config_gets55&)"d""C("":s33r.tagfieldcD|jt|j|S)z Return a list of all possible tag values ### Parameters - **tagfield**: Tag field name For more information see `FT.TAGVALS `_. )rt TAGVALS_CMDrk)r(r%s r,tagvalszSearchCommands.tagvalss##K(KKr.aliascD|jt||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 `_. )rt ALIAS_ADD_CMDrkr(r)s r,aliasaddzSearchCommands.aliasadds##M5$//JJr.cD|jt||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 `_. )rtALIAS_UPDATE_CMDrkr,s r, aliasupdatezSearchCommands.aliasupdates##$4eT__MMr.c.|jt|S)z Removes an alias to a search index ### Parameters - **alias**: Name of the alias to delete For more information see `FT.ALIASDEL `_. )rt ALIAS_DEL_CMDr,s r,aliasdelzSearchCommands.aliasdels##M599r.ch|jd}|D]}t||j|jg}|j dr|j d|j r,|j d|j |j |j||jdS)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_COMMANDstringrKrrmrrtexecuter(r suggestionsr+pipesugrls r,sugaddzSearchCommands.sugadds}}}/ (C"CSYY?Dzz+& F#{{ I& CKK( D $ ' (||~b!!r.rc.|jt|S)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )rtSUGLEN_COMMAND)r(rs r,suglenzSearchCommands.suglens ##NC88r.r=c0|jt||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 `_. )rtSUGDEL_COMMAND)r(rr=s r,sugdelzSearchCommands.sugdels##NC@@r.prefixfuzzynumr; with_payloadsct||d|g}|r|jt|r|jt|r|jt|j |}g} |s| St |||} | D cgc]} | c} Scc} w)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 `_. MAXSUGGET_COMMANDrmrrr rtr) r(rrJrKrLr;rMrlr*resultsparserss r,suggetzSearchCommands.sugget%sPVUC8  KK   KK #  KK %"d""D)N!+}cB!"a"""s7 Bgroupid skipinitialct|j|g}|r|jdg|j||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_CMDrkrrt)r(rWrXr r)s r, synupdatezSearchCommands.synupdate]sF$doow7  JJ)* + 5#t##S))r.cn|jt|j}|jt|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 `_. )rt SYNDUMP_CMDrkr-rs r,syndumpzSearchCommands.syndumpus-"";@"";44r.)d) FFNNFNFFF)F)NF?NFFNF)Nr`NF)Fr`NFFNF)r`NF)NFr0)FNNNNF FF)=__name__ __module__ __qualname____doc__r-r5r@rDrIrRrVrZr^rrrrrrrrrfloatrrrrrrrrrrMbytesrrrrrrrrrCrrr rrrr$r(r-r0r3rCrFrIrrVr[r^rTr.r,r"r"?swD ! V -#J>C>!E+N+tCy+( P$ P$(+VDI+( T "&3 3 3  3  3  3 3 3-3 3 s)3 3 j T  "+& ) E 2 !$sE#sE52H,I'I"JD"PQ #(c5c5%9O3P.P)QSW)W#X&OS S%Z  DeCeU,B&C!CDdJK <;? 8S%Z  83c3o 667 8IsEz!2I ;? S%Z  3c3o 667 @55 %c52B&B C5QU52DH & S%!112& & tCsC)?$?@A & P88 *S *$s) * *S *$s) * *c *  S T  4 4 4 L L Kc K N N :c :".9#9#9A#AsAsA!#6# 6#6# 6#  6#  6#6#  6#p**4*c*0 5r.r"ceZdZdZ ddeeefdeeeeee fffdZ ddeeefdeeeeee fffdZ ddZ ded ed e fd Zded efd Zd ZdZ ddedede dede de d eefdZy)AsyncSearchCommandscK|jt|jd{}|jt|S7w)rNrrs r,rzAsyncSearchCommands.infos:((4??CC""8S11Ds$AAANr7rc&K|j||\}}tj}|jtg|d{}t |t r|S|j t||tj|z dzS7Gw)rrNrrrrs r,rzAsyncSearchCommands.searchs ))%l)K e YY[(D((;d;; c8 $J"" 5DIIK"4D3N#  377/sA'B)B*BrrrcZKtd||g}|j|d{}|dk(S7 w)rrNrrrs r,rzAsyncSearchCommands.config_sets:5&%0(D((#..d{/s +) +c~Ktd|g}i}|j|d{}|jt|S7w)r r!Nr"r#s r,r$zAsyncSearchCommands.config_getsF5&)(D((#.."":s33/s =;=cK|jj|d{}|jDcic]\}}t|t|}}}|} |d=t dd|i|S7Lcc}}w#t$rY wxYww)rNrrTrrs r,rz!AsyncSearchCommands.load_documents{{**2..5;\\^ DTQilIaL( D D t (2(((/ D    sDBA.BA0BA6!B0B6 B?BBBcK|jd}|D]}t||j|jg}|j dr|j d|j r,|j d|j |j |j||jd{dS7w)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 `_. Fr5r7r8rNr9r:r?s r,rCzAsyncSearchCommands.sugadds}}}/ (C"CSYY?Dzz+& F#{{ I& CKK( D $ ' (lln$b))$sB4C6B>7CrrJrKrLr;rMc,Kt||d|g}|r|jt|r|jt|r|jt|j |d{}g} |s| St |||} | D cgc]} | c} S7'cc} ww)rOrPNrQ) r(rrJrKrLr;rMrlretrSrTrUs r,rVzAsyncSearchCommands.sugget'sPVUC8  KK   KK #  KK %(D(($//N!+}cB!"a"" 0 #s$A#B%B &B B BBr0rarb)rdrerfrrrrrrMrhrrrrrr$rrCrrrVrTr.r,rkrks 2;? S%Z  3c3o 667 <;? S%Z  3c3o 667 @88 s 3 4  4s 4s 4 )*6!#6# 6#6# 6#  6#  6#6#  6#r.rk)Irqrtypingrrrr redis.clientr redis.utilsrhelpersr r _utilr aggregationrrrdocumentrr7rrHrrLrrrjrrrrDROP_CMDrrEXPLAINCLI_CMDrrrrrr rrGET_CMDrrr'r+r/r2rr<rHrErRrZr]rrrrrrrrrrr r"rkrTr.r,rs" ..!+9BB(                      #         #   @ 5@ 5F[#.[#r.