1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
|
%global _empty_manifest_terminate_build 0
Name: python-rqlalchemy
Version: 0.4.5
Release: 1
Summary: "Resource Query Language for SQLAlchemy"
License: MIT
URL: https://github.com/pjwerneck/rqlalchemy
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ee/1a/2ce61928d7af68c85a779272dc454284cee3ada7c95988d75f0d62b9ac04/rqlalchemy-0.4.5.tar.gz
BuildArch: noarch
Requires: python3-pyrql
Requires: python3-sqlalchemy
%description
# RQLAlchemy
[](https://travis-ci.org/pjwerneck/rqlalchemy)
Resource Query Language extension for SQLAlchemy
## Overview
Resource Query Language (RQL) is a query language designed for use in URIs, with object-style data structures.
rqlalchemy is an RQL extension for SQLAlchemy. It easily allows exposing SQLAlchemy tables or models as an HTTP API endpoint and performing complex queries using only querystring parameters.
## Installing
```
pip install rqlalchemy
```
## Usage
RQL queries can be supported by an application using SQLAlchemy by adding the `rqlalchemy.RQLQueryMixIn` class as a mix-in class to your base `Query` class:
```python
from sqlalchemy import sessionmaker
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import Query as BaseQuery
from rqlalchemy import RQLQueryMixIn
# create the declarative base
Base = declarative_base()
# create the custom query class
class RQLQuery(BaseQuery, RQLQueryMixIn):
_rql_default_limit = 10
_rql_max_limit = 100
# pass the custom query class as a keyworkd argument to the sessionmaker
session = sessionmaker(bind=engine, query_cls=RQLQuery)
```
If you're using Flask-SQLAlchemy, you can pass it as a session option:
```
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(session_options={"query_cls": RQLQuery})
```
With that in place, you can perform RQL queries by passing the querystring to the query `rql()` method. For example, if you have a Flask HTTP API with an users collection endpoint querying your `User` model:
```python
from urllib.parse import unquote
from flask import request
@app.route('/users')
def get_users_collection():
qs = unquote(request.query_string.decode(request.charset))
query = session.query(User).rql(qs)
users = query.rql_all()
return render_response(users)
```
### Aggregates
As with the base SQLAlchemy Query class, you can retrieve results with the `all()` method, or by iterating over the query, however, if you want to support RQL expressions with aggregate functions or querying functions that result in a subset of columns, you must retrieve the results with `rql_all()`.
### Pagination
RQLAlchemy offers limit/offset pagination with the `rql_paginate()` method, which returns the requested page, the RQL expressions for previous and next pages if available, and the total number of items.
```python
from urllib.parse import unquote
from flask import request
@app.route('/users')
def get_users_collection():
qs = unquote(request.query_string.decode(request.charset))
query = session.query(User).rql(qs)
page, previous_page, next_page, total = query.rql_paginate()
response = {"data": page,
"total": total,
}
if previous_page:
response["previous"] = '/users?' + previous_page
if next_page:
response["next"] = '/users?' + next_page
return render_response(response)
```
Keep in mind that pagination requires a limit, either a `_rql_default_limit` value, a querystring `limit(x)`, or the `limit` parameter to the `rql()` method. Calling `rql_paginate()` without a limit will raise `RQLQueryError`.
## Reference Table
| RQL | SQLAlchemy | Obs. |
|-------------------------|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| QUERYING | | |
| select(a,b,c,...) | .query(Model.a, Model.b, Model.c,...) | |
| values(a) | [o.a for o in query.from_self(a)] | |
| limit(count,start?) | .limit(count).offset(start) | |
| sort(attr1) | .order_by(attr) | |
| sort(-attr1) | .order_by(attr.desc()) | |
| distinct() | .distinct() | |
| first() | .limit(1) | |
| one() | [query.one()] | |
| FILTERING | | |
| eq(attr,value) | .filter(Model.attr == value) | |
| ne(attr,value) | .filter(Model.attr != value) | |
| lt(attr,value) | .filter(Model.attr < value) | |
| le(attr,value) | .filter(Model.attr <= value) | |
| gt(attr,value) | .filter(Model.attr > value) | |
| ge(attr,value) | .filter(Model.attr >= value) | |
| in(attr,value) | .filter(Model.attr.in_(value) | |
| out(attr,value) | .filter(not_(Model.attr.in_(value))) | |
| contains(attr,value) | .filter(Model.contains(value)) | Produces a LIKE expression when filtering against a string, or an IN expression when filtering against an iterable relationship |
| excludes(attr,value) | .filter(not_(Model.contains(value))) | See above. |
| and(expr1,expr2,...) | .filter(and_(expr1, expr2, ...)) | |
| or(expr1,expr2,...) | .filter(or_(expr1, expr2, ...)) | |
| AGGREGATING | | All aggregation functions return scalar results. |
| aggregate(a,b\(c\),...) | .query(Model.a, func.b(Model.c)).group_by(Model.a) | |
| sum(attr) | .query(func.sum(Model.attr)) | |
| mean(attr) | .query(func.avg(Model.attr)) | |
| max(attr) | .query(func.max(Model.attr)) | |
| min(attr) | .query(func.min(Model.attr)) | |
| count() | .query(func.count()) | |
%package -n python3-rqlalchemy
Summary: "Resource Query Language for SQLAlchemy"
Provides: python-rqlalchemy
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-rqlalchemy
# RQLAlchemy
[](https://travis-ci.org/pjwerneck/rqlalchemy)
Resource Query Language extension for SQLAlchemy
## Overview
Resource Query Language (RQL) is a query language designed for use in URIs, with object-style data structures.
rqlalchemy is an RQL extension for SQLAlchemy. It easily allows exposing SQLAlchemy tables or models as an HTTP API endpoint and performing complex queries using only querystring parameters.
## Installing
```
pip install rqlalchemy
```
## Usage
RQL queries can be supported by an application using SQLAlchemy by adding the `rqlalchemy.RQLQueryMixIn` class as a mix-in class to your base `Query` class:
```python
from sqlalchemy import sessionmaker
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import Query as BaseQuery
from rqlalchemy import RQLQueryMixIn
# create the declarative base
Base = declarative_base()
# create the custom query class
class RQLQuery(BaseQuery, RQLQueryMixIn):
_rql_default_limit = 10
_rql_max_limit = 100
# pass the custom query class as a keyworkd argument to the sessionmaker
session = sessionmaker(bind=engine, query_cls=RQLQuery)
```
If you're using Flask-SQLAlchemy, you can pass it as a session option:
```
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(session_options={"query_cls": RQLQuery})
```
With that in place, you can perform RQL queries by passing the querystring to the query `rql()` method. For example, if you have a Flask HTTP API with an users collection endpoint querying your `User` model:
```python
from urllib.parse import unquote
from flask import request
@app.route('/users')
def get_users_collection():
qs = unquote(request.query_string.decode(request.charset))
query = session.query(User).rql(qs)
users = query.rql_all()
return render_response(users)
```
### Aggregates
As with the base SQLAlchemy Query class, you can retrieve results with the `all()` method, or by iterating over the query, however, if you want to support RQL expressions with aggregate functions or querying functions that result in a subset of columns, you must retrieve the results with `rql_all()`.
### Pagination
RQLAlchemy offers limit/offset pagination with the `rql_paginate()` method, which returns the requested page, the RQL expressions for previous and next pages if available, and the total number of items.
```python
from urllib.parse import unquote
from flask import request
@app.route('/users')
def get_users_collection():
qs = unquote(request.query_string.decode(request.charset))
query = session.query(User).rql(qs)
page, previous_page, next_page, total = query.rql_paginate()
response = {"data": page,
"total": total,
}
if previous_page:
response["previous"] = '/users?' + previous_page
if next_page:
response["next"] = '/users?' + next_page
return render_response(response)
```
Keep in mind that pagination requires a limit, either a `_rql_default_limit` value, a querystring `limit(x)`, or the `limit` parameter to the `rql()` method. Calling `rql_paginate()` without a limit will raise `RQLQueryError`.
## Reference Table
| RQL | SQLAlchemy | Obs. |
|-------------------------|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| QUERYING | | |
| select(a,b,c,...) | .query(Model.a, Model.b, Model.c,...) | |
| values(a) | [o.a for o in query.from_self(a)] | |
| limit(count,start?) | .limit(count).offset(start) | |
| sort(attr1) | .order_by(attr) | |
| sort(-attr1) | .order_by(attr.desc()) | |
| distinct() | .distinct() | |
| first() | .limit(1) | |
| one() | [query.one()] | |
| FILTERING | | |
| eq(attr,value) | .filter(Model.attr == value) | |
| ne(attr,value) | .filter(Model.attr != value) | |
| lt(attr,value) | .filter(Model.attr < value) | |
| le(attr,value) | .filter(Model.attr <= value) | |
| gt(attr,value) | .filter(Model.attr > value) | |
| ge(attr,value) | .filter(Model.attr >= value) | |
| in(attr,value) | .filter(Model.attr.in_(value) | |
| out(attr,value) | .filter(not_(Model.attr.in_(value))) | |
| contains(attr,value) | .filter(Model.contains(value)) | Produces a LIKE expression when filtering against a string, or an IN expression when filtering against an iterable relationship |
| excludes(attr,value) | .filter(not_(Model.contains(value))) | See above. |
| and(expr1,expr2,...) | .filter(and_(expr1, expr2, ...)) | |
| or(expr1,expr2,...) | .filter(or_(expr1, expr2, ...)) | |
| AGGREGATING | | All aggregation functions return scalar results. |
| aggregate(a,b\(c\),...) | .query(Model.a, func.b(Model.c)).group_by(Model.a) | |
| sum(attr) | .query(func.sum(Model.attr)) | |
| mean(attr) | .query(func.avg(Model.attr)) | |
| max(attr) | .query(func.max(Model.attr)) | |
| min(attr) | .query(func.min(Model.attr)) | |
| count() | .query(func.count()) | |
%package help
Summary: Development documents and examples for rqlalchemy
Provides: python3-rqlalchemy-doc
%description help
# RQLAlchemy
[](https://travis-ci.org/pjwerneck/rqlalchemy)
Resource Query Language extension for SQLAlchemy
## Overview
Resource Query Language (RQL) is a query language designed for use in URIs, with object-style data structures.
rqlalchemy is an RQL extension for SQLAlchemy. It easily allows exposing SQLAlchemy tables or models as an HTTP API endpoint and performing complex queries using only querystring parameters.
## Installing
```
pip install rqlalchemy
```
## Usage
RQL queries can be supported by an application using SQLAlchemy by adding the `rqlalchemy.RQLQueryMixIn` class as a mix-in class to your base `Query` class:
```python
from sqlalchemy import sessionmaker
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import Query as BaseQuery
from rqlalchemy import RQLQueryMixIn
# create the declarative base
Base = declarative_base()
# create the custom query class
class RQLQuery(BaseQuery, RQLQueryMixIn):
_rql_default_limit = 10
_rql_max_limit = 100
# pass the custom query class as a keyworkd argument to the sessionmaker
session = sessionmaker(bind=engine, query_cls=RQLQuery)
```
If you're using Flask-SQLAlchemy, you can pass it as a session option:
```
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(session_options={"query_cls": RQLQuery})
```
With that in place, you can perform RQL queries by passing the querystring to the query `rql()` method. For example, if you have a Flask HTTP API with an users collection endpoint querying your `User` model:
```python
from urllib.parse import unquote
from flask import request
@app.route('/users')
def get_users_collection():
qs = unquote(request.query_string.decode(request.charset))
query = session.query(User).rql(qs)
users = query.rql_all()
return render_response(users)
```
### Aggregates
As with the base SQLAlchemy Query class, you can retrieve results with the `all()` method, or by iterating over the query, however, if you want to support RQL expressions with aggregate functions or querying functions that result in a subset of columns, you must retrieve the results with `rql_all()`.
### Pagination
RQLAlchemy offers limit/offset pagination with the `rql_paginate()` method, which returns the requested page, the RQL expressions for previous and next pages if available, and the total number of items.
```python
from urllib.parse import unquote
from flask import request
@app.route('/users')
def get_users_collection():
qs = unquote(request.query_string.decode(request.charset))
query = session.query(User).rql(qs)
page, previous_page, next_page, total = query.rql_paginate()
response = {"data": page,
"total": total,
}
if previous_page:
response["previous"] = '/users?' + previous_page
if next_page:
response["next"] = '/users?' + next_page
return render_response(response)
```
Keep in mind that pagination requires a limit, either a `_rql_default_limit` value, a querystring `limit(x)`, or the `limit` parameter to the `rql()` method. Calling `rql_paginate()` without a limit will raise `RQLQueryError`.
## Reference Table
| RQL | SQLAlchemy | Obs. |
|-------------------------|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| QUERYING | | |
| select(a,b,c,...) | .query(Model.a, Model.b, Model.c,...) | |
| values(a) | [o.a for o in query.from_self(a)] | |
| limit(count,start?) | .limit(count).offset(start) | |
| sort(attr1) | .order_by(attr) | |
| sort(-attr1) | .order_by(attr.desc()) | |
| distinct() | .distinct() | |
| first() | .limit(1) | |
| one() | [query.one()] | |
| FILTERING | | |
| eq(attr,value) | .filter(Model.attr == value) | |
| ne(attr,value) | .filter(Model.attr != value) | |
| lt(attr,value) | .filter(Model.attr < value) | |
| le(attr,value) | .filter(Model.attr <= value) | |
| gt(attr,value) | .filter(Model.attr > value) | |
| ge(attr,value) | .filter(Model.attr >= value) | |
| in(attr,value) | .filter(Model.attr.in_(value) | |
| out(attr,value) | .filter(not_(Model.attr.in_(value))) | |
| contains(attr,value) | .filter(Model.contains(value)) | Produces a LIKE expression when filtering against a string, or an IN expression when filtering against an iterable relationship |
| excludes(attr,value) | .filter(not_(Model.contains(value))) | See above. |
| and(expr1,expr2,...) | .filter(and_(expr1, expr2, ...)) | |
| or(expr1,expr2,...) | .filter(or_(expr1, expr2, ...)) | |
| AGGREGATING | | All aggregation functions return scalar results. |
| aggregate(a,b\(c\),...) | .query(Model.a, func.b(Model.c)).group_by(Model.a) | |
| sum(attr) | .query(func.sum(Model.attr)) | |
| mean(attr) | .query(func.avg(Model.attr)) | |
| max(attr) | .query(func.max(Model.attr)) | |
| min(attr) | .query(func.min(Model.attr)) | |
| count() | .query(func.count()) | |
%prep
%autosetup -n rqlalchemy-0.4.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-rqlalchemy -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.5-1
- Package Spec generated
|
