-
-
Notifications
You must be signed in to change notification settings - Fork 892
/
crud.py
1669 lines (1473 loc) · 55.2 KB
/
crud.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
# sql/crud.py
# Copyright (C) 2005-2024 the SQLAlchemy authors and contributors
# <see AUTHORS file>
#
# This module is part of SQLAlchemy and is released under
# the MIT License: https://www.opensource.org/licenses/mit-license.php
# mypy: allow-untyped-defs, allow-untyped-calls
"""Functions used by compiler.py to determine the parameters rendered
within INSERT and UPDATE statements.
"""
from __future__ import annotations
import functools
import operator
from typing import Any
from typing import Callable
from typing import cast
from typing import Dict
from typing import Iterable
from typing import List
from typing import MutableMapping
from typing import NamedTuple
from typing import Optional
from typing import overload
from typing import Sequence
from typing import Set
from typing import Tuple
from typing import TYPE_CHECKING
from typing import Union
from . import coercions
from . import dml
from . import elements
from . import roles
from .base import _DefaultDescriptionTuple
from .dml import isinsert as _compile_state_isinsert
from .elements import ColumnClause
from .schema import default_is_clause_element
from .schema import default_is_sequence
from .selectable import Select
from .selectable import TableClause
from .. import exc
from .. import util
from ..util.typing import Literal
if TYPE_CHECKING:
from .compiler import _BindNameForColProtocol
from .compiler import SQLCompiler
from .dml import _DMLColumnElement
from .dml import DMLState
from .dml import ValuesBase
from .elements import ColumnElement
from .elements import KeyedColumnElement
from .schema import _SQLExprDefault
from .schema import Column
REQUIRED = util.symbol(
"REQUIRED",
"""
Placeholder for the value within a :class:`.BindParameter`
which is required to be present when the statement is passed
to :meth:`_engine.Connection.execute`.
This symbol is typically used when a :func:`_expression.insert`
or :func:`_expression.update` statement is compiled without parameter
values present.
""",
)
def _as_dml_column(c: ColumnElement[Any]) -> ColumnClause[Any]:
if not isinstance(c, ColumnClause):
raise exc.CompileError(
f"Can't create DML statement against column expression {c!r}"
)
return c
_CrudParamElement = Tuple[
"ColumnElement[Any]",
str, # column name
Optional[
Union[str, "_SQLExprDefault"]
], # bound parameter string or SQL expression to apply
Iterable[str],
]
_CrudParamElementStr = Tuple[
"KeyedColumnElement[Any]",
str, # column name
str, # bound parameter string
Iterable[str],
]
_CrudParamElementSQLExpr = Tuple[
"ColumnClause[Any]",
str,
"_SQLExprDefault", # SQL expression to apply
Iterable[str],
]
_CrudParamSequence = List[_CrudParamElement]
class _CrudParams(NamedTuple):
single_params: _CrudParamSequence
all_multi_params: List[Sequence[_CrudParamElementStr]]
is_default_metavalue_only: bool = False
use_insertmanyvalues: bool = False
use_sentinel_columns: Optional[Sequence[Column[Any]]] = None
def _get_crud_params(
compiler: SQLCompiler,
stmt: ValuesBase,
compile_state: DMLState,
toplevel: bool,
**kw: Any,
) -> _CrudParams:
"""create a set of tuples representing column/string pairs for use
in an INSERT or UPDATE statement.
Also generates the Compiled object's postfetch, prefetch, and
returning column collections, used for default handling and ultimately
populating the CursorResult's prefetch_cols() and postfetch_cols()
collections.
"""
# note: the _get_crud_params() system was written with the notion in mind
# that INSERT, UPDATE, DELETE are always the top level statement and
# that there is only one of them. With the addition of CTEs that can
# make use of DML, this assumption is no longer accurate; the DML
# statement is not necessarily the top-level "row returning" thing
# and it is also theoretically possible (fortunately nobody has asked yet)
# to have a single statement with multiple DMLs inside of it via CTEs.
# the current _get_crud_params() design doesn't accommodate these cases
# right now. It "just works" for a CTE that has a single DML inside of
# it, and for a CTE with multiple DML, it's not clear what would happen.
# overall, the "compiler.XYZ" collections here would need to be in a
# per-DML structure of some kind, and DefaultDialect would need to
# navigate these collections on a per-statement basis, with additional
# emphasis on the "toplevel returning data" statement. However we
# still need to run through _get_crud_params() for all DML as we have
# Python / SQL generated column defaults that need to be rendered.
# if there is user need for this kind of thing, it's likely a post 2.0
# kind of change as it would require deep changes to DefaultDialect
# as well as here.
compiler.postfetch = []
compiler.insert_prefetch = []
compiler.update_prefetch = []
compiler.implicit_returning = []
visiting_cte = kw.get("visiting_cte", None)
if visiting_cte is not None:
# for insert -> CTE -> insert, don't populate an incoming
# _crud_accumulate_bind_names collection; the INSERT we process here
# will not be inline within the VALUES of the enclosing INSERT as the
# CTE is placed on the outside. See issue #9173
kw.pop("accumulate_bind_names", None)
assert (
"accumulate_bind_names" not in kw
), "Don't know how to handle insert within insert without a CTE"
# getters - these are normally just column.key,
# but in the case of mysql multi-table update, the rules for
# .key must conditionally take tablename into account
(
_column_as_key,
_getattr_col_key,
_col_bind_name,
) = _key_getters_for_crud_column(compiler, stmt, compile_state)
compiler._get_bind_name_for_col = _col_bind_name
if stmt._returning and stmt._return_defaults:
raise exc.CompileError(
"Can't compile statement that includes returning() and "
"return_defaults() simultaneously"
)
if compile_state.isdelete:
_setup_delete_return_defaults(
compiler,
stmt,
compile_state,
(),
_getattr_col_key,
_column_as_key,
_col_bind_name,
(),
(),
toplevel,
kw,
)
return _CrudParams([], [])
# no parameters in the statement, no parameters in the
# compiled params - return binds for all columns
if compiler.column_keys is None and compile_state._no_parameters:
return _CrudParams(
[
(
c,
compiler.preparer.format_column(c),
_create_bind_param(compiler, c, None, required=True),
(c.key,),
)
for c in stmt.table.columns
if not c._omit_from_statements
],
[],
)
stmt_parameter_tuples: Optional[
List[Tuple[Union[str, ColumnClause[Any]], Any]]
]
spd: Optional[MutableMapping[_DMLColumnElement, Any]]
if (
_compile_state_isinsert(compile_state)
and compile_state._has_multi_parameters
):
mp = compile_state._multi_parameters
assert mp is not None
spd = mp[0]
stmt_parameter_tuples = list(spd.items())
spd_str_key = {_column_as_key(key) for key in spd}
elif compile_state._ordered_values:
spd = compile_state._dict_parameters
stmt_parameter_tuples = compile_state._ordered_values
assert spd is not None
spd_str_key = {_column_as_key(key) for key in spd}
elif compile_state._dict_parameters:
spd = compile_state._dict_parameters
stmt_parameter_tuples = list(spd.items())
spd_str_key = {_column_as_key(key) for key in spd}
else:
stmt_parameter_tuples = spd = spd_str_key = None
# if we have statement parameters - set defaults in the
# compiled params
if compiler.column_keys is None:
parameters = {}
elif stmt_parameter_tuples:
assert spd_str_key is not None
parameters = {
_column_as_key(key): REQUIRED
for key in compiler.column_keys
if key not in spd_str_key
}
else:
parameters = {
_column_as_key(key): REQUIRED for key in compiler.column_keys
}
# create a list of column assignment clauses as tuples
values: List[_CrudParamElement] = []
if stmt_parameter_tuples is not None:
_get_stmt_parameter_tuples_params(
compiler,
compile_state,
parameters,
stmt_parameter_tuples,
_column_as_key,
values,
kw,
)
check_columns: Dict[str, ColumnClause[Any]] = {}
# special logic that only occurs for multi-table UPDATE
# statements
if dml.isupdate(compile_state) and compile_state.is_multitable:
_get_update_multitable_params(
compiler,
stmt,
compile_state,
stmt_parameter_tuples,
check_columns,
_col_bind_name,
_getattr_col_key,
values,
kw,
)
if _compile_state_isinsert(compile_state) and stmt._select_names:
# is an insert from select, is not a multiparams
assert not compile_state._has_multi_parameters
_scan_insert_from_select_cols(
compiler,
stmt,
compile_state,
parameters,
_getattr_col_key,
_column_as_key,
_col_bind_name,
check_columns,
values,
toplevel,
kw,
)
use_insertmanyvalues = False
use_sentinel_columns = None
else:
use_insertmanyvalues, use_sentinel_columns = _scan_cols(
compiler,
stmt,
compile_state,
parameters,
_getattr_col_key,
_column_as_key,
_col_bind_name,
check_columns,
values,
toplevel,
kw,
)
if parameters and stmt_parameter_tuples:
check = (
set(parameters)
.intersection(_column_as_key(k) for k, v in stmt_parameter_tuples)
.difference(check_columns)
)
if check:
raise exc.CompileError(
"Unconsumed column names: %s"
% (", ".join("%s" % (c,) for c in check))
)
is_default_metavalue_only = False
if (
_compile_state_isinsert(compile_state)
and compile_state._has_multi_parameters
):
# is a multiparams, is not an insert from a select
assert not stmt._select_names
multi_extended_values = _extend_values_for_multiparams(
compiler,
stmt,
compile_state,
cast(
"Sequence[_CrudParamElementStr]",
values,
),
cast("Callable[..., str]", _column_as_key),
kw,
)
return _CrudParams(values, multi_extended_values)
elif (
not values
and compiler.for_executemany
and compiler.dialect.supports_default_metavalue
):
# convert an "INSERT DEFAULT VALUES"
# into INSERT (firstcol) VALUES (DEFAULT) which can be turned
# into an in-place multi values. This supports
# insert_executemany_returning mode :)
values = [
(
_as_dml_column(stmt.table.columns[0]),
compiler.preparer.format_column(stmt.table.columns[0]),
compiler.dialect.default_metavalue_token,
(),
)
]
is_default_metavalue_only = True
return _CrudParams(
values,
[],
is_default_metavalue_only=is_default_metavalue_only,
use_insertmanyvalues=use_insertmanyvalues,
use_sentinel_columns=use_sentinel_columns,
)
@overload
def _create_bind_param(
compiler: SQLCompiler,
col: ColumnElement[Any],
value: Any,
process: Literal[True] = ...,
required: bool = False,
name: Optional[str] = None,
**kw: Any,
) -> str: ...
@overload
def _create_bind_param(
compiler: SQLCompiler,
col: ColumnElement[Any],
value: Any,
**kw: Any,
) -> str: ...
def _create_bind_param(
compiler: SQLCompiler,
col: ColumnElement[Any],
value: Any,
process: bool = True,
required: bool = False,
name: Optional[str] = None,
**kw: Any,
) -> Union[str, elements.BindParameter[Any]]:
if name is None:
name = col.key
bindparam = elements.BindParameter(
name, value, type_=col.type, required=required
)
bindparam._is_crud = True
if process:
return bindparam._compiler_dispatch(compiler, **kw)
else:
return bindparam
def _handle_values_anonymous_param(compiler, col, value, name, **kw):
# the insert() and update() constructs as of 1.4 will now produce anonymous
# bindparam() objects in the values() collections up front when given plain
# literal values. This is so that cache key behaviors, which need to
# produce bound parameters in deterministic order without invoking any
# compilation here, can be applied to these constructs when they include
# values() (but not yet multi-values, which are not included in caching
# right now).
#
# in order to produce the desired "crud" style name for these parameters,
# which will also be targetable in engine/default.py through the usual
# conventions, apply our desired name to these unique parameters by
# populating the compiler truncated names cache with the desired name,
# rather than having
# compiler.visit_bindparam()->compiler._truncated_identifier make up a
# name. Saves on call counts also.
# for INSERT/UPDATE that's a CTE, we don't need names to match to
# external parameters and these would also conflict in the case where
# multiple insert/update are combined together using CTEs
is_cte = "visiting_cte" in kw
if (
not is_cte
and value.unique
and isinstance(value.key, elements._truncated_label)
):
compiler.truncated_names[("bindparam", value.key)] = name
if value.type._isnull:
# either unique parameter, or other bound parameters that were
# passed in directly
# set type to that of the column unconditionally
value = value._with_binary_element_type(col.type)
return value._compiler_dispatch(compiler, **kw)
def _key_getters_for_crud_column(
compiler: SQLCompiler, stmt: ValuesBase, compile_state: DMLState
) -> Tuple[
Callable[[Union[str, ColumnClause[Any]]], Union[str, Tuple[str, str]]],
Callable[[ColumnClause[Any]], Union[str, Tuple[str, str]]],
_BindNameForColProtocol,
]:
if dml.isupdate(compile_state) and compile_state._extra_froms:
# when extra tables are present, refer to the columns
# in those extra tables as table-qualified, including in
# dictionaries and when rendering bind param names.
# the "main" table of the statement remains unqualified,
# allowing the most compatibility with a non-multi-table
# statement.
_et = set(compile_state._extra_froms)
c_key_role = functools.partial(
coercions.expect_as_key, roles.DMLColumnRole
)
def _column_as_key(
key: Union[ColumnClause[Any], str]
) -> Union[str, Tuple[str, str]]:
str_key = c_key_role(key)
if hasattr(key, "table") and key.table in _et:
return (key.table.name, str_key) # type: ignore
else:
return str_key
def _getattr_col_key(
col: ColumnClause[Any],
) -> Union[str, Tuple[str, str]]:
if col.table in _et:
return (col.table.name, col.key) # type: ignore
else:
return col.key
def _col_bind_name(col: ColumnClause[Any]) -> str:
if col.table in _et:
if TYPE_CHECKING:
assert isinstance(col.table, TableClause)
return "%s_%s" % (col.table.name, col.key)
else:
return col.key
else:
_column_as_key = functools.partial(
coercions.expect_as_key, roles.DMLColumnRole
)
_getattr_col_key = _col_bind_name = operator.attrgetter("key") # type: ignore # noqa: E501
return _column_as_key, _getattr_col_key, _col_bind_name
def _scan_insert_from_select_cols(
compiler,
stmt,
compile_state,
parameters,
_getattr_col_key,
_column_as_key,
_col_bind_name,
check_columns,
values,
toplevel,
kw,
):
cols = [stmt.table.c[_column_as_key(name)] for name in stmt._select_names]
assert compiler.stack[-1]["selectable"] is stmt
compiler.stack[-1]["insert_from_select"] = stmt.select
add_select_cols: List[_CrudParamElementSQLExpr] = []
if stmt.include_insert_from_select_defaults:
col_set = set(cols)
for col in stmt.table.columns:
# omit columns that were not in the SELECT statement.
# this will omit columns marked as omit_from_statements naturally,
# as long as that col was not explicit in the SELECT.
# if an omit_from_statements col has a "default" on it, then
# we need to include it, as these defaults should still fire off.
# but, if it has that default and it's the "sentinel" default,
# we don't do sentinel default operations for insert_from_select
# here so we again omit it.
if (
col not in col_set
and col.default
and not col.default.is_sentinel
):
cols.append(col)
for c in cols:
col_key = _getattr_col_key(c)
if col_key in parameters and col_key not in check_columns:
parameters.pop(col_key)
values.append((c, compiler.preparer.format_column(c), None, ()))
else:
_append_param_insert_select_hasdefault(
compiler, stmt, c, add_select_cols, kw
)
if add_select_cols:
values.extend(add_select_cols)
ins_from_select = compiler.stack[-1]["insert_from_select"]
if not isinstance(ins_from_select, Select):
raise exc.CompileError(
f"Can't extend statement for INSERT..FROM SELECT to include "
f"additional default-holding column(s) "
f"""{
', '.join(repr(key) for _, key, _, _ in add_select_cols)
}. Convert the selectable to a subquery() first, or pass """
"include_defaults=False to Insert.from_select() to skip these "
"columns."
)
ins_from_select = ins_from_select._generate()
# copy raw_columns
ins_from_select._raw_columns = list(ins_from_select._raw_columns) + [
expr for _, _, expr, _ in add_select_cols
]
compiler.stack[-1]["insert_from_select"] = ins_from_select
def _scan_cols(
compiler,
stmt,
compile_state,
parameters,
_getattr_col_key,
_column_as_key,
_col_bind_name,
check_columns,
values,
toplevel,
kw,
):
(
need_pks,
implicit_returning,
implicit_return_defaults,
postfetch_lastrowid,
use_insertmanyvalues,
use_sentinel_columns,
) = _get_returning_modifiers(compiler, stmt, compile_state, toplevel)
assert compile_state.isupdate or compile_state.isinsert
if compile_state._parameter_ordering:
parameter_ordering = [
_column_as_key(key) for key in compile_state._parameter_ordering
]
ordered_keys = set(parameter_ordering)
cols = [
stmt.table.c[key]
for key in parameter_ordering
if isinstance(key, str) and key in stmt.table.c
] + [c for c in stmt.table.c if c.key not in ordered_keys]
else:
cols = stmt.table.columns
isinsert = _compile_state_isinsert(compile_state)
if isinsert and not compile_state._has_multi_parameters:
# new rules for #7998. fetch lastrowid or implicit returning
# for autoincrement column even if parameter is NULL, for DBs that
# override NULL param for primary key (sqlite, mysql/mariadb)
autoincrement_col = stmt.table._autoincrement_column
insert_null_pk_still_autoincrements = (
compiler.dialect.insert_null_pk_still_autoincrements
)
else:
autoincrement_col = insert_null_pk_still_autoincrements = None
if stmt._supplemental_returning:
supplemental_returning = set(stmt._supplemental_returning)
else:
supplemental_returning = set()
compiler_implicit_returning = compiler.implicit_returning
# TODO - see TODO(return_defaults_columns) below
# cols_in_params = set()
for c in cols:
# scan through every column in the target table
col_key = _getattr_col_key(c)
if col_key in parameters and col_key not in check_columns:
# parameter is present for the column. use that.
_append_param_parameter(
compiler,
stmt,
compile_state,
c,
col_key,
parameters,
_col_bind_name,
implicit_returning,
implicit_return_defaults,
postfetch_lastrowid,
values,
autoincrement_col,
insert_null_pk_still_autoincrements,
kw,
)
# TODO - see TODO(return_defaults_columns) below
# cols_in_params.add(c)
elif isinsert:
# no parameter is present and it's an insert.
if c.primary_key and need_pks:
# it's a primary key column, it will need to be generated by a
# default generator of some kind, and the statement expects
# inserted_primary_key to be available.
if implicit_returning:
# we can use RETURNING, find out how to invoke this
# column and get the value where RETURNING is an option.
# we can inline server-side functions in this case.
_append_param_insert_pk_returning(
compiler, stmt, c, values, kw
)
else:
# otherwise, find out how to invoke this column
# and get its value where RETURNING is not an option.
# if we have to invoke a server-side function, we need
# to pre-execute it. or if this is a straight
# autoincrement column and the dialect supports it
# we can use cursor.lastrowid.
_append_param_insert_pk_no_returning(
compiler, stmt, c, values, kw
)
elif c.default is not None:
# column has a default, but it's not a pk column, or it is but
# we don't need to get the pk back.
if not c.default.is_sentinel or (
use_sentinel_columns is not None
):
_append_param_insert_hasdefault(
compiler, stmt, c, implicit_return_defaults, values, kw
)
elif c.server_default is not None:
# column has a DDL-level default, and is either not a pk
# column or we don't need the pk.
if implicit_return_defaults and c in implicit_return_defaults:
compiler_implicit_returning.append(c)
elif not c.primary_key:
compiler.postfetch.append(c)
elif implicit_return_defaults and c in implicit_return_defaults:
compiler_implicit_returning.append(c)
elif (
c.primary_key
and c is not stmt.table._autoincrement_column
and not c.nullable
):
_warn_pk_with_no_anticipated_value(c)
elif compile_state.isupdate:
# no parameter is present and it's an insert.
_append_param_update(
compiler,
compile_state,
stmt,
c,
implicit_return_defaults,
values,
kw,
)
# adding supplemental cols to implicit_returning in table
# order so that order is maintained between multiple INSERT
# statements which may have different parameters included, but all
# have the same RETURNING clause
if (
c in supplemental_returning
and c not in compiler_implicit_returning
):
compiler_implicit_returning.append(c)
if supplemental_returning:
# we should have gotten every col into implicit_returning,
# however supplemental returning can also have SQL functions etc.
# in it
remaining_supplemental = supplemental_returning.difference(
compiler_implicit_returning
)
compiler_implicit_returning.extend(
c
for c in stmt._supplemental_returning
if c in remaining_supplemental
)
# TODO(return_defaults_columns): there can still be more columns in
# _return_defaults_columns in the case that they are from something like an
# aliased of the table. we can add them here, however this breaks other ORM
# things. so this is for another day. see
# test/orm/dml/test_update_delete_where.py -> test_update_from_alias
# if stmt._return_defaults_columns:
# compiler_implicit_returning.extend(
# set(stmt._return_defaults_columns)
# .difference(compiler_implicit_returning)
# .difference(cols_in_params)
# )
return (use_insertmanyvalues, use_sentinel_columns)
def _setup_delete_return_defaults(
compiler,
stmt,
compile_state,
parameters,
_getattr_col_key,
_column_as_key,
_col_bind_name,
check_columns,
values,
toplevel,
kw,
):
(_, _, implicit_return_defaults, *_) = _get_returning_modifiers(
compiler, stmt, compile_state, toplevel
)
if not implicit_return_defaults:
return
if stmt._return_defaults_columns:
compiler.implicit_returning.extend(implicit_return_defaults)
if stmt._supplemental_returning:
ir_set = set(compiler.implicit_returning)
compiler.implicit_returning.extend(
c for c in stmt._supplemental_returning if c not in ir_set
)
def _append_param_parameter(
compiler,
stmt,
compile_state,
c,
col_key,
parameters,
_col_bind_name,
implicit_returning,
implicit_return_defaults,
postfetch_lastrowid,
values,
autoincrement_col,
insert_null_pk_still_autoincrements,
kw,
):
value = parameters.pop(col_key)
col_value = compiler.preparer.format_column(
c, use_table=compile_state.include_table_with_column_exprs
)
accumulated_bind_names: Set[str] = set()
if coercions._is_literal(value):
if (
insert_null_pk_still_autoincrements
and c.primary_key
and c is autoincrement_col
):
# support use case for #7998, fetch autoincrement cols
# even if value was given.
if postfetch_lastrowid:
compiler.postfetch_lastrowid = True
elif implicit_returning:
compiler.implicit_returning.append(c)
value = _create_bind_param(
compiler,
c,
value,
required=value is REQUIRED,
name=(
_col_bind_name(c)
if not _compile_state_isinsert(compile_state)
or not compile_state._has_multi_parameters
else "%s_m0" % _col_bind_name(c)
),
accumulate_bind_names=accumulated_bind_names,
**kw,
)
elif value._is_bind_parameter:
if (
insert_null_pk_still_autoincrements
and value.value is None
and c.primary_key
and c is autoincrement_col
):
# support use case for #7998, fetch autoincrement cols
# even if value was given
if implicit_returning:
compiler.implicit_returning.append(c)
elif compiler.dialect.postfetch_lastrowid:
compiler.postfetch_lastrowid = True
value = _handle_values_anonymous_param(
compiler,
c,
value,
name=(
_col_bind_name(c)
if not _compile_state_isinsert(compile_state)
or not compile_state._has_multi_parameters
else "%s_m0" % _col_bind_name(c)
),
accumulate_bind_names=accumulated_bind_names,
**kw,
)
else:
# value is a SQL expression
value = compiler.process(
value.self_group(),
accumulate_bind_names=accumulated_bind_names,
**kw,
)
if compile_state.isupdate:
if implicit_return_defaults and c in implicit_return_defaults:
compiler.implicit_returning.append(c)
else:
compiler.postfetch.append(c)
else:
if c.primary_key:
if implicit_returning:
compiler.implicit_returning.append(c)
elif compiler.dialect.postfetch_lastrowid:
compiler.postfetch_lastrowid = True
elif implicit_return_defaults and (c in implicit_return_defaults):
compiler.implicit_returning.append(c)
else:
# postfetch specifically means, "we can SELECT the row we just
# inserted by primary key to get back the server generated
# defaults". so by definition this can't be used to get the
# primary key value back, because we need to have it ahead of
# time.
compiler.postfetch.append(c)
values.append((c, col_value, value, accumulated_bind_names))
def _append_param_insert_pk_returning(compiler, stmt, c, values, kw):
"""Create a primary key expression in the INSERT statement where
we want to populate result.inserted_primary_key and RETURNING
is available.
"""
if c.default is not None:
if c.default.is_sequence:
if compiler.dialect.supports_sequences and (
not c.default.optional
or not compiler.dialect.sequences_optional
):
accumulated_bind_names: Set[str] = set()
values.append(
(
c,
compiler.preparer.format_column(c),
compiler.process(
c.default,
accumulate_bind_names=accumulated_bind_names,
**kw,
),
accumulated_bind_names,
)
)
compiler.implicit_returning.append(c)
elif c.default.is_clause_element:
accumulated_bind_names = set()
values.append(
(
c,
compiler.preparer.format_column(c),
compiler.process(
c.default.arg.self_group(),
accumulate_bind_names=accumulated_bind_names,
**kw,
),
accumulated_bind_names,
)
)
compiler.implicit_returning.append(c)
else:
# client side default. OK we can't use RETURNING, need to
# do a "prefetch", which in fact fetches the default value
# on the Python side
values.append(
(
c,
compiler.preparer.format_column(c),
_create_insert_prefetch_bind_param(compiler, c, **kw),
(c.key,),
)
)
elif c is stmt.table._autoincrement_column or c.server_default is not None:
compiler.implicit_returning.append(c)
elif not c.nullable:
# no .default, no .server_default, not autoincrement, we have
# no indication this primary key column will have any value
_warn_pk_with_no_anticipated_value(c)
def _append_param_insert_pk_no_returning(compiler, stmt, c, values, kw):
"""Create a primary key expression in the INSERT statement where
we want to populate result.inserted_primary_key and we cannot use
RETURNING.
Depending on the kind of default here we may create a bound parameter
in the INSERT statement and pre-execute a default generation function,
or we may use cursor.lastrowid if supported by the dialect.