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
|
import sqlalchemy as sa
from pytest import raises
from sqlalchemy_utils import sort_query
from sqlalchemy_utils.functions import QuerySorterException
from tests import assert_contains, TestCase
class TestSortQuery(TestCase):
def test_without_sort_param_returns_the_query_object_untouched(self):
query = self.session.query(self.Article)
query = sort_query(query, '')
assert query == query
def test_column_ascending(self):
query = sort_query(self.session.query(self.Article), 'name')
assert_contains('ORDER BY article.name ASC', query)
def test_column_descending(self):
query = sort_query(self.session.query(self.Article), '-name')
assert_contains('ORDER BY article.name DESC', query)
def test_skips_unknown_columns(self):
query = self.session.query(self.Article)
query = sort_query(query, '-unknown')
assert query == query
def test_non_silent_mode(self):
query = self.session.query(self.Article)
with raises(QuerySorterException):
sort_query(query, '-unknown', silent=False)
def test_join(self):
query = (
self.session.query(self.Article)
.join(self.Article.category)
)
query = sort_query(query, 'name', silent=False)
assert_contains('ORDER BY article.name ASC', query)
def test_calculated_value_ascending(self):
query = self.session.query(
self.Category, sa.func.count(self.Article.id).label('articles')
)
query = sort_query(query, 'articles')
assert_contains('ORDER BY articles ASC', query)
def test_calculated_value_descending(self):
query = self.session.query(
self.Category, sa.func.count(self.Article.id).label('articles')
)
query = sort_query(query, '-articles')
assert_contains('ORDER BY articles DESC', query)
def test_subqueried_scalar(self):
article_count = (
sa.sql.select(
[sa.func.count(self.Article.id)],
from_obj=[self.Article.__table__]
)
.where(self.Article.category_id == self.Category.id)
.correlate(self.Category.__table__)
)
query = self.session.query(
self.Category, article_count.label('articles')
)
query = sort_query(query, '-articles')
assert_contains('ORDER BY articles DESC', query)
def test_aliased_joined_entity(self):
alias = sa.orm.aliased(self.Category, name='categories')
query = self.session.query(
self.Article
).join(
alias, self.Article.category
)
query = sort_query(query, '-categories-name')
assert_contains('ORDER BY categories.name DESC', query)
def test_joined_table_column(self):
query = self.session.query(self.Article).join(self.Article.category)
query = sort_query(query, 'category-name')
assert_contains('category.name ASC', query)
def test_multiple_columns(self):
query = self.session.query(self.Article)
query = sort_query(query, 'name', 'id')
assert_contains('article.name ASC, article.id ASC', query)
def test_column_property(self):
self.Category.article_count = sa.orm.column_property(
sa.select([sa.func.count(self.Article.id)])
.where(self.Article.category_id == self.Category.id)
.label('article_count')
)
query = self.session.query(self.Category)
query = sort_query(query, 'article_count')
assert_contains('article_count ASC', query)
def test_column_property_descending(self):
self.Category.article_count = sa.orm.column_property(
sa.select([sa.func.count(self.Article.id)])
.where(self.Article.category_id == self.Category.id)
.label('article_count')
)
query = self.session.query(self.Category)
query = sort_query(query, '-article_count')
assert_contains('article_count DESC', query)
def test_relationship_property(self):
query = self.session.query(self.Category)
query = sort_query(query, 'articles')
assert 'ORDER BY' not in str(query)
def test_regular_property(self):
query = self.session.query(self.Category)
query = sort_query(query, 'name_alias')
assert 'ORDER BY' not in str(query)
def test_synonym_property(self):
query = self.session.query(self.Category)
query = sort_query(query, 'name_synonym')
assert_contains('ORDER BY category.name ASC', query)
def test_hybrid_property(self):
query = self.session.query(self.Category)
query = sort_query(query, 'articles_count')
assert_contains('ORDER BY (SELECT count(article.id) AS count_1', query)
def test_hybrid_property_descending(self):
query = self.session.query(self.Category)
query = sort_query(query, '-articles_count')
assert_contains(
'ORDER BY (SELECT count(article.id) AS count_1',
query
)
assert ' DESC' in str(query)
def test_assigned_hybrid_property(self):
def getter(self):
return self.name
self.Article.some_hybrid = sa.ext.hybrid.hybrid_property(
fget=getter
)
query = self.session.query(self.Article)
query = sort_query(query, 'some_hybrid')
assert_contains('ORDER BY article.name ASC', query)
def test_with_mapper_and_column_property(self):
class Apple(self.Base):
__tablename__ = 'apple'
id = sa.Column(sa.Integer, primary_key=True)
article_id = sa.Column(sa.Integer, sa.ForeignKey(self.Article.id))
self.Article.apples = sa.orm.relationship(Apple)
self.Article.apple_count = sa.orm.column_property(
sa.select([sa.func.count(Apple.id)])
.where(Apple.article_id == self.Article.id)
.correlate(self.Article.__table__)
.label('apple_count'),
deferred=True
)
query = (
self.session.query(sa.inspect(self.Article))
.outerjoin(self.Article.apples)
.options(
sa.orm.undefer(self.Article.apple_count)
)
.options(sa.orm.contains_eager(self.Article.apples))
)
query = sort_query(query, 'apple_count')
assert 'ORDER BY apple_count' in str(query)
def test_table(self):
query = self.session.query(self.Article.__table__)
query = sort_query(query, 'name')
assert_contains('ORDER BY article.name', query)
class TestSortQueryRelationshipCounts(TestCase):
"""
Currently this doesn't work with SQLite
"""
dns = 'postgres://postgres@localhost/sqlalchemy_utils_test'
def test_relation_hybrid_property(self):
query = (
self.session.query(self.Article)
.join(self.Article.category)
).group_by(self.Article.id)
query = sort_query(query, '-category-articles_count')
assert_contains('ORDER BY (SELECT count(article.id) AS count_1', query)
def test_aliased_hybrid_property(self):
alias = sa.orm.aliased(
self.Category,
name='categories'
)
query = (
self.session.query(self.Article)
.outerjoin(alias, self.Article.category)
.options(
sa.orm.contains_eager(self.Article.category, alias=alias)
)
).group_by(alias.id, self.Article.id)
query = sort_query(query, '-categories-articles_count')
assert_contains('ORDER BY (SELECT count(article.id) AS count_1', query)
class TestSortQueryWithPolymorphicInheritance(TestCase):
"""
Currently this doesn't work with SQLite
"""
dns = 'postgres://postgres@localhost/sqlalchemy_utils_test'
def create_models(self):
class TextItem(self.Base):
__tablename__ = 'text_item'
id = sa.Column(sa.Integer, primary_key=True)
type = sa.Column(sa.Unicode(255))
__mapper_args__ = {
'polymorphic_on': type,
'with_polymorphic': '*'
}
class Article(TextItem):
__tablename__ = 'article'
id = sa.Column(
sa.Integer, sa.ForeignKey(TextItem.id), primary_key=True
)
category = sa.Column(sa.Unicode(255))
__mapper_args__ = {
'polymorphic_identity': u'article'
}
self.TextItem = TextItem
self.Article = Article
def test_column_property(self):
self.TextItem.item_count = sa.orm.column_property(
sa.select(
[
sa.func.count('1')
],
)
.select_from(self.TextItem.__table__)
.label('item_count')
)
query = sort_query(
self.session.query(self.TextItem),
'item_count'
)
assert_contains('ORDER BY item_count', query)
def test_child_class_attribute(self):
query = sort_query(
self.session.query(self.TextItem),
'category'
)
assert_contains('ORDER BY article.category ASC', query)
def test_with_ambiguous_column(self):
query = sort_query(
self.session.query(self.TextItem),
'id'
)
assert_contains('ORDER BY text_item.id ASC', query)
class TestSortQueryWithCustomPolymorphic(TestCase):
"""
Currently this doesn't work with SQLite
"""
dns = 'postgres://postgres@localhost/sqlalchemy_utils_test'
def create_models(self):
class TextItem(self.Base):
__tablename__ = 'text_item'
id = sa.Column(sa.Integer, primary_key=True)
type = sa.Column(sa.Unicode(255))
__mapper_args__ = {
'polymorphic_on': type,
}
class Article(TextItem):
__tablename__ = 'article'
id = sa.Column(
sa.Integer, sa.ForeignKey(TextItem.id), primary_key=True
)
category = sa.Column(sa.Unicode(255))
__mapper_args__ = {
'polymorphic_identity': u'article'
}
class BlogPost(TextItem):
__tablename__ = 'blog_post'
id = sa.Column(
sa.Integer, sa.ForeignKey(TextItem.id), primary_key=True
)
__mapper_args__ = {
'polymorphic_identity': u'blog_post'
}
self.TextItem = TextItem
self.Article = Article
self.BlogPost = BlogPost
def test_with_unknown_column(self):
query = sort_query(
self.session.query(
sa.orm.with_polymorphic(self.TextItem, [self.BlogPost])
),
'category'
)
assert 'ORDER BY' not in str(query)
def test_with_existing_column(self):
query = sort_query(
self.session.query(
sa.orm.with_polymorphic(self.TextItem, [self.Article])
),
'category'
)
assert 'ORDER BY' in str(query)
|
