U b+d'@s~eZGdddZGdddZGdddZGdddeZGdd d eZGd d d ZGd d d ZGdddZ dS)c@seZdZdddZddZdS)LimitcCs||_||_dSN)offsetcount)selfrrrE/tmp/pip-unpacked-wheel-cdsyf3nb/redis/commands/search/aggregation.py__init__szLimit.__init__cCs$|jrdt|jt|jgSgSdS)NZLIMIT)rstrrrrrr build_args szLimit.build_argsN)rr__name__ __module__ __qualname__r r rrrrrs rc@s0eZdZdZdZddZddZeddZdS) Reducerzr Base reducer object for all reducers. See the `redisearch.reducers` module for the actual reducers. NcGs||_d|_d|_dSr)_args_field_aliasrargsrrrr szReducer.__init__cCs.|tkr$|jstd|jdd}||_|S)a Set the alias for this reducer. ### Parameters - **alias**: The value of the alias for this reducer. If this is the special value `aggregation.FIELDNAME` then this reducer will be aliased using the same name as the field upon which it operates. Note that using `FIELDNAME` is only possible on reducers which operate on a single field value. This method returns the `Reducer` object making it suitable for chaining. z(Cannot use FIELDNAME alias with no fieldN) FIELDNAMEr ValueErrorr)raliasrrrrs z Reducer.aliascCs|jSr)rr rrrr5sz Reducer.args) rrr__doc__NAMEr rpropertyrrrrrrs rc@seZdZdZdZddZdS) SortDirectionz@ This special class is used to indicate sort direction. NcCs ||_dSr)field)rrrrrr AszSortDirection.__init__)rrrr DIRSTRINGr rrrrr:src@seZdZdZdZdS)AsczK Indicate that the given field should be sorted in ascending order ASCNrrrrr rrrrr!Esr!c@seZdZdZdZdS)DesczL Indicate that the given field should be sorted in descending order ZDESCNr#rrrrr$Msr$c@steZdZdZdddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ dddZ ddZddZdS) AggregateRequestzH Aggregation request which can be passed to `Client.aggregate`. *cCs:||_g|_g|_d|_d|_d|_d|_g|_d|_dS)a} Create an aggregation request. This request may then be passed to `client.aggregate()`. In order for the request to be usable, it must contain at least one group. - **query** Query string for filtering records. All member methods (except `build_args()`) return the object itself, making them useful for chaining. FrN) _query_aggregateplan _loadfields_loadallZ_max _with_schema _verbatim_cursor_dialect)rqueryrrrr Zs zAggregateRequest.__init__cGs|r|j|nd|_|S)aC Indicate the fields to be returned in the response. These fields are returned in addition to any others implicitly specified. ### Parameters - **fields**: If fields not specified, all the fields will be loaded. Otherwise, fields should be given in the format of `@field`. T)r)extendr*)rfieldsrrrloadqs zAggregateRequest.loadcGst|tr|gn|}t|tr$|gn|}dtt|f|}|D]B}|d|jtt|jg7}||j|jdk r@|d|jg7}q@|j||S)a| Specify by which fields to group the aggregation. ### Parameters - **fields**: Fields to group by. This can either be a single string, or a list of strings. both cases, the field should be specified as `@field`. - **reducers**: One or more reducers. Reducers may be found in the `aggregation` module. ZGROUPBYREDUCENAS) isinstancer rlenrrr0rr()rr1ZreducersretZreducerrrrgroup_bys    zAggregateRequest.group_bycKs>|D]0\}}d|g}|dk r,|d|g7}|j|q|S)aQ Specify one or more projection expressions to add to each result ### Parameters - **kwexpr**: One or more key-value pairs for a projection. The key is the alias for the projection, and the value is the projection expression itself, for example `apply(square_root="sqrt(@foo)")` ZAPPLYNr4)itemsr(r0)rZkwexprrexprr7rrrapplys  zAggregateRequest.applycCst||}|j||S)a Sets the limit for the most recent group or query. If no group has been defined yet (via `group_by()`) then this sets the limit for the initial pool of results from the query. Otherwise, this limits the number of items operated on from the previous group. Setting a limit on the initial search results may be useful when attempting to execute an aggregation on a sample of a large data set. ### Parameters - **offset**: Result offset from which to begin paging - **num**: Number of results to return Example of sorting the initial results: ``` AggregateRequest("@sale_amount:[10000, inf]") .limit(0, 10) .group_by("@state", r.count()) ``` Will only group by the states found in the first 10 results of the query `@sale_amount:[10000, inf]`. On the other hand, ``` AggregateRequest("@sale_amount:[10000, inf]") .limit(0, 1000) .group_by("@state", r.count() .limit(0, 10) ``` Will group all the results matching the query, but only return the first 10 groups. If you only wish to return a *top-N* style query, consider using `sort_by()` instead. )rr(r0r )rrnumZ_limitrrrlimits* zAggregateRequest.limitcOst|ttfr|g}g}|D]*}t|tr<||j|jg7}q||g7}qdtt|g}|||dd}|dkr|dt|g7}|j||S)a, Indicate how the results should be sorted. This can also be used for *top-N* style queries ### Parameters - **fields**: The fields by which to sort. This can be either a single field or a list of fields. If you wish to specify order, you can use the `Asc` or `Desc` wrapper classes. - **max**: Maximum number of results to return. This can be used instead of `LIMIT` and is also faster. Example of sorting by `foo` ascending and `bar` descending: ``` sort_by(Asc("@foo"), Desc("@bar")) ``` Return the top 10 customers: ``` AggregateRequest() .group_by("@customer", r.sum("@paid").alias(FIELDNAME)) .sort_by(Desc("@paid"), max=10) ``` ZSORTBYmaxrMAX) r5r rrr r6r0getr()rr1kwargsZ fields_argsfr7r>rrrsort_bys     zAggregateRequest.sort_bycCs.t|tr|g}|D]}|jd|gq|S)z Specify filter for post-query results using predicates relating to values in the result set. ### Parameters - **fields**: Fields to group by. This can either be a single string, or a list of strings. ZFILTER)r5r r(r0)rZ expressionsZ expressionrrrfilter s zAggregateRequest.filtercCs d|_|S)z| If set, the `schema` property will contain a list of `[field, type]` entries in the result object. T)r+r rrr with_schemaszAggregateRequest.with_schemacCs d|_|S)NT)r,r rrrverbatim#szAggregateRequest.verbatimrcCs<dg}|r|dt|g7}|r2|dt|dg7}||_|S)NZ WITHCURSORCOUNTMAXIDLEi)r r-)rrmax_idlerrrrcursor'szAggregateRequest.cursorcCs|jg}|jr|d|jr(|d|jr8||j7}|jrT|d|dn0|jr|d|tt|j| |j|j r| d|j g| |j |S)NZ WITHSCHEMAZVERBATIMZLOADr&ZDIALECT) r'r+appendr,r-r*r)r r6r0r.r()rr7rrrr 0s$        zAggregateRequest.build_argscCs ||_|S)z Add a dialect field to the aggregate command. - **dialect** - dialect version to execute the query under )r.)rdialectrrrrMLszAggregateRequest.dialectN)r&)rrG)rrrrr r2r8r;r=rCrDrErFrKr rMrrrrr%Us ./ r%c@seZdZddZddZdS)CursorcCs||_d|_d|_dS)Nr)cidrJrrrOrrrr WszCursor.__init__cCs@t|jg}|jr$|dt|jg7}|jr<|dt|jg7}|S)NrIrH)r rOrJrrrrrr \s  zCursor.build_argsNr rrrrrNVsrNc@seZdZddZddZdS)AggregateResultcCs||_||_||_dSr)rowsrKschema)rrRrKrSrrrr fszAggregateResult.__init__c Cs@|jr|jjnd}d|jjdt|ddt|jd|d S)N)rKrO __class__ridr6rRrPrrr__repr__ks,zAggregateResult.__repr__N)rrrr rZrrrrrQesrQN) objectrrrrr!r$r%rNrQrrrrs *