Skip to content

where

Where clauses for filtering queries.

Between

Bases: WhereClause

Checks if a column value is between two values (inclusive).

Source code in src/embar/query/where.py 
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
class Between[T: PyType](WhereClause):
    """
    Checks if a column value is between two values (inclusive).
    """

    column: ColumnInfo
    lower: PyType
    upper: PyType

    def __init__(self, column: Column[T], lower: T, upper: T):
        self.column = column.info
        self.lower = lower
        self.upper = upper

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        lower_name = f"between_lower_{self.column.name}_{count}"
        upper_name = f"between_upper_{self.column.name}_{count}"
        return QuerySingle(
            sql=f"{self.column.fqn()} BETWEEN %({lower_name})s AND %({upper_name})s",
            params={lower_name: self.lower, upper_name: self.upper},
        )

Eq

Bases: WhereClause

Checks if a column value is equal to another column or a passed param.

Right now the left must always be a column, maybe that must be loosened.

Source code in src/embar/query/where.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class Eq[T: PyType](WhereClause):
    """
    Checks if a column value is equal to another column or a passed param.

    Right now the left must always be a column, maybe that must be loosened.
    """

    left: ColumnInfo
    right: PyType | ColumnInfo

    def __init__(self, left: Column[T], right: T | Column[T]):
        self.left = left.info
        self.right = right.info if isinstance(right, Column) else right

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"eq_{self.left.name}_{count}"

        if isinstance(self.right, ColumnInfo):
            return QuerySingle(sql=f"{self.left.fqn()} = {self.right.fqn()}")

        return QuerySingle(sql=f"{self.left.fqn()} = %({name})s", params={name: self.right})

Exists

Bases: WhereClause

Check if a subquery result exists.

Source code in src/embar/query/where.py 
365
366
367
368
369
370
371
372
373
374
375
376
377
378
class Exists(WhereClause):
    """
    Check if a subquery result exists.
    """

    query: SqlAble

    def __init__(self, query: SqlAble):
        self.query = query

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        query = self.query.sql()
        return QuerySingle(f"EXISTS ({query.sql})", query.params)

Gt

Bases: WhereClause

Checks if a column value is greater than another column or a passed param.

Source code in src/embar/query/where.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
class Gt[T: PyType](WhereClause):
    """
    Checks if a column value is greater than another column or a passed param.
    """

    left: ColumnInfo
    right: PyType | ColumnInfo

    def __init__(self, left: Column[T], right: T | Column[T]):
        self.left = left.info
        self.right = right.info if isinstance(right, Column) else right

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"gt_{self.left.name}_{count}"

        if isinstance(self.right, ColumnInfo):
            return QuerySingle(sql=f"{self.left.fqn()} > {self.right.fqn()}")

        return QuerySingle(sql=f"{self.left.fqn()} > %({name})s", params={name: self.right})

Gte

Bases: WhereClause

Checks if a column value is greater than or equal to another column or a passed param.

Source code in src/embar/query/where.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
class Gte[T: PyType](WhereClause):
    """
    Checks if a column value is greater than or equal to another column or a passed param.
    """

    left: ColumnInfo
    right: PyType | ColumnInfo

    def __init__(self, left: Column[T], right: T | Column[T]):
        self.left = left.info
        self.right = right.info if isinstance(right, Column) else right

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"gte_{self.left.name}_{count}"

        if isinstance(self.right, ColumnInfo):
            return QuerySingle(sql=f"{self.left.fqn()} >= {self.right.fqn()}")

        return QuerySingle(sql=f"{self.left.fqn()} >= %({name})s", params={name: self.right})

Ilike

Bases: WhereClause

Case-insensitive LIKE pattern matching.

Source code in src/embar/query/where.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
class Ilike[T: PyType](WhereClause):
    """
    Case-insensitive LIKE pattern matching.
    """

    left: ColumnInfo
    right: PyType | ColumnInfo

    def __init__(self, left: Column[T], right: T | Column[T]):
        self.left = left.info
        self.right = right.info if isinstance(right, Column) else right

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"ilike_{self.left.name}_{count}"
        if isinstance(self.right, ColumnInfo):
            return QuerySingle(sql=f"{self.left.fqn()} ILIKE {self.right.fqn()}")

        return QuerySingle(sql=f"{self.left.fqn()} ILIKE %({name})s", params={name: self.right})

InArray

Bases: WhereClause

Checks if a column value is in a list of values.

Source code in src/embar/query/where.py 
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
class InArray[T: PyType](WhereClause):
    """
    Checks if a column value is in a list of values.
    """

    column: ColumnInfo
    values: list[PyType]

    def __init__(self, column: Column[T], values: list[T]):
        self.column = column.info
        self.values = values

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"in_{self.column.name}_{count}"
        return QuerySingle(sql=f"{self.column.fqn()} = ANY(%({name})s)", params={name: self.values})

IsNotNull

Bases: WhereClause

Checks if a column value is NOT NULL.

Source code in src/embar/query/where.py 
253
254
255
256
257
258
259
260
261
262
263
264
265
class IsNotNull(WhereClause):
    """
    Checks if a column value is NOT NULL.
    """

    column: ColumnInfo

    def __init__(self, column: Column[Any]):
        self.column = column.info

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        return QuerySingle(sql=f"{self.column.fqn()} IS NOT NULL")

IsNull

Bases: WhereClause

Checks if a column value is NULL.

Source code in src/embar/query/where.py 
238
239
240
241
242
243
244
245
246
247
248
249
250
class IsNull(WhereClause):
    """
    Checks if a column value is NULL.
    """

    column: ColumnInfo

    def __init__(self, column: Column[Any]):
        self.column = column.info

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        return QuerySingle(sql=f"{self.column.fqn()} IS NULL")

Lt

Bases: WhereClause

Checks if a column value is less than another column or a passed param.

Source code in src/embar/query/where.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
class Lt[T: PyType](WhereClause):
    """
    Checks if a column value is less than another column or a passed param.
    """

    left: ColumnInfo
    right: PyType | ColumnInfo

    def __init__(self, left: Column[T], right: T | Column[T]):
        self.left = left.info
        self.right = right.info if isinstance(right, Column) else right

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"lt_{self.left.name}_{count}"

        if isinstance(self.right, ColumnInfo):
            return QuerySingle(sql=f"{self.left.fqn()} < {self.right.fqn()}")

        return QuerySingle(sql=f"{self.left.fqn()} < %({name})s", params={name: self.right})

Lte

Bases: WhereClause

Checks if a column value is less than or equal to another column or a passed param.

Source code in src/embar/query/where.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
class Lte[T: PyType](WhereClause):
    """
    Checks if a column value is less than or equal to another column or a passed param.
    """

    left: ColumnInfo
    right: PyType | ColumnInfo

    def __init__(self, left: Column[T], right: T | Column[T]):
        self.left = left.info
        self.right = right.info if isinstance(right, Column) else right

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"lte_{self.left.name}_{count}"

        if isinstance(self.right, ColumnInfo):
            return QuerySingle(sql=f"{self.left.fqn()} <= {self.right.fqn()}")

        return QuerySingle(sql=f"{self.left.fqn()} <= %({name})s", params={name: self.right})

Ne

Bases: WhereClause

Checks if a column value is not equal to another column or a passed param.

Source code in src/embar/query/where.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
class Ne[T: PyType](WhereClause):
    """
    Checks if a column value is not equal to another column or a passed param.
    """

    left: ColumnInfo
    right: PyType | ColumnInfo

    def __init__(self, left: Column[T], right: T | Column[T]):
        self.left = left.info
        self.right = right.info if isinstance(right, Column) else right

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"ne_{self.left.name}_{count}"

        if isinstance(self.right, ColumnInfo):
            return QuerySingle(sql=f"{self.left.fqn()} != {self.right.fqn()}")

        return QuerySingle(sql=f"{self.left.fqn()} != %({name})s", params={name: self.right})

Not

Bases: WhereClause

Negates a where clause.

Source code in src/embar/query/where.py 
398
399
400
401
402
403
404
405
406
407
408
409
410
411
class Not(WhereClause):
    """
    Negates a where clause.
    """

    clause: WhereClause

    def __init__(self, clause: WhereClause):
        self.clause = clause

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        inner = self.clause.sql(get_count)
        return QuerySingle(sql=f"NOT ({inner.sql})", params=inner.params)

NotBetween

Bases: WhereClause

Checks if a column value is not between two values (inclusive).

Source code in src/embar/query/where.py 
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
class NotBetween[T: PyType](WhereClause):
    """
    Checks if a column value is not between two values (inclusive).
    """

    column: ColumnInfo
    lower: PyType
    upper: PyType

    def __init__(self, column: Column[T], lower: T, upper: T):
        self.column = column.info
        self.lower = lower
        self.upper = upper

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        lower_name = f"notbetween_lower_{self.column.name}_{count}"
        upper_name = f"notbetween_upper_{self.column.name}_{count}"
        return QuerySingle(
            sql=f"{self.column.fqn()} NOT BETWEEN %({lower_name})s AND %({upper_name})s",
            params={lower_name: self.lower, upper_name: self.upper},
        )

NotExists

Bases: WhereClause

Check if a subquery result does not exist.

Source code in src/embar/query/where.py 
381
382
383
384
385
386
387
388
389
390
391
392
393
394
class NotExists(WhereClause):
    """
    Check if a subquery result does not exist.
    """

    query: SqlAble

    def __init__(self, query: SqlAble):
        self.query = query

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        query = self.query.sql()
        return QuerySingle(f"NOT EXISTS ({query.sql})", query.params)

NotInArray

Bases: WhereClause

Checks if a column value is not in a list of values.

Source code in src/embar/query/where.py 
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
class NotInArray[T: PyType](WhereClause):
    """
    Checks if a column value is not in a list of values.
    """

    column: ColumnInfo
    values: list[PyType]

    def __init__(self, column: Column[T], values: list[T]):
        self.column = column.info
        self.values = values

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"notin_{self.column.name}_{count}"
        return QuerySingle(sql=f"{self.column.fqn()} != ALL(%({name})s)", params={name: self.values})

NotLike

Bases: WhereClause

Negated LIKE pattern matching.

Source code in src/embar/query/where.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
class NotLike[T: PyType](WhereClause):
    """
    Negated LIKE pattern matching.
    """

    left: ColumnInfo
    right: PyType | ColumnInfo

    def __init__(self, left: Column[T], right: T | Column[T]):
        self.left = left.info
        self.right = right.info if isinstance(right, Column) else right

    @override
    def sql(self, get_count: GetCount) -> QuerySingle:
        count = get_count()
        name = f"notlike_{self.left.name}_{count}"
        if isinstance(self.right, ColumnInfo):
            return QuerySingle(sql=f"{self.left.fqn()} NOT LIKE {self.right.fqn()}")

        return QuerySingle(sql=f"{self.left.fqn()} NOT LIKE %({name})s", params={name: self.right})

WhereClause

Bases: ABC

ABC for Where clauses.

Not all use the get_count() directly (those with no bindings) but their children might.

Source code in src/embar/query/where.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class WhereClause(ABC):
    """
    ABC for Where clauses.

    Not all use the get_count() directly (those with no bindings)
    but their children might.
    """

    @abstractmethod
    def sql(self, get_count: GetCount) -> QuerySingle:
        """
        Generate the SQL for this where clause.
        """
        ...

sql(get_count) abstractmethod

Generate the SQL for this where clause.

Source code in src/embar/query/where.py 
25
26
27
28
29
30
@abstractmethod
def sql(self, get_count: GetCount) -> QuerySingle:
    """
    Generate the SQL for this where clause.
    """
    ...