-
Notifications
You must be signed in to change notification settings - Fork 290
/
queries.py
2109 lines (1632 loc) · 70.7 KB
/
queries.py
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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from copy import copy
from functools import reduce
from typing import Any, List, Optional, Sequence, Tuple as TypedTuple, Type, Union
from pypika.enums import Dialects, JoinType, ReferenceOption, SetOperation
from pypika.terms import (
ArithmeticExpression,
Criterion,
EmptyCriterion,
Field,
Function,
Index,
Node,
Rollup,
Star,
Term,
Tuple,
ValueWrapper,
Criterion,
PeriodCriterion,
)
from pypika.utils import (
JoinException,
QueryException,
RollupException,
SetOperationException,
builder,
format_alias_sql,
format_quotes,
ignore_copy,
)
__author__ = "Timothy Heys"
__email__ = "theys@kayak.com"
class Selectable(Node):
def __init__(self, alias: str) -> None:
self.alias = alias
@builder
def as_(self, alias: str) -> "Selectable":
self.alias = alias
def field(self, name: str) -> Field:
return Field(name, table=self)
@property
def star(self) -> Star:
return Star(self)
@ignore_copy
def __getattr__(self, name: str) -> Field:
return self.field(name)
@ignore_copy
def __getitem__(self, name: str) -> Field:
return self.field(name)
def get_table_name(self) -> str:
return self.alias
class AliasedQuery(Selectable):
def __init__(self, name: str, query: Optional[Selectable] = None) -> None:
super().__init__(alias=name)
self.name = name
self.query = query
def get_sql(self, **kwargs: Any) -> str:
if self.query is None:
return self.name
return self.query.get_sql(**kwargs)
def __eq__(self, other: "AliasedQuery") -> bool:
return isinstance(other, AliasedQuery) and self.name == other.name
def __hash__(self) -> int:
return hash(str(self.name))
class Schema:
def __init__(self, name: str, parent: Optional["Schema"] = None) -> None:
self._name = name
self._parent = parent
def __eq__(self, other: "Schema") -> bool:
return isinstance(other, Schema) and self._name == other._name and self._parent == other._parent
def __ne__(self, other: "Schema") -> bool:
return not self.__eq__(other)
@ignore_copy
def __getattr__(self, item: str) -> "Table":
return Table(item, schema=self)
def get_sql(self, quote_char: Optional[str] = None, **kwargs: Any) -> str:
# FIXME escape
schema_sql = format_quotes(self._name, quote_char)
if self._parent is not None:
return "{parent}.{schema}".format(
parent=self._parent.get_sql(quote_char=quote_char, **kwargs),
schema=schema_sql,
)
return schema_sql
class Database(Schema):
@ignore_copy
def __getattr__(self, item: str) -> Schema:
return Schema(item, parent=self)
class Table(Selectable):
@staticmethod
def _init_schema(schema: Union[str, list, tuple, Schema, None]) -> Union[str, list, tuple, Schema, None]:
# This is a bit complicated in order to support backwards compatibility. It should probably be cleaned up for
# the next major release. Schema is accepted as a string, list/tuple, Schema instance, or None
if isinstance(schema, Schema):
return schema
if isinstance(schema, (list, tuple)):
return reduce(lambda obj, s: Schema(s, parent=obj), schema[1:], Schema(schema[0]))
if schema is not None:
return Schema(schema)
return None
def __init__(
self,
name: str,
schema: Optional[Union[Schema, str]] = None,
alias: Optional[str] = None,
query_cls: Optional[Type["Query"]] = None,
) -> None:
super().__init__(alias)
self._table_name = name
self._schema = self._init_schema(schema)
self._query_cls = query_cls or Query
self._for = None
self._for_portion = None
if not issubclass(self._query_cls, Query):
raise TypeError("Expected 'query_cls' to be subclass of Query")
def get_table_name(self) -> str:
return self.alias or self._table_name
def get_sql(self, **kwargs: Any) -> str:
quote_char = kwargs.get("quote_char")
# FIXME escape
table_sql = format_quotes(self._table_name, quote_char)
if self._schema is not None:
table_sql = "{schema}.{table}".format(schema=self._schema.get_sql(**kwargs), table=table_sql)
if self._for:
table_sql = "{table} FOR {criterion}".format(table=table_sql, criterion=self._for.get_sql(**kwargs))
elif self._for_portion:
table_sql = "{table} FOR PORTION OF {criterion}".format(
table=table_sql, criterion=self._for_portion.get_sql(**kwargs)
)
return format_alias_sql(table_sql, self.alias, **kwargs)
@builder
def for_(self, temporal_criterion: Criterion) -> "Table":
if self._for:
raise AttributeError("'Query' object already has attribute for_")
if self._for_portion:
raise AttributeError("'Query' object already has attribute for_portion")
self._for = temporal_criterion
@builder
def for_portion(self, period_criterion: PeriodCriterion) -> "Table":
if self._for_portion:
raise AttributeError("'Query' object already has attribute for_portion")
if self._for:
raise AttributeError("'Query' object already has attribute for_")
self._for_portion = period_criterion
def __str__(self) -> str:
return self.get_sql(quote_char='"')
def __eq__(self, other) -> bool:
if not isinstance(other, Table):
return False
if self._table_name != other._table_name:
return False
if self._schema != other._schema:
return False
if self.alias != other.alias:
return False
return True
def __repr__(self) -> str:
if self._schema:
return "Table('{}', schema='{}')".format(self._table_name, self._schema)
return "Table('{}')".format(self._table_name)
def __ne__(self, other: Any) -> bool:
return not self.__eq__(other)
def __hash__(self) -> int:
return hash(str(self))
def select(self, *terms: Sequence[Union[int, float, str, bool, Term, Field]]) -> "QueryBuilder":
"""
Perform a SELECT operation on the current table
:param terms:
Type: list[expression]
A list of terms to select. These can be any type of int, float, str, bool or Term or a Field.
:return: QueryBuilder
"""
return self._query_cls.from_(self).select(*terms)
def update(self) -> "QueryBuilder":
"""
Perform an UPDATE operation on the current table
:return: QueryBuilder
"""
return self._query_cls.update(self)
def insert(self, *terms: Union[int, float, str, bool, Term, Field]) -> "QueryBuilder":
"""
Perform an INSERT operation on the current table
:param terms:
Type: list[expression]
A list of terms to select. These can be any type of int, float, str, bool or any other valid data
:return: QueryBuilder
"""
return self._query_cls.into(self).insert(*terms)
def make_tables(*names: Union[TypedTuple[str, str], str], **kwargs: Any) -> List[Table]:
"""
Shortcut to create many tables. If `names` param is a tuple, the first
position will refer to the `_table_name` while the second will be its `alias`.
Any other data structure will be treated as a whole as the `_table_name`.
"""
tables = []
for name in names:
if isinstance(name, tuple) and len(name) == 2:
t = Table(
name=name[0],
alias=name[1],
schema=kwargs.get("schema"),
query_cls=kwargs.get("query_cls"),
)
else:
t = Table(
name=name,
schema=kwargs.get("schema"),
query_cls=kwargs.get("query_cls"),
)
tables.append(t)
return tables
class Column:
"""Represents a column."""
def __init__(
self,
column_name: str,
column_type: Optional[str] = None,
nullable: Optional[bool] = None,
default: Optional[Union[Any, Term]] = None,
) -> None:
self.name = column_name
self.type = column_type
self.nullable = nullable
self.default = default if default is None or isinstance(default, Term) else ValueWrapper(default)
def get_name_sql(self, **kwargs: Any) -> str:
quote_char = kwargs.get("quote_char")
column_sql = "{name}".format(
name=format_quotes(self.name, quote_char),
)
return column_sql
def get_sql(self, **kwargs: Any) -> str:
column_sql = "{name}{type}{nullable}{default}".format(
name=self.get_name_sql(**kwargs),
type=" {}".format(self.type) if self.type else "",
nullable=" {}".format("NULL" if self.nullable else "NOT NULL") if self.nullable is not None else "",
default=" {}".format("DEFAULT " + self.default.get_sql(**kwargs)) if self.default else "",
)
return column_sql
def __str__(self) -> str:
return self.get_sql(quote_char='"')
def make_columns(*names: Union[TypedTuple[str, str], str]) -> List[Column]:
"""
Shortcut to create many columns. If `names` param is a tuple, the first
position will refer to the `name` while the second will be its `type`.
Any other data structure will be treated as a whole as the `name`.
"""
columns = []
for name in names:
if isinstance(name, tuple) and len(name) == 2:
column = Column(column_name=name[0], column_type=name[1])
else:
column = Column(column_name=name)
columns.append(column)
return columns
class PeriodFor:
def __init__(self, name: str, start_column: Union[str, Column], end_column: Union[str, Column]) -> None:
self.name = name
self.start_column = start_column if isinstance(start_column, Column) else Column(start_column)
self.end_column = end_column if isinstance(end_column, Column) else Column(end_column)
def get_sql(self, **kwargs: Any) -> str:
quote_char = kwargs.get("quote_char")
period_for_sql = "PERIOD FOR {name} ({start_column_name},{end_column_name})".format(
name=format_quotes(self.name, quote_char),
start_column_name=self.start_column.get_name_sql(**kwargs),
end_column_name=self.end_column.get_name_sql(**kwargs),
)
return period_for_sql
# for typing in Query's methods
_TableClass = Table
class Query:
"""
Query is the primary class and entry point in pypika. It is used to build queries iteratively using the builder
design
pattern.
This class is immutable.
"""
@classmethod
def _builder(cls, **kwargs: Any) -> "QueryBuilder":
return QueryBuilder(**kwargs)
@classmethod
def from_(cls, table: Union[Selectable, str], **kwargs: Any) -> "QueryBuilder":
"""
Query builder entry point. Initializes query building and sets the table to select from. When using this
function, the query becomes a SELECT query.
:param table:
Type: Table or str
An instance of a Table object or a string table name.
:returns QueryBuilder
"""
return cls._builder(**kwargs).from_(table)
@classmethod
def create_table(cls, table: Union[str, Table]) -> "CreateQueryBuilder":
"""
Query builder entry point. Initializes query building and sets the table name to be created. When using this
function, the query becomes a CREATE statement.
:param table: An instance of a Table object or a string table name.
:return: CreateQueryBuilder
"""
return CreateQueryBuilder().create_table(table)
@classmethod
def drop_database(cls, database: Union[Database, Table]) -> "DropQueryBuilder":
"""
Query builder entry point. Initializes query building and sets the table name to be dropped. When using this
function, the query becomes a DROP statement.
:param database: An instance of a Database object or a string database name.
:return: DropQueryBuilder
"""
return DropQueryBuilder().drop_database(database)
@classmethod
def drop_table(cls, table: Union[str, Table]) -> "DropQueryBuilder":
"""
Query builder entry point. Initializes query building and sets the table name to be dropped. When using this
function, the query becomes a DROP statement.
:param table: An instance of a Table object or a string table name.
:return: DropQueryBuilder
"""
return DropQueryBuilder().drop_table(table)
@classmethod
def drop_user(cls, user: str) -> "DropQueryBuilder":
"""
Query builder entry point. Initializes query building and sets the table name to be dropped. When using this
function, the query becomes a DROP statement.
:param user: String user name.
:return: DropQueryBuilder
"""
return DropQueryBuilder().drop_user(user)
@classmethod
def drop_view(cls, view: str) -> "DropQueryBuilder":
"""
Query builder entry point. Initializes query building and sets the table name to be dropped. When using this
function, the query becomes a DROP statement.
:param view: String view name.
:return: DropQueryBuilder
"""
return DropQueryBuilder().drop_view(view)
@classmethod
def into(cls, table: Union[Table, str], **kwargs: Any) -> "QueryBuilder":
"""
Query builder entry point. Initializes query building and sets the table to insert into. When using this
function, the query becomes an INSERT query.
:param table:
Type: Table or str
An instance of a Table object or a string table name.
:returns QueryBuilder
"""
return cls._builder(**kwargs).into(table)
@classmethod
def with_(cls, table: Union[str, Selectable], name: str, **kwargs: Any) -> "QueryBuilder":
return cls._builder(**kwargs).with_(table, name)
@classmethod
def select(cls, *terms: Union[int, float, str, bool, Term], **kwargs: Any) -> "QueryBuilder":
"""
Query builder entry point. Initializes query building without a table and selects fields. Useful when testing
SQL functions.
:param terms:
Type: list[expression]
A list of terms to select. These can be any type of int, float, str, bool, or Term. They cannot be a Field
unless the function ``Query.from_`` is called first.
:returns QueryBuilder
"""
return cls._builder(**kwargs).select(*terms)
@classmethod
def update(cls, table: Union[str, Table], **kwargs) -> "QueryBuilder":
"""
Query builder entry point. Initializes query building and sets the table to update. When using this
function, the query becomes an UPDATE query.
:param table:
Type: Table or str
An instance of a Table object or a string table name.
:returns QueryBuilder
"""
return cls._builder(**kwargs).update(table)
@classmethod
def Table(cls, table_name: str, **kwargs) -> _TableClass:
"""
Convenience method for creating a Table that uses this Query class.
:param table_name:
Type: str
A string table name.
:returns Table
"""
kwargs["query_cls"] = cls
return Table(table_name, **kwargs)
@classmethod
def Tables(cls, *names: Union[TypedTuple[str, str], str], **kwargs: Any) -> List[_TableClass]:
"""
Convenience method for creating many tables that uses this Query class.
See ``Query.make_tables`` for details.
:param names:
Type: list[str or tuple]
A list of string table names, or name and alias tuples.
:returns Table
"""
kwargs["query_cls"] = cls
return make_tables(*names, **kwargs)
class _SetOperation(Selectable, Term):
"""
A Query class wrapper for a all set operations, Union DISTINCT or ALL, Intersect, Except or Minus
Created via the functions `Query.union`,`Query.union_all`,`Query.intersect`, `Query.except_of`,`Query.minus`.
This class should not be instantiated directly.
"""
def __init__(
self,
base_query: "QueryBuilder",
set_operation_query: "QueryBuilder",
set_operation: SetOperation,
alias: Optional[str] = None,
wrapper_cls: Type[ValueWrapper] = ValueWrapper,
):
super().__init__(alias)
self.base_query = base_query
self._set_operation = [(set_operation, set_operation_query)]
self._orderbys = []
self._limit = None
self._offset = None
self._wrapper_cls = wrapper_cls
@builder
def orderby(self, *fields: Field, **kwargs: Any) -> "_SetOperation":
for field in fields:
field = (
Field(field, table=self.base_query._from[0])
if isinstance(field, str)
else self.base_query.wrap_constant(field)
)
self._orderbys.append((field, kwargs.get("order")))
@builder
def limit(self, limit: int) -> "_SetOperation":
self._limit = limit
@builder
def offset(self, offset: int) -> "_SetOperation":
self._offset = offset
@builder
def union(self, other: Selectable) -> "_SetOperation":
self._set_operation.append((SetOperation.union, other))
@builder
def union_all(self, other: Selectable) -> "_SetOperation":
self._set_operation.append((SetOperation.union_all, other))
@builder
def intersect(self, other: Selectable) -> "_SetOperation":
self._set_operation.append((SetOperation.intersect, other))
@builder
def except_of(self, other: Selectable) -> "_SetOperation":
self._set_operation.append((SetOperation.except_of, other))
@builder
def minus(self, other: Selectable) -> "_SetOperation":
self._set_operation.append((SetOperation.minus, other))
def __add__(self, other: Selectable) -> "_SetOperation":
return self.union(other)
def __mul__(self, other: Selectable) -> "_SetOperation":
return self.union_all(other)
def __sub__(self, other: "QueryBuilder") -> "_SetOperation":
return self.minus(other)
def __str__(self) -> str:
return self.get_sql()
def get_sql(self, with_alias: bool = False, subquery: bool = False, **kwargs: Any) -> str:
set_operation_template = " {type} {query_string}"
kwargs.setdefault("dialect", self.base_query.dialect)
# This initializes the quote char based on the base query, which could be a dialect specific query class
# This might be overridden if quote_char is set explicitly in kwargs
kwargs.setdefault("quote_char", self.base_query.QUOTE_CHAR)
base_querystring = self.base_query.get_sql(subquery=self.base_query.wrap_set_operation_queries, **kwargs)
querystring = base_querystring
for set_operation, set_operation_query in self._set_operation:
set_operation_querystring = set_operation_query.get_sql(
subquery=self.base_query.wrap_set_operation_queries, **kwargs
)
if len(self.base_query._selects) != len(set_operation_query._selects):
raise SetOperationException(
"Queries must have an equal number of select statements in a set operation."
"\n\nMain Query:\n{query1}\n\nSet Operations Query:\n{query2}".format(
query1=base_querystring, query2=set_operation_querystring
)
)
querystring += set_operation_template.format(
type=set_operation.value, query_string=set_operation_querystring
)
if self._orderbys:
querystring += self._orderby_sql(**kwargs)
if self._limit is not None:
querystring += self._limit_sql()
if self._offset:
querystring += self._offset_sql()
if subquery:
querystring = "({query})".format(query=querystring, **kwargs)
if with_alias:
return format_alias_sql(querystring, self.alias or self._table_name, **kwargs)
return querystring
def _orderby_sql(self, quote_char: Optional[str] = None, **kwargs: Any) -> str:
"""
Produces the ORDER BY part of the query. This is a list of fields and possibly their directionality, ASC or
DESC. The clauses are stored in the query under self._orderbys as a list of tuples containing the field and
directionality (which can be None).
If an order by field is used in the select clause, determined by a matching , then the ORDER BY clause will use
the alias, otherwise the field will be rendered as SQL.
"""
clauses = []
selected_aliases = {s.alias for s in self.base_query._selects}
for field, directionality in self._orderbys:
term = (
format_quotes(field.alias, quote_char)
if field.alias and field.alias in selected_aliases
else field.get_sql(quote_char=quote_char, **kwargs)
)
clauses.append(
"{term} {orient}".format(term=term, orient=directionality.value) if directionality is not None else term
)
return " ORDER BY {orderby}".format(orderby=",".join(clauses))
def _offset_sql(self) -> str:
return " OFFSET {offset}".format(offset=self._offset)
def _limit_sql(self) -> str:
return " LIMIT {limit}".format(limit=self._limit)
class QueryBuilder(Selectable, Term):
"""
Query Builder is the main class in pypika which stores the state of a query and offers functions which allow the
state to be branched immutably.
"""
QUOTE_CHAR = '"'
SECONDARY_QUOTE_CHAR = "'"
ALIAS_QUOTE_CHAR = None
QUERY_ALIAS_QUOTE_CHAR = None
QUERY_CLS = Query
def __init__(
self,
dialect: Optional[Dialects] = None,
wrap_set_operation_queries: bool = True,
wrapper_cls: Type[ValueWrapper] = ValueWrapper,
immutable: bool = True,
as_keyword: bool = False,
):
super().__init__(None)
self._from = []
self._insert_table = None
self._update_table = None
self._delete_from = False
self._replace = False
self._with = []
self._selects = []
self._force_indexes = []
self._use_indexes = []
self._columns = []
self._values = []
self._distinct = False
self._ignore = False
self._for_update = False
self._wheres = None
self._prewheres = None
self._groupbys = []
self._with_totals = False
self._havings = None
self._orderbys = []
self._joins = []
self._unions = []
self._using = []
self._limit = None
self._offset = None
self._updates = []
self._select_star = False
self._select_star_tables = set()
self._mysql_rollup = False
self._select_into = False
self._subquery_count = 0
self._foreign_table = False
self.dialect = dialect
self.as_keyword = as_keyword
self.wrap_set_operation_queries = wrap_set_operation_queries
self._wrapper_cls = wrapper_cls
self.immutable = immutable
def __copy__(self) -> "QueryBuilder":
newone = type(self).__new__(type(self))
newone.__dict__.update(self.__dict__)
newone._select_star_tables = copy(self._select_star_tables)
newone._from = copy(self._from)
newone._with = copy(self._with)
newone._selects = copy(self._selects)
newone._columns = copy(self._columns)
newone._values = copy(self._values)
newone._groupbys = copy(self._groupbys)
newone._orderbys = copy(self._orderbys)
newone._joins = copy(self._joins)
newone._unions = copy(self._unions)
newone._updates = copy(self._updates)
return newone
@builder
def from_(self, selectable: Union[Selectable, Query, str]) -> "QueryBuilder":
"""
Adds a table to the query. This function can only be called once and will raise an AttributeError if called a
second time.
:param selectable:
Type: ``Table``, ``Query``, or ``str``
When a ``str`` is passed, a table with the name matching the ``str`` value is used.
:returns
A copy of the query with the table added.
"""
self._from.append(Table(selectable) if isinstance(selectable, str) else selectable)
if isinstance(selectable, (QueryBuilder, _SetOperation)) and selectable.alias is None:
if isinstance(selectable, QueryBuilder):
sub_query_count = selectable._subquery_count
else:
sub_query_count = 0
sub_query_count = max(self._subquery_count, sub_query_count)
selectable.alias = "sq%d" % sub_query_count
self._subquery_count = sub_query_count + 1
@builder
def replace_table(self, current_table: Optional[Table], new_table: Optional[Table]) -> "QueryBuilder":
"""
Replaces all occurrences of the specified table with the new table. Useful when reusing fields across
queries.
:param current_table:
The table instance to be replaces.
:param new_table:
The table instance to replace with.
:return:
A copy of the query with the tables replaced.
"""
self._from = [new_table if table == current_table else table for table in self._from]
self._insert_table = new_table if self._insert_table == current_table else self._insert_table
self._update_table = new_table if self._update_table == current_table else self._update_table
self._with = [alias_query.replace_table(current_table, new_table) for alias_query in self._with]
self._selects = [select.replace_table(current_table, new_table) for select in self._selects]
self._columns = [column.replace_table(current_table, new_table) for column in self._columns]
self._values = [
[value.replace_table(current_table, new_table) for value in value_list] for value_list in self._values
]
self._wheres = self._wheres.replace_table(current_table, new_table) if self._wheres else None
self._prewheres = self._prewheres.replace_table(current_table, new_table) if self._prewheres else None
self._groupbys = [groupby.replace_table(current_table, new_table) for groupby in self._groupbys]
self._havings = self._havings.replace_table(current_table, new_table) if self._havings else None
self._orderbys = [
(orderby[0].replace_table(current_table, new_table), orderby[1]) for orderby in self._orderbys
]
self._joins = [join.replace_table(current_table, new_table) for join in self._joins]
if current_table in self._select_star_tables:
self._select_star_tables.remove(current_table)
self._select_star_tables.add(new_table)
@builder
def with_(self, selectable: Selectable, name: str) -> "QueryBuilder":
t = AliasedQuery(name, selectable)
self._with.append(t)
@builder
def into(self, table: Union[str, Table]) -> "QueryBuilder":
if self._insert_table is not None:
raise AttributeError("'Query' object has no attribute '%s'" % "into")
if self._selects:
self._select_into = True
self._insert_table = table if isinstance(table, Table) else Table(table)
@builder
def select(self, *terms: Any) -> "QueryBuilder":
for term in terms:
if isinstance(term, Field):
self._select_field(term)
elif isinstance(term, str):
self._select_field_str(term)
elif isinstance(term, (Function, ArithmeticExpression)):
self._select_other(term)
else:
self._select_other(self.wrap_constant(term, wrapper_cls=self._wrapper_cls))
@builder
def delete(self) -> "QueryBuilder":
if self._delete_from or self._selects or self._update_table:
raise AttributeError("'Query' object has no attribute '%s'" % "delete")
self._delete_from = True
@builder
def update(self, table: Union[str, Table]) -> "QueryBuilder":
if self._update_table is not None or self._selects or self._delete_from:
raise AttributeError("'Query' object has no attribute '%s'" % "update")
self._update_table = table if isinstance(table, Table) else Table(table)
@builder
def columns(self, *terms: Any) -> "QueryBuilder":
if self._insert_table is None:
raise AttributeError("'Query' object has no attribute '%s'" % "insert")
if terms and isinstance(terms[0], (list, tuple)):
terms = terms[0]
for term in terms:
if isinstance(term, str):
term = Field(term, table=self._insert_table)
self._columns.append(term)
@builder
def insert(self, *terms: Any) -> "QueryBuilder":
self._apply_terms(*terms)
self._replace = False
@builder
def replace(self, *terms: Any) -> "QueryBuilder":
self._apply_terms(*terms)
self._replace = True
@builder
def force_index(self, term: Union[str, Index], *terms: Union[str, Index]) -> "QueryBuilder":
for t in (term, *terms):
if isinstance(t, Index):
self._force_indexes.append(t)
elif isinstance(t, str):
self._force_indexes.append(Index(t))
@builder
def use_index(self, term: Union[str, Index], *terms: Union[str, Index]) -> "QueryBuilder":
for t in (term, *terms):
if isinstance(t, Index):
self._use_indexes.append(t)
elif isinstance(t, str):
self._use_indexes.append(Index(t))
@builder
def distinct(self) -> "QueryBuilder":
self._distinct = True
@builder
def for_update(self) -> "QueryBuilder":
self._for_update = True
@builder
def ignore(self) -> "QueryBuilder":
self._ignore = True
@builder
def prewhere(self, criterion: Criterion) -> "QueryBuilder":
if not self._validate_table(criterion):
self._foreign_table = True
if self._prewheres:
self._prewheres &= criterion
else:
self._prewheres = criterion
@builder
def where(self, criterion: Union[Term, EmptyCriterion]) -> "QueryBuilder":
if isinstance(criterion, EmptyCriterion):
return
if not self._validate_table(criterion):
self._foreign_table = True
if self._wheres:
self._wheres &= criterion
else:
self._wheres = criterion
@builder
def having(self, criterion: Term) -> "QueryBuilder":
if self._havings:
self._havings &= criterion
else:
self._havings = criterion
@builder
def groupby(self, *terms: Union[str, int, Term]) -> "QueryBuilder":
for term in terms:
if isinstance(term, str):
term = Field(term, table=self._from[0])
elif isinstance(term, int):
term = Field(str(term), table=self._from[0]).wrap_constant(term)
self._groupbys.append(term)
@builder
def with_totals(self) -> "QueryBuilder":
self._with_totals = True
@builder
def rollup(self, *terms: Union[list, tuple, set, Term], **kwargs: Any) -> "QueryBuilder":
for_mysql = "mysql" == kwargs.get("vendor")
if self._mysql_rollup:
raise AttributeError("'Query' object has no attribute '%s'" % "rollup")
terms = [Tuple(*term) if isinstance(term, (list, tuple, set)) else term for term in terms]
if for_mysql:
# MySQL rolls up all of the dimensions always
if not terms and not self._groupbys:
raise RollupException(
"At least one group is required. Call Query.groupby(term) or pass" "as parameter to rollup."
)
self._mysql_rollup = True
self._groupbys += terms
elif 0 < len(self._groupbys) and isinstance(self._groupbys[-1], Rollup):
# If a rollup was added last, then append the new terms to the previous rollup
self._groupbys[-1].args += terms
else:
self._groupbys.append(Rollup(*terms))
@builder
def orderby(self, *fields: Any, **kwargs: Any) -> "QueryBuilder":
for field in fields:
field = Field(field, table=self._from[0]) if isinstance(field, str) else self.wrap_constant(field)
self._orderbys.append((field, kwargs.get("order")))
@builder
def join(
self, item: Union[Table, "QueryBuilder", AliasedQuery, Selectable], how: JoinType = JoinType.inner
) -> "Joiner":
if isinstance(item, Table):
return Joiner(self, item, how, type_label="table")
elif isinstance(item, QueryBuilder):
if item.alias is None:
self._tag_subquery(item)
return Joiner(self, item, how, type_label="subquery")