/
QueryingFeature.scala
344 lines (307 loc) · 11.6 KB
/
QueryingFeature.scala
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
package skinny.orm.feature
import scalikejdbc._
import skinny.Pagination
import skinny.orm.SkinnyMapperBase
import skinny.orm.feature.includes.IncludesQueryRepository
/**
* Querying APIs feature.
*/
trait QueryingFeature[Entity]
extends QueryingFeatureWithId[Long, Entity] {
override def rawValueToId(value: Any) = value.toString.toLong
override def idToRawValue(id: Long) = id
}
trait QueryingFeatureWithId[Id, Entity]
extends SkinnyMapperBase[Entity]
with ConnectionPoolFeature
with AutoSessionFeature
with AssociationsFeature[Entity]
with IncludesFeatureWithId[Id, Entity] {
/**
* Appends where conditions.
*
* @param conditions
* @return query builder
*/
def where(conditions: (Symbol, Any)*): EntitiesSelectOperationBuilder = new EntitiesSelectOperationBuilder(
mapper = this,
conditions = conditions.flatMap {
case (key, value) =>
implicit val enableAsIs = ParameterBinderFactory.asisParameterBinderFactory
value match {
case None => Some(sqls.isNull(defaultAlias.field(key.name)))
case Nil => Some(sqls" FALSE") // for scalikejdbc 2.0.0 - 2.0.6 compatibility
case values: Seq[_] => Some(sqls.in(defaultAlias.field(key.name), values.asInstanceOf[Seq[Any]]))
case value => Some(sqls.eq(defaultAlias.field(key.name), value))
}
}
)
/**
* Appends a raw where condition.
*
* @param condition
* @return query builder
*/
def where(condition: SQLSyntax): EntitiesSelectOperationBuilder = new EntitiesSelectOperationBuilder(
mapper = this, conditions = Seq(condition)
)
/**
* Appends pagination settings as limit/offset.
*
* @param pagination pagination
* @return query builder
*/
def paginate(pagination: Pagination): EntitiesSelectOperationBuilder = {
new EntitiesSelectOperationBuilder(
mapper = this, limit = Some(pagination.limit), offset = Some(pagination.offset)
)
}
/**
* Appends limit part.
*
* @param n value
* @return query builder
*/
def limit(n: Int): EntitiesSelectOperationBuilder = new EntitiesSelectOperationBuilder(mapper = this, limit = Some(n))
/**
* Appends offset part.
*
* @param n value
* @return query builder
*/
def offset(n: Int): EntitiesSelectOperationBuilder = new EntitiesSelectOperationBuilder(mapper = this, offset = Some(n))
/**
* Select query builder.
*
* @param mapper mapper
* @param conditions registered conditions
* @param limit limit
* @param offset offset
*/
abstract class SelectOperationBuilder(
mapper: QueryingFeatureWithId[Id, Entity],
conditions: Seq[SQLSyntax] = Nil,
orderings: Seq[SQLSyntax] = Nil,
limit: Option[Int] = None,
offset: Option[Int] = None,
isCountOnly: Boolean = false
) {
/**
* Appends where conditions.
*
* @param additionalConditions conditions
* @return query builder
*/
def where(additionalConditions: (Symbol, Any)*): EntitiesSelectOperationBuilder = new EntitiesSelectOperationBuilder(
mapper = this.mapper,
conditions = conditions ++ additionalConditions.flatMap {
case (key, value) =>
implicit val enableAsIs = ParameterBinderFactory.asisParameterBinderFactory
value match {
case Nil => None
case values: Seq[_] => Some(sqls.in(defaultAlias.field(key.name), values.asInstanceOf[Seq[Any]]))
case value => Some(sqls.eq(defaultAlias.field(key.name), value))
}
},
orderings = orderings,
limit = limit,
offset = offset
)
/**
* Appends a raw where condition.
*
* @param condition
* @return query builder
*/
def where(condition: SQLSyntax): EntitiesSelectOperationBuilder = new EntitiesSelectOperationBuilder(
mapper = this.mapper,
conditions = conditions ++ Seq(condition),
limit = limit,
offset = offset
)
}
/**
* Entities finder builder.
*
* @param mapper mapper
* @param conditions registered conditions
* @param limit limit
* @param offset offset
*/
case class EntitiesSelectOperationBuilder(
mapper: QueryingFeatureWithId[Id, Entity],
conditions: Seq[SQLSyntax] = Nil,
orderings: Seq[SQLSyntax] = Nil,
limit: Option[Int] = None,
offset: Option[Int] = None
) extends SelectOperationBuilder(mapper, conditions, orderings, limit, offset, false) {
/**
* Appends pagination settings as limit/offset.
*
* @param pagination pagination
* @return query builder
*/
def paginate(pagination: Pagination): EntitiesSelectOperationBuilder = {
this.copy(limit = Some(pagination.limit), offset = Some(pagination.offset))
}
/**
* Appends limit part.
*
* @param n value
* @return query builder
*/
def limit(n: Int): EntitiesSelectOperationBuilder = this.copy(limit = Some(n))
/**
* Appends offset part.
*
* @param n value
* @return query builder
*/
def offset(n: Int): EntitiesSelectOperationBuilder = this.copy(offset = Some(n))
/**
* Appends order by condition.
*
* @param orderings orderings
* @return query builder
*/
def orderBy(orderings: SQLSyntax*): EntitiesSelectOperationBuilder = this.copy(orderings = orderings)
/**
* Calculates rows.
*/
def calculate(sql: SQLSyntax)(implicit s: DBSession = autoSession): BigDecimal = {
withSQL {
val q: SelectSQLBuilder[Entity] = select(sql).from(as(defaultAlias))
conditions match {
case Nil => q.where(defaultScopeWithDefaultAlias)
case _ => conditions.tail.foldLeft(q.where(conditions.head)) {
case (query, condition) => query.and.append(condition)
}.and(defaultScopeWithDefaultAlias)
}
}.map(_.bigDecimal(1)).single.apply().map(_.toScalaBigDecimal).getOrElse(BigDecimal(0))
}
/**
* Count only.
*/
def count(fieldName: Symbol = Symbol(primaryKeyFieldName), distinct: Boolean = false)(implicit s: DBSession = autoSession): Long = {
calculate {
if (distinct) sqls.count(sqls.distinct(defaultAlias.field(fieldName.name)))
else sqls.count(defaultAlias.field(fieldName.name))
}.toLong
}
/**
* Counts distinct rows.
*/
def distinctCount(fieldName: Symbol = Symbol(primaryKeyFieldName))(implicit s: DBSession = autoSession): Long = count(fieldName, true)
/**
* Calculates sum of a column.
*/
def sum(fieldName: Symbol)(implicit s: DBSession = autoSession): BigDecimal = calculate(sqls.sum(defaultAlias.field(fieldName.name)))
/**
* Calculates average of a column.
*/
def average(fieldName: Symbol, decimals: Option[Int] = None)(implicit s: DBSession = autoSession): BigDecimal = {
calculate(decimals match {
case Some(dcml) =>
val decimalsValue = dcml match {
case 1 => sqls"1"
case 2 => sqls"2"
case 3 => sqls"3"
case 4 => sqls"4"
case 5 => sqls"5"
case 6 => sqls"6"
case 7 => sqls"7"
case 8 => sqls"8"
case 9 => sqls"9"
case _ => sqls"10"
}
sqls"round(${sqls.avg(defaultAlias.field(fieldName.name))}, ${decimalsValue})"
case _ =>
sqls.avg(defaultAlias.field(fieldName.name))
})
}
def avg(fieldName: Symbol, decimals: Option[Int] = None)(implicit s: DBSession = autoSession): BigDecimal = average(fieldName, decimals)
/**
* Calculates minimum value of a column.
*/
def minimum(fieldName: Symbol)(implicit s: DBSession = autoSession): BigDecimal = calculate(sqls.min(defaultAlias.field(fieldName.name)))
def min(fieldName: Symbol)(implicit s: DBSession = autoSession): BigDecimal = minimum(fieldName)
/**
* Calculates minimum value of a column.
*/
def maximum(fieldName: Symbol)(implicit s: DBSession = autoSession): BigDecimal = calculate(sqls.max(defaultAlias.field(fieldName.name)))
def max(fieldName: Symbol)(implicit s: DBSession = autoSession): BigDecimal = maximum(fieldName)
/**
* Actually applies SQL to the DB.
*
* @param session db session
* @return query results
*/
def apply()(implicit session: DBSession = autoSession): List[Entity] = {
implicit val repository = IncludesQueryRepository[Entity]()
appendIncludedAttributes(extract(withSQL {
def query(conditions: Seq[SQLSyntax]): SQLBuilder[Entity] = {
conditions match {
case Nil => selectQueryWithAssociations.where(defaultScopeWithDefaultAlias)
case _ => conditions.tail.foldLeft(selectQueryWithAssociations.where(conditions.head)) {
case (query, condition) => query.and.append(condition)
}.and(defaultScopeWithDefaultAlias)
}
}
def appendOrderingIfExists(query: SQLBuilder[Entity]): SQLBuilder[Entity] = {
if (orderings.isEmpty) query
else query.append(sqls"order by").append(sqls.csv(orderings: _*))
}
val pagination = {
sqls.join(Seq(limit.map(l => sqls.limit(l)), offset.map(o => sqls.offset(o))).flatten, sqls" ")
}
if (hasManyAssociations.size > 0 && (limit.isDefined || offset.isDefined)) {
// find ids for pagination
val ids: Seq[Any] = withSQL {
lazy val allowedForDistinctQuery: Seq[SQLSyntax] = {
columns.map(column => SQLSyntax.createUnsafely(s"${defaultAlias.tableAliasName}.${column}", Nil))
}
val baseQuery = {
val columnsToFetch: Seq[SQLSyntax] = Seq(sqls"distinct ${defaultAlias.field(primaryKeyFieldName)}") ++ {
// in this case, intentionally orderings are empty
if (orderings.isEmpty) Nil
else orderingsForDistinctQuery(orderings, allowedForDistinctQuery).map(removeAscDesc)
}
selectQueryWithAdditionalAssociations(
select(columnsToFetch: _*).from(as(defaultAlias)),
belongsToAssociations ++ includedBelongsToAssociations,
hasOneAssociations ++ includedHasOneAssociations,
hasManyAssociations ++ includedHasManyAssociations.toSet
)
}
val query = (conditions match {
case Nil => baseQuery.where(defaultScopeWithDefaultAlias)
case _ => conditions.tail.foldLeft(baseQuery.where(conditions.head)) {
case (query, condition) => query.and.append(condition)
}.and(defaultScopeWithDefaultAlias)
})
if (orderings.isEmpty) query.append(pagination)
else query.orderBy(sqls.csv(orderingsForDistinctQuery(orderings, allowedForDistinctQuery): _*)).append(pagination)
}.map(_.any(1)).list.apply()
if (ids.isEmpty) return Nil
else {
implicit val enableAsIs = ParameterBinderFactory.asisParameterBinderFactory
appendOrderingIfExists(query(conditions :+ sqls.in(defaultAlias.field(primaryKeyFieldName), ids)))
}
} else {
appendOrderingIfExists(query(conditions)).append(pagination)
}
}).list.apply())
}
}
private[this] def removeAscDesc(s: SQLSyntax): SQLSyntax = {
SQLSyntax.createUnsafely(
s.value
.replaceFirst(" desc$", "").replaceFirst(" asc$", "")
.replaceFirst(" DESC$", "").replaceFirst(" ASC$", ""),
s.parameters
)
}
private[this] def orderingsForDistinctQuery(orderings: Seq[SQLSyntax], allowedForDistinctQuery: Seq[SQLSyntax]): Seq[SQLSyntax] = {
orderings.filter { o => allowedForDistinctQuery.exists(_.value == removeAscDesc(o).value) }
}
}