sqlspec 0.32.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (262) hide show
  1. sqlspec/__init__.py +104 -0
  2. sqlspec/__main__.py +12 -0
  3. sqlspec/__metadata__.py +14 -0
  4. sqlspec/_serialization.py +312 -0
  5. sqlspec/_typing.py +784 -0
  6. sqlspec/adapters/__init__.py +0 -0
  7. sqlspec/adapters/adbc/__init__.py +5 -0
  8. sqlspec/adapters/adbc/_types.py +12 -0
  9. sqlspec/adapters/adbc/adk/__init__.py +5 -0
  10. sqlspec/adapters/adbc/adk/store.py +880 -0
  11. sqlspec/adapters/adbc/config.py +436 -0
  12. sqlspec/adapters/adbc/data_dictionary.py +537 -0
  13. sqlspec/adapters/adbc/driver.py +841 -0
  14. sqlspec/adapters/adbc/litestar/__init__.py +5 -0
  15. sqlspec/adapters/adbc/litestar/store.py +504 -0
  16. sqlspec/adapters/adbc/type_converter.py +153 -0
  17. sqlspec/adapters/aiosqlite/__init__.py +29 -0
  18. sqlspec/adapters/aiosqlite/_types.py +13 -0
  19. sqlspec/adapters/aiosqlite/adk/__init__.py +5 -0
  20. sqlspec/adapters/aiosqlite/adk/store.py +536 -0
  21. sqlspec/adapters/aiosqlite/config.py +310 -0
  22. sqlspec/adapters/aiosqlite/data_dictionary.py +260 -0
  23. sqlspec/adapters/aiosqlite/driver.py +463 -0
  24. sqlspec/adapters/aiosqlite/litestar/__init__.py +5 -0
  25. sqlspec/adapters/aiosqlite/litestar/store.py +281 -0
  26. sqlspec/adapters/aiosqlite/pool.py +500 -0
  27. sqlspec/adapters/asyncmy/__init__.py +25 -0
  28. sqlspec/adapters/asyncmy/_types.py +12 -0
  29. sqlspec/adapters/asyncmy/adk/__init__.py +5 -0
  30. sqlspec/adapters/asyncmy/adk/store.py +503 -0
  31. sqlspec/adapters/asyncmy/config.py +246 -0
  32. sqlspec/adapters/asyncmy/data_dictionary.py +241 -0
  33. sqlspec/adapters/asyncmy/driver.py +632 -0
  34. sqlspec/adapters/asyncmy/litestar/__init__.py +5 -0
  35. sqlspec/adapters/asyncmy/litestar/store.py +296 -0
  36. sqlspec/adapters/asyncpg/__init__.py +23 -0
  37. sqlspec/adapters/asyncpg/_type_handlers.py +76 -0
  38. sqlspec/adapters/asyncpg/_types.py +23 -0
  39. sqlspec/adapters/asyncpg/adk/__init__.py +5 -0
  40. sqlspec/adapters/asyncpg/adk/store.py +460 -0
  41. sqlspec/adapters/asyncpg/config.py +464 -0
  42. sqlspec/adapters/asyncpg/data_dictionary.py +321 -0
  43. sqlspec/adapters/asyncpg/driver.py +720 -0
  44. sqlspec/adapters/asyncpg/litestar/__init__.py +5 -0
  45. sqlspec/adapters/asyncpg/litestar/store.py +253 -0
  46. sqlspec/adapters/bigquery/__init__.py +18 -0
  47. sqlspec/adapters/bigquery/_types.py +12 -0
  48. sqlspec/adapters/bigquery/adk/__init__.py +5 -0
  49. sqlspec/adapters/bigquery/adk/store.py +585 -0
  50. sqlspec/adapters/bigquery/config.py +298 -0
  51. sqlspec/adapters/bigquery/data_dictionary.py +256 -0
  52. sqlspec/adapters/bigquery/driver.py +1073 -0
  53. sqlspec/adapters/bigquery/litestar/__init__.py +5 -0
  54. sqlspec/adapters/bigquery/litestar/store.py +327 -0
  55. sqlspec/adapters/bigquery/type_converter.py +125 -0
  56. sqlspec/adapters/duckdb/__init__.py +24 -0
  57. sqlspec/adapters/duckdb/_types.py +12 -0
  58. sqlspec/adapters/duckdb/adk/__init__.py +14 -0
  59. sqlspec/adapters/duckdb/adk/store.py +563 -0
  60. sqlspec/adapters/duckdb/config.py +396 -0
  61. sqlspec/adapters/duckdb/data_dictionary.py +264 -0
  62. sqlspec/adapters/duckdb/driver.py +604 -0
  63. sqlspec/adapters/duckdb/litestar/__init__.py +5 -0
  64. sqlspec/adapters/duckdb/litestar/store.py +332 -0
  65. sqlspec/adapters/duckdb/pool.py +273 -0
  66. sqlspec/adapters/duckdb/type_converter.py +133 -0
  67. sqlspec/adapters/oracledb/__init__.py +32 -0
  68. sqlspec/adapters/oracledb/_numpy_handlers.py +133 -0
  69. sqlspec/adapters/oracledb/_types.py +39 -0
  70. sqlspec/adapters/oracledb/_uuid_handlers.py +130 -0
  71. sqlspec/adapters/oracledb/adk/__init__.py +5 -0
  72. sqlspec/adapters/oracledb/adk/store.py +1632 -0
  73. sqlspec/adapters/oracledb/config.py +469 -0
  74. sqlspec/adapters/oracledb/data_dictionary.py +717 -0
  75. sqlspec/adapters/oracledb/driver.py +1493 -0
  76. sqlspec/adapters/oracledb/litestar/__init__.py +5 -0
  77. sqlspec/adapters/oracledb/litestar/store.py +765 -0
  78. sqlspec/adapters/oracledb/migrations.py +532 -0
  79. sqlspec/adapters/oracledb/type_converter.py +207 -0
  80. sqlspec/adapters/psqlpy/__init__.py +16 -0
  81. sqlspec/adapters/psqlpy/_type_handlers.py +44 -0
  82. sqlspec/adapters/psqlpy/_types.py +12 -0
  83. sqlspec/adapters/psqlpy/adk/__init__.py +5 -0
  84. sqlspec/adapters/psqlpy/adk/store.py +483 -0
  85. sqlspec/adapters/psqlpy/config.py +271 -0
  86. sqlspec/adapters/psqlpy/data_dictionary.py +179 -0
  87. sqlspec/adapters/psqlpy/driver.py +892 -0
  88. sqlspec/adapters/psqlpy/litestar/__init__.py +5 -0
  89. sqlspec/adapters/psqlpy/litestar/store.py +272 -0
  90. sqlspec/adapters/psqlpy/type_converter.py +102 -0
  91. sqlspec/adapters/psycopg/__init__.py +32 -0
  92. sqlspec/adapters/psycopg/_type_handlers.py +90 -0
  93. sqlspec/adapters/psycopg/_types.py +18 -0
  94. sqlspec/adapters/psycopg/adk/__init__.py +5 -0
  95. sqlspec/adapters/psycopg/adk/store.py +962 -0
  96. sqlspec/adapters/psycopg/config.py +487 -0
  97. sqlspec/adapters/psycopg/data_dictionary.py +630 -0
  98. sqlspec/adapters/psycopg/driver.py +1336 -0
  99. sqlspec/adapters/psycopg/litestar/__init__.py +5 -0
  100. sqlspec/adapters/psycopg/litestar/store.py +554 -0
  101. sqlspec/adapters/spanner/__init__.py +38 -0
  102. sqlspec/adapters/spanner/_type_handlers.py +186 -0
  103. sqlspec/adapters/spanner/_types.py +12 -0
  104. sqlspec/adapters/spanner/adk/__init__.py +5 -0
  105. sqlspec/adapters/spanner/adk/store.py +435 -0
  106. sqlspec/adapters/spanner/config.py +241 -0
  107. sqlspec/adapters/spanner/data_dictionary.py +95 -0
  108. sqlspec/adapters/spanner/dialect/__init__.py +6 -0
  109. sqlspec/adapters/spanner/dialect/_spangres.py +52 -0
  110. sqlspec/adapters/spanner/dialect/_spanner.py +123 -0
  111. sqlspec/adapters/spanner/driver.py +366 -0
  112. sqlspec/adapters/spanner/litestar/__init__.py +5 -0
  113. sqlspec/adapters/spanner/litestar/store.py +266 -0
  114. sqlspec/adapters/spanner/type_converter.py +46 -0
  115. sqlspec/adapters/sqlite/__init__.py +18 -0
  116. sqlspec/adapters/sqlite/_type_handlers.py +86 -0
  117. sqlspec/adapters/sqlite/_types.py +11 -0
  118. sqlspec/adapters/sqlite/adk/__init__.py +5 -0
  119. sqlspec/adapters/sqlite/adk/store.py +582 -0
  120. sqlspec/adapters/sqlite/config.py +221 -0
  121. sqlspec/adapters/sqlite/data_dictionary.py +256 -0
  122. sqlspec/adapters/sqlite/driver.py +527 -0
  123. sqlspec/adapters/sqlite/litestar/__init__.py +5 -0
  124. sqlspec/adapters/sqlite/litestar/store.py +318 -0
  125. sqlspec/adapters/sqlite/pool.py +140 -0
  126. sqlspec/base.py +811 -0
  127. sqlspec/builder/__init__.py +146 -0
  128. sqlspec/builder/_base.py +900 -0
  129. sqlspec/builder/_column.py +517 -0
  130. sqlspec/builder/_ddl.py +1642 -0
  131. sqlspec/builder/_delete.py +84 -0
  132. sqlspec/builder/_dml.py +381 -0
  133. sqlspec/builder/_expression_wrappers.py +46 -0
  134. sqlspec/builder/_factory.py +1537 -0
  135. sqlspec/builder/_insert.py +315 -0
  136. sqlspec/builder/_join.py +375 -0
  137. sqlspec/builder/_merge.py +848 -0
  138. sqlspec/builder/_parsing_utils.py +297 -0
  139. sqlspec/builder/_select.py +1615 -0
  140. sqlspec/builder/_update.py +161 -0
  141. sqlspec/builder/_vector_expressions.py +259 -0
  142. sqlspec/cli.py +764 -0
  143. sqlspec/config.py +1540 -0
  144. sqlspec/core/__init__.py +305 -0
  145. sqlspec/core/cache.py +785 -0
  146. sqlspec/core/compiler.py +603 -0
  147. sqlspec/core/filters.py +872 -0
  148. sqlspec/core/hashing.py +274 -0
  149. sqlspec/core/metrics.py +83 -0
  150. sqlspec/core/parameters/__init__.py +64 -0
  151. sqlspec/core/parameters/_alignment.py +266 -0
  152. sqlspec/core/parameters/_converter.py +413 -0
  153. sqlspec/core/parameters/_processor.py +341 -0
  154. sqlspec/core/parameters/_registry.py +201 -0
  155. sqlspec/core/parameters/_transformers.py +226 -0
  156. sqlspec/core/parameters/_types.py +430 -0
  157. sqlspec/core/parameters/_validator.py +123 -0
  158. sqlspec/core/pipeline.py +187 -0
  159. sqlspec/core/result.py +1124 -0
  160. sqlspec/core/splitter.py +940 -0
  161. sqlspec/core/stack.py +163 -0
  162. sqlspec/core/statement.py +835 -0
  163. sqlspec/core/type_conversion.py +235 -0
  164. sqlspec/driver/__init__.py +36 -0
  165. sqlspec/driver/_async.py +1027 -0
  166. sqlspec/driver/_common.py +1236 -0
  167. sqlspec/driver/_sync.py +1025 -0
  168. sqlspec/driver/mixins/__init__.py +7 -0
  169. sqlspec/driver/mixins/_result_tools.py +61 -0
  170. sqlspec/driver/mixins/_sql_translator.py +122 -0
  171. sqlspec/driver/mixins/_storage.py +311 -0
  172. sqlspec/exceptions.py +321 -0
  173. sqlspec/extensions/__init__.py +0 -0
  174. sqlspec/extensions/adk/__init__.py +53 -0
  175. sqlspec/extensions/adk/_types.py +51 -0
  176. sqlspec/extensions/adk/converters.py +172 -0
  177. sqlspec/extensions/adk/migrations/0001_create_adk_tables.py +144 -0
  178. sqlspec/extensions/adk/migrations/__init__.py +0 -0
  179. sqlspec/extensions/adk/service.py +181 -0
  180. sqlspec/extensions/adk/store.py +536 -0
  181. sqlspec/extensions/aiosql/__init__.py +10 -0
  182. sqlspec/extensions/aiosql/adapter.py +471 -0
  183. sqlspec/extensions/fastapi/__init__.py +19 -0
  184. sqlspec/extensions/fastapi/extension.py +341 -0
  185. sqlspec/extensions/fastapi/providers.py +543 -0
  186. sqlspec/extensions/flask/__init__.py +36 -0
  187. sqlspec/extensions/flask/_state.py +72 -0
  188. sqlspec/extensions/flask/_utils.py +40 -0
  189. sqlspec/extensions/flask/extension.py +402 -0
  190. sqlspec/extensions/litestar/__init__.py +23 -0
  191. sqlspec/extensions/litestar/_utils.py +52 -0
  192. sqlspec/extensions/litestar/cli.py +92 -0
  193. sqlspec/extensions/litestar/config.py +90 -0
  194. sqlspec/extensions/litestar/handlers.py +316 -0
  195. sqlspec/extensions/litestar/migrations/0001_create_session_table.py +137 -0
  196. sqlspec/extensions/litestar/migrations/__init__.py +3 -0
  197. sqlspec/extensions/litestar/plugin.py +638 -0
  198. sqlspec/extensions/litestar/providers.py +454 -0
  199. sqlspec/extensions/litestar/store.py +265 -0
  200. sqlspec/extensions/otel/__init__.py +58 -0
  201. sqlspec/extensions/prometheus/__init__.py +107 -0
  202. sqlspec/extensions/starlette/__init__.py +10 -0
  203. sqlspec/extensions/starlette/_state.py +26 -0
  204. sqlspec/extensions/starlette/_utils.py +52 -0
  205. sqlspec/extensions/starlette/extension.py +257 -0
  206. sqlspec/extensions/starlette/middleware.py +154 -0
  207. sqlspec/loader.py +716 -0
  208. sqlspec/migrations/__init__.py +36 -0
  209. sqlspec/migrations/base.py +728 -0
  210. sqlspec/migrations/commands.py +1140 -0
  211. sqlspec/migrations/context.py +142 -0
  212. sqlspec/migrations/fix.py +203 -0
  213. sqlspec/migrations/loaders.py +450 -0
  214. sqlspec/migrations/runner.py +1024 -0
  215. sqlspec/migrations/templates.py +234 -0
  216. sqlspec/migrations/tracker.py +403 -0
  217. sqlspec/migrations/utils.py +256 -0
  218. sqlspec/migrations/validation.py +203 -0
  219. sqlspec/observability/__init__.py +22 -0
  220. sqlspec/observability/_config.py +228 -0
  221. sqlspec/observability/_diagnostics.py +67 -0
  222. sqlspec/observability/_dispatcher.py +151 -0
  223. sqlspec/observability/_observer.py +180 -0
  224. sqlspec/observability/_runtime.py +381 -0
  225. sqlspec/observability/_spans.py +158 -0
  226. sqlspec/protocols.py +530 -0
  227. sqlspec/py.typed +0 -0
  228. sqlspec/storage/__init__.py +46 -0
  229. sqlspec/storage/_utils.py +104 -0
  230. sqlspec/storage/backends/__init__.py +1 -0
  231. sqlspec/storage/backends/base.py +163 -0
  232. sqlspec/storage/backends/fsspec.py +398 -0
  233. sqlspec/storage/backends/local.py +377 -0
  234. sqlspec/storage/backends/obstore.py +580 -0
  235. sqlspec/storage/errors.py +104 -0
  236. sqlspec/storage/pipeline.py +604 -0
  237. sqlspec/storage/registry.py +289 -0
  238. sqlspec/typing.py +219 -0
  239. sqlspec/utils/__init__.py +31 -0
  240. sqlspec/utils/arrow_helpers.py +95 -0
  241. sqlspec/utils/config_resolver.py +153 -0
  242. sqlspec/utils/correlation.py +132 -0
  243. sqlspec/utils/data_transformation.py +114 -0
  244. sqlspec/utils/dependencies.py +79 -0
  245. sqlspec/utils/deprecation.py +113 -0
  246. sqlspec/utils/fixtures.py +250 -0
  247. sqlspec/utils/logging.py +172 -0
  248. sqlspec/utils/module_loader.py +273 -0
  249. sqlspec/utils/portal.py +325 -0
  250. sqlspec/utils/schema.py +288 -0
  251. sqlspec/utils/serializers.py +396 -0
  252. sqlspec/utils/singleton.py +41 -0
  253. sqlspec/utils/sync_tools.py +277 -0
  254. sqlspec/utils/text.py +108 -0
  255. sqlspec/utils/type_converters.py +99 -0
  256. sqlspec/utils/type_guards.py +1324 -0
  257. sqlspec/utils/version.py +444 -0
  258. sqlspec-0.32.0.dist-info/METADATA +202 -0
  259. sqlspec-0.32.0.dist-info/RECORD +262 -0
  260. sqlspec-0.32.0.dist-info/WHEEL +4 -0
  261. sqlspec-0.32.0.dist-info/entry_points.txt +2 -0
  262. sqlspec-0.32.0.dist-info/licenses/LICENSE +21 -0
@@ -0,0 +1,900 @@
1
+ # ruff: noqa: FBT003
2
+ """Base query builder with validation and parameter binding.
3
+
4
+ Provides abstract base classes and core functionality for SQL query builders.
5
+ """
6
+
7
+ import hashlib
8
+ import uuid
9
+ from abc import ABC, abstractmethod
10
+ from collections.abc import Callable
11
+ from typing import TYPE_CHECKING, Any, NoReturn, cast
12
+
13
+ import sqlglot
14
+ from sqlglot import Dialect, exp
15
+ from sqlglot.dialects.dialect import DialectType
16
+ from sqlglot.errors import ParseError as SQLGlotParseError
17
+ from sqlglot.optimizer import optimize
18
+ from typing_extensions import Self
19
+
20
+ from sqlspec.core import (
21
+ SQL,
22
+ ParameterStyle,
23
+ ParameterStyleConfig,
24
+ StatementConfig,
25
+ get_cache,
26
+ get_cache_config,
27
+ hash_optimized_expression,
28
+ )
29
+ from sqlspec.exceptions import SQLBuilderError
30
+ from sqlspec.utils.logging import get_logger
31
+ from sqlspec.utils.type_guards import has_expression_and_parameters, has_with_method, is_expression
32
+
33
+ if TYPE_CHECKING:
34
+ from sqlspec.core import SQLResult
35
+
36
+ __all__ = ("QueryBuilder", "SafeQuery")
37
+
38
+ MAX_PARAMETER_COLLISION_ATTEMPTS = 1000
39
+
40
+ logger = get_logger(__name__)
41
+
42
+
43
+ class SafeQuery:
44
+ """SQL query with bound parameters."""
45
+
46
+ __slots__ = ("dialect", "parameters", "sql")
47
+
48
+ def __init__(self, sql: str, parameters: dict[str, Any] | None = None, dialect: DialectType | None = None) -> None:
49
+ self.sql = sql
50
+ self.parameters = parameters if parameters is not None else {}
51
+ self.dialect = dialect
52
+
53
+ def __repr__(self) -> str:
54
+ parameter_keys = sorted(self.parameters.keys())
55
+ return f"SafeQuery(sql={self.sql!r}, parameters={parameter_keys!r}, dialect={self.dialect!r})"
56
+
57
+ def __eq__(self, other: object) -> bool:
58
+ if not isinstance(other, SafeQuery):
59
+ return NotImplemented
60
+ return self.sql == other.sql and self.parameters == other.parameters and self.dialect == other.dialect
61
+
62
+ def __hash__(self) -> int:
63
+ return hash((self.sql, frozenset(self.parameters.items()), self.dialect))
64
+
65
+
66
+ class QueryBuilder(ABC):
67
+ """Abstract base class for SQL query builders.
68
+
69
+ Provides common functionality for dialect handling, parameter management,
70
+ and query construction using SQLGlot.
71
+ """
72
+
73
+ __slots__ = (
74
+ "_expression",
75
+ "_lock_targets_quoted",
76
+ "_merge_target_quoted",
77
+ "_parameter_counter",
78
+ "_parameter_name_counters",
79
+ "_parameters",
80
+ "_with_ctes",
81
+ "dialect",
82
+ "enable_optimization",
83
+ "optimize_joins",
84
+ "optimize_predicates",
85
+ "schema",
86
+ "simplify_expressions",
87
+ )
88
+
89
+ def __init__(
90
+ self,
91
+ dialect: DialectType | None = None,
92
+ schema: dict[str, dict[str, str]] | None = None,
93
+ enable_optimization: bool = True,
94
+ optimize_joins: bool = True,
95
+ optimize_predicates: bool = True,
96
+ simplify_expressions: bool = True,
97
+ ) -> None:
98
+ self.dialect = dialect
99
+ self.schema = schema
100
+ self.enable_optimization = enable_optimization
101
+ self.optimize_joins = optimize_joins
102
+ self.optimize_predicates = optimize_predicates
103
+ self.simplify_expressions = simplify_expressions
104
+
105
+ self._expression: exp.Expression | None = None
106
+ self._parameter_name_counters: dict[str, int] = {}
107
+ self._parameters: dict[str, Any] = {}
108
+ self._parameter_counter: int = 0
109
+ self._with_ctes: dict[str, exp.CTE] = {}
110
+ self._lock_targets_quoted = False
111
+ self._merge_target_quoted = False
112
+
113
+ def _initialize_expression(self) -> None:
114
+ """Initialize the base expression. Called after __init__."""
115
+ self._expression = self._create_base_expression()
116
+ if not self._expression:
117
+ self._raise_sql_builder_error(
118
+ "QueryBuilder._create_base_expression must return a valid sqlglot expression."
119
+ )
120
+
121
+ def get_expression(self) -> exp.Expression | None:
122
+ """Get expression reference (no copy).
123
+
124
+ Returns:
125
+ The current SQLGlot expression or None if not set
126
+ """
127
+ return self._expression
128
+
129
+ def set_expression(self, expression: exp.Expression) -> None:
130
+ """Set expression with validation.
131
+
132
+ Args:
133
+ expression: SQLGlot expression to set
134
+ """
135
+ if not is_expression(expression):
136
+ self._raise_invalid_expression_type(expression)
137
+ self._expression = expression
138
+
139
+ def has_expression(self) -> bool:
140
+ """Check if expression exists.
141
+
142
+ Returns:
143
+ True if expression is set, False otherwise
144
+ """
145
+ return self._expression is not None
146
+
147
+ @abstractmethod
148
+ def _create_base_expression(self) -> exp.Expression:
149
+ """Create the base sqlglot expression for the specific query type.
150
+
151
+ Returns:
152
+ A new sqlglot expression appropriate for the query type.
153
+ """
154
+
155
+ @property
156
+ @abstractmethod
157
+ def _expected_result_type(self) -> "type[SQLResult]":
158
+ """The expected result type for the query being built.
159
+
160
+ Returns:
161
+ type[ResultT]: The type of the result.
162
+ """
163
+
164
+ @staticmethod
165
+ def _raise_sql_builder_error(message: str, cause: BaseException | None = None) -> NoReturn:
166
+ """Helper to raise SQLBuilderError, potentially with a cause.
167
+
168
+ Args:
169
+ message: The error message.
170
+ cause: The optional original exception to chain.
171
+
172
+ Raises:
173
+ SQLBuilderError: Always raises this exception.
174
+ """
175
+ raise SQLBuilderError(message) from cause
176
+
177
+ @staticmethod
178
+ def _raise_invalid_expression_type(expression: Any) -> NoReturn:
179
+ """Raise error for invalid expression type.
180
+
181
+ Args:
182
+ expression: The invalid expression object
183
+
184
+ Raises:
185
+ TypeError: Always raised for type mismatch
186
+ """
187
+ msg = f"Expected Expression, got {type(expression)}"
188
+ raise TypeError(msg)
189
+
190
+ @staticmethod
191
+ def _raise_cte_query_error(alias: str, message: str) -> NoReturn:
192
+ """Raise error for CTE query issues.
193
+
194
+ Args:
195
+ alias: CTE alias name
196
+ message: Specific error message
197
+
198
+ Raises:
199
+ SQLBuilderError: Always raised for CTE errors
200
+ """
201
+ msg = f"CTE '{alias}': {message}"
202
+ raise SQLBuilderError(msg)
203
+
204
+ @staticmethod
205
+ def _raise_cte_parse_error(cause: BaseException) -> NoReturn:
206
+ """Raise error for CTE parsing failures.
207
+
208
+ Args:
209
+ cause: The original parsing exception
210
+
211
+ Raises:
212
+ SQLBuilderError: Always raised with chained cause
213
+ """
214
+ msg = f"Failed to parse CTE query: {cause!s}"
215
+ raise SQLBuilderError(msg) from cause
216
+
217
+ def _build_final_expression(self, *, copy: bool = False) -> exp.Expression:
218
+ """Construct the current expression with attached CTEs.
219
+
220
+ Args:
221
+ copy: Whether to copy the underlying expression tree before
222
+ applying transformations.
223
+
224
+ Returns:
225
+ Expression representing the current builder state with CTEs applied.
226
+ """
227
+ if self._expression is None:
228
+ self._raise_sql_builder_error("QueryBuilder expression not initialized.")
229
+
230
+ base_expression = self._expression.copy() if copy or self._with_ctes else self._expression
231
+
232
+ if not self._with_ctes:
233
+ return base_expression
234
+
235
+ final_expression: exp.Expression = base_expression
236
+ if has_with_method(final_expression):
237
+ for alias, cte_node in self._with_ctes.items():
238
+ final_expression = cast("Any", final_expression).with_(cte_node.args["this"], as_=alias, copy=False)
239
+ return cast("exp.Expression", final_expression)
240
+
241
+ if isinstance(final_expression, (exp.Select, exp.Insert, exp.Update, exp.Delete, exp.Union)):
242
+ return exp.With(expressions=list(self._with_ctes.values()), this=final_expression)
243
+
244
+ return final_expression
245
+
246
+ def _spawn_like_self(self: Self) -> Self:
247
+ """Create a new builder instance with matching configuration."""
248
+ return type(self)(
249
+ dialect=self.dialect,
250
+ schema=self.schema,
251
+ enable_optimization=self.enable_optimization,
252
+ optimize_joins=self.optimize_joins,
253
+ optimize_predicates=self.optimize_predicates,
254
+ simplify_expressions=self.simplify_expressions,
255
+ )
256
+
257
+ def _resolve_cte_query(self, alias: str, query: "QueryBuilder | exp.Select | str") -> exp.Select:
258
+ """Resolve a CTE query into a Select expression with merged parameters."""
259
+ if isinstance(query, QueryBuilder):
260
+ query_expr = query.get_expression()
261
+ if query_expr is None:
262
+ self._raise_cte_query_error(alias, "query builder has no expression")
263
+ if not isinstance(query_expr, exp.Select):
264
+ self._raise_cte_query_error(alias, f"expression must be a Select, got {type(query_expr).__name__}")
265
+ cte_select_expression = query_expr.copy()
266
+ param_mapping = self._merge_cte_parameters(alias, query.parameters)
267
+ updated_expression = self._update_placeholders_in_expression(cte_select_expression, param_mapping)
268
+ if not isinstance(updated_expression, exp.Select): # pragma: no cover - defensive
269
+ msg = "CTE placeholder update produced non-select expression"
270
+ raise SQLBuilderError(msg)
271
+ return updated_expression
272
+
273
+ if isinstance(query, str):
274
+ try:
275
+ parsed_expression = sqlglot.parse_one(query, read=self.dialect_name)
276
+ except SQLGlotParseError as e: # pragma: no cover - defensive
277
+ self._raise_cte_parse_error(e)
278
+ if not isinstance(parsed_expression, exp.Select):
279
+ self._raise_cte_query_error(
280
+ alias, f"query string must parse to SELECT, got {type(parsed_expression).__name__}"
281
+ )
282
+ return parsed_expression
283
+
284
+ if isinstance(query, exp.Select):
285
+ return query
286
+
287
+ self._raise_cte_query_error(alias, f"invalid query type: {type(query).__name__}")
288
+ msg = "Unreachable"
289
+ raise AssertionError(msg)
290
+
291
+ def _add_parameter(self, value: Any, context: str | None = None) -> str:
292
+ """Adds a parameter to the query and returns its placeholder name.
293
+
294
+ Args:
295
+ value: The value of the parameter.
296
+ context: Optional context hint for parameter naming (e.g., "where", "join")
297
+
298
+ Returns:
299
+ str: The placeholder name for the parameter (e.g., :param_1 or :where_param_1).
300
+ """
301
+ self._parameter_counter += 1
302
+
303
+ param_name = f"{context}_param_{self._parameter_counter}" if context else f"param_{self._parameter_counter}"
304
+
305
+ self._parameters[param_name] = value
306
+ return param_name
307
+
308
+ def _parameterize_expression(self, expression: exp.Expression) -> exp.Expression:
309
+ """Replace literal values in an expression with bound parameters.
310
+
311
+ This method traverses a SQLGlot expression tree and replaces literal
312
+ values with parameter placeholders, adding the values to the builder's
313
+ parameter collection.
314
+
315
+ Args:
316
+ expression: The SQLGlot expression to parameterize
317
+
318
+ Returns:
319
+ A new expression with literals replaced by parameter placeholders
320
+ """
321
+
322
+ from sqlspec.builder._vector_expressions import VectorDistance
323
+
324
+ def replacer(node: exp.Expression) -> exp.Expression:
325
+ if isinstance(node, exp.Literal):
326
+ if node.this in {True, False, None}:
327
+ return node
328
+
329
+ parent = node.parent
330
+ if isinstance(parent, exp.Array) and node.find_ancestor(VectorDistance) is not None:
331
+ return node
332
+
333
+ value = node.this
334
+ if node.is_number and isinstance(node.this, str):
335
+ try:
336
+ value = float(node.this) if "." in node.this or "e" in node.this.lower() else int(node.this)
337
+ except ValueError:
338
+ value = node.this
339
+
340
+ param_name = self._add_parameter(value, context="where")
341
+ return exp.Placeholder(this=param_name)
342
+ return node
343
+
344
+ return expression.transform(replacer, copy=False)
345
+
346
+ def add_parameter(self: Self, value: Any, name: str | None = None) -> tuple[Self, str]:
347
+ """Explicitly adds a parameter to the query.
348
+
349
+ This is useful for parameters that are not directly tied to a
350
+ builder method like `where` or `values`.
351
+
352
+ Args:
353
+ value: The value of the parameter.
354
+ name: Optional explicit name for the parameter. If None, a name
355
+ will be generated.
356
+
357
+ Returns:
358
+ tuple[Self, str]: The builder instance and the parameter name.
359
+ """
360
+ if name:
361
+ if name in self._parameters:
362
+ self._raise_sql_builder_error(f"Parameter name '{name}' already exists.")
363
+ self._parameters[name] = value
364
+ return self, name
365
+
366
+ self._parameter_counter += 1
367
+ param_name = f"param_{self._parameter_counter}"
368
+ self._parameters[param_name] = value
369
+ return self, param_name
370
+
371
+ def _generate_unique_parameter_name(self, base_name: str) -> str:
372
+ """Generate unique parameter name when collision occurs.
373
+
374
+ Args:
375
+ base_name: The desired base name for the parameter
376
+
377
+ Returns:
378
+ A unique parameter name that doesn't exist in current parameters
379
+ """
380
+ current_index = self._parameter_name_counters.get(base_name, 0)
381
+
382
+ if base_name not in self._parameters:
383
+ # First use keeps the base name, counter stays at 0
384
+ self._parameter_name_counters[base_name] = current_index
385
+ return base_name
386
+
387
+ next_index = current_index + 1
388
+ candidate = f"{base_name}_{next_index}"
389
+
390
+ while candidate in self._parameters:
391
+ next_index += 1
392
+ if next_index > MAX_PARAMETER_COLLISION_ATTEMPTS:
393
+ return f"{base_name}_{uuid.uuid4().hex[:8]}"
394
+ candidate = f"{base_name}_{next_index}"
395
+
396
+ self._parameter_name_counters[base_name] = next_index
397
+ return candidate
398
+
399
+ def _create_placeholder(self, value: Any, base_name: str) -> tuple[exp.Placeholder, str]:
400
+ """Backwards-compatible placeholder helper (delegates to create_placeholder)."""
401
+ return self.create_placeholder(value, base_name)
402
+
403
+ def create_placeholder(self, value: Any, base_name: str) -> tuple[exp.Placeholder, str]:
404
+ """Create placeholder expression with a unique parameter name.
405
+
406
+ Args:
407
+ value: Parameter value to bind.
408
+ base_name: Seed for parameter naming.
409
+
410
+ Returns:
411
+ Tuple of placeholder expression and the final parameter name.
412
+ """
413
+ param_name = self._generate_unique_parameter_name(base_name)
414
+ _, param_name = self.add_parameter(value, name=param_name)
415
+ return exp.Placeholder(this=param_name), param_name
416
+
417
+ def _merge_cte_parameters(self, cte_name: str, parameters: dict[str, Any]) -> dict[str, str]:
418
+ """Merge CTE parameters with unique naming to prevent collisions.
419
+
420
+ Args:
421
+ cte_name: The name of the CTE for parameter prefixing
422
+ parameters: The CTE's parameter dictionary
423
+
424
+ Returns:
425
+ Mapping of old parameter names to new unique names
426
+ """
427
+ param_mapping = {}
428
+ for old_name, value in parameters.items():
429
+ new_name = self._generate_unique_parameter_name(f"{cte_name}_{old_name}")
430
+ param_mapping[old_name] = new_name
431
+ self.add_parameter(value, name=new_name)
432
+ return param_mapping
433
+
434
+ def _update_placeholders_in_expression(
435
+ self, expression: exp.Expression, param_mapping: dict[str, str]
436
+ ) -> exp.Expression:
437
+ """Update parameter placeholders in expression to use new names.
438
+
439
+ Args:
440
+ expression: The SQLGlot expression to update
441
+ param_mapping: Mapping of old parameter names to new names
442
+
443
+ Returns:
444
+ Updated expression with new placeholder names
445
+ """
446
+
447
+ def placeholder_replacer(node: exp.Expression) -> exp.Expression:
448
+ if isinstance(node, exp.Placeholder) and str(node.this) in param_mapping:
449
+ return exp.Placeholder(this=param_mapping[str(node.this)])
450
+ return node
451
+
452
+ return expression.transform(placeholder_replacer, copy=False)
453
+
454
+ def _generate_builder_cache_key(self, config: "StatementConfig | None" = None) -> str:
455
+ """Generate cache key based on builder state and configuration.
456
+
457
+ Args:
458
+ config: Optional SQL configuration that affects the generated SQL
459
+
460
+ Returns:
461
+ A unique cache key representing the builder state and configuration
462
+ """
463
+ dialect_name: str = self.dialect_name or "default"
464
+
465
+ if self._expression is None:
466
+ self._expression = self._create_base_expression()
467
+
468
+ expr_sql: str = self._expression.sql() if self._expression else "None"
469
+ parameters_snapshot = sorted(self._parameters.items())
470
+ parameters_hash = hashlib.sha256(str(parameters_snapshot).encode()).hexdigest()[:8]
471
+
472
+ state_parts = [
473
+ f"expression:{expr_sql}",
474
+ f"parameters_hash:{parameters_hash}",
475
+ f"ctes:{sorted(self._with_ctes.keys())}",
476
+ f"dialect:{dialect_name}",
477
+ f"schema_hash:{hashlib.sha256(str(self.schema).encode()).hexdigest()[:8]}",
478
+ f"optimization:{self.enable_optimization}",
479
+ f"optimize_joins:{self.optimize_joins}",
480
+ f"optimize_predicates:{self.optimize_predicates}",
481
+ f"simplify_expressions:{self.simplify_expressions}",
482
+ ]
483
+
484
+ if config:
485
+ config_parts = [
486
+ f"config_dialect:{config.dialect or 'default'}",
487
+ f"enable_parsing:{config.enable_parsing}",
488
+ f"enable_validation:{config.enable_validation}",
489
+ f"enable_transformations:{config.enable_transformations}",
490
+ f"enable_analysis:{config.enable_analysis}",
491
+ f"enable_caching:{config.enable_caching}",
492
+ f"param_style:{config.parameter_config.default_parameter_style.value}",
493
+ ]
494
+ state_parts.extend(config_parts)
495
+
496
+ state_string = "|".join(state_parts)
497
+ return f"builder:{hashlib.sha256(state_string.encode()).hexdigest()[:16]}"
498
+
499
+ def with_cte(self: Self, alias: str, query: "QueryBuilder | exp.Select | str") -> Self:
500
+ """Adds a Common Table Expression (CTE) to the query.
501
+
502
+ Args:
503
+ alias: The alias for the CTE.
504
+ query: The CTE query, which can be another QueryBuilder instance,
505
+ a raw SQL string, or a sqlglot Select expression.
506
+
507
+ Returns:
508
+ Self: The current builder instance for method chaining.
509
+ """
510
+ if alias in self._with_ctes:
511
+ self._raise_sql_builder_error(f"CTE with alias '{alias}' already exists.")
512
+
513
+ cte_select_expression = self._resolve_cte_query(alias, query)
514
+ self._with_ctes[alias] = exp.CTE(this=cte_select_expression, alias=exp.to_table(alias))
515
+ return self
516
+
517
+ def build(self, dialect: DialectType = None) -> "SafeQuery":
518
+ """Builds the SQL query string and parameters.
519
+
520
+ Args:
521
+ dialect: Optional dialect override. If provided, generates SQL for this dialect
522
+ instead of the builder's default dialect.
523
+
524
+ Returns:
525
+ SafeQuery: A dataclass containing the SQL string and parameters.
526
+
527
+ Examples:
528
+ # Use builder's default dialect
529
+ query = sql.select("*").from_("products")
530
+ result = query.build()
531
+
532
+ # Override dialect at build time
533
+ postgres_sql = query.build(dialect="postgres")
534
+ mysql_sql = query.build(dialect="mysql")
535
+ """
536
+ final_expression = self._build_final_expression()
537
+
538
+ if self.enable_optimization and isinstance(final_expression, exp.Expression):
539
+ final_expression = self._optimize_expression(final_expression)
540
+
541
+ target_dialect = str(dialect) if dialect else self.dialect_name
542
+
543
+ try:
544
+ if isinstance(final_expression, exp.Expression):
545
+ normalized_expression = (
546
+ self._unquote_identifiers_for_oracle(final_expression)
547
+ if self._is_oracle_dialect(target_dialect)
548
+ else final_expression
549
+ )
550
+ identify = self._should_identify(target_dialect)
551
+ sql_string = normalized_expression.sql(dialect=target_dialect, pretty=True, identify=identify)
552
+ sql_string = self._strip_lock_identifier_quotes(sql_string)
553
+ else:
554
+ sql_string = str(final_expression)
555
+ except Exception as e:
556
+ err_msg = f"Error generating SQL from expression: {e!s}"
557
+ logger.exception("SQL generation failed")
558
+ self._raise_sql_builder_error(err_msg, e)
559
+
560
+ return SafeQuery(sql=sql_string, parameters=self._parameters.copy(), dialect=dialect or self.dialect)
561
+
562
+ def to_sql(self, show_parameters: bool = False, dialect: DialectType = None) -> str:
563
+ """Return SQL string with optional parameter substitution.
564
+
565
+ Args:
566
+ show_parameters: If True, replace parameter placeholders with actual values (for debugging).
567
+ If False (default), return SQL with parameter placeholders.
568
+ dialect: Optional dialect override. If provided, generates SQL for this dialect
569
+ instead of the builder's default dialect.
570
+
571
+ Returns:
572
+ SQL string with or without parameter values filled in
573
+
574
+ Examples:
575
+ Get SQL with placeholders (for execution):
576
+ sql_str = query.to_sql()
577
+ # "SELECT * FROM products WHERE id = :id"
578
+
579
+ Get SQL with values (for debugging):
580
+ sql_str = query.to_sql(show_parameters=True)
581
+ # "SELECT * FROM products WHERE id = 123"
582
+
583
+ Override dialect at output time:
584
+ postgres_sql = query.to_sql(dialect="postgres")
585
+ mysql_sql = query.to_sql(dialect="mysql")
586
+
587
+ Warning:
588
+ SQL with show_parameters=True is for debugging ONLY.
589
+ Never execute SQL with interpolated parameters directly - use parameterized queries.
590
+ """
591
+ safe_query = self.build(dialect=dialect)
592
+
593
+ if not show_parameters:
594
+ return safe_query.sql
595
+
596
+ sql = safe_query.sql
597
+ parameters = safe_query.parameters
598
+
599
+ for param_name, param_value in parameters.items():
600
+ placeholder = f":{param_name}"
601
+ if isinstance(param_value, str):
602
+ replacement = f"'{param_value}'"
603
+ elif param_value is None:
604
+ replacement = "NULL"
605
+ elif isinstance(param_value, bool):
606
+ replacement = "TRUE" if param_value else "FALSE"
607
+ else:
608
+ replacement = str(param_value)
609
+
610
+ sql = sql.replace(placeholder, replacement)
611
+
612
+ return sql
613
+
614
+ def _optimize_expression(self, expression: exp.Expression) -> exp.Expression:
615
+ """Apply SQLGlot optimizations to the expression.
616
+
617
+ Args:
618
+ expression: The expression to optimize
619
+
620
+ Returns:
621
+ The optimized expression
622
+ """
623
+ if not self.enable_optimization:
624
+ return expression
625
+
626
+ if not self.optimize_joins and not self.optimize_predicates and not self.simplify_expressions:
627
+ return expression
628
+
629
+ optimizer_settings = {
630
+ "optimize_joins": self.optimize_joins,
631
+ "pushdown_predicates": self.optimize_predicates,
632
+ "simplify_expressions": self.simplify_expressions,
633
+ }
634
+
635
+ dialect_name = self.dialect_name or "default"
636
+ cache_key = hash_optimized_expression(
637
+ expression, dialect=dialect_name, schema=self.schema, optimizer_settings=optimizer_settings
638
+ )
639
+
640
+ cache = get_cache()
641
+ cached_optimized = cache.get("optimized", cache_key)
642
+ if cached_optimized:
643
+ return cast("exp.Expression", cached_optimized)
644
+
645
+ try:
646
+ optimized = optimize(
647
+ expression, schema=self.schema, dialect=self.dialect_name, optimizer_settings=optimizer_settings
648
+ )
649
+ cache.put("optimized", cache_key, optimized)
650
+ except Exception:
651
+ logger.debug("Expression optimization failed, using original expression")
652
+ return expression
653
+ else:
654
+ return optimized
655
+
656
+ def to_statement(self, config: "StatementConfig | None" = None) -> "SQL":
657
+ """Converts the built query into a SQL statement object.
658
+
659
+ Args:
660
+ config: Optional SQL configuration.
661
+
662
+ Returns:
663
+ SQL: A SQL statement object.
664
+ """
665
+ cache_config = get_cache_config()
666
+ if not cache_config.compiled_cache_enabled:
667
+ return self._to_statement(config)
668
+
669
+ cache_key_str = self._generate_builder_cache_key(config)
670
+
671
+ cache = get_cache()
672
+ cached_sql = cache.get("builder", cache_key_str)
673
+ if cached_sql is not None:
674
+ return cast("SQL", cached_sql)
675
+
676
+ sql_statement = self._to_statement(config)
677
+ cache.put("builder", cache_key_str, sql_statement)
678
+
679
+ return sql_statement
680
+
681
+ def _to_statement(self, config: "StatementConfig | None" = None) -> "SQL":
682
+ """Internal method to create SQL statement.
683
+
684
+ Args:
685
+ config: Optional SQL configuration.
686
+
687
+ Returns:
688
+ SQL: A SQL statement object.
689
+ """
690
+ dialect_override = config.dialect if config else None
691
+ safe_query = self.build(dialect=dialect_override)
692
+
693
+ kwargs, parameters = self._extract_statement_parameters(safe_query.parameters)
694
+
695
+ if config is None:
696
+ config = StatementConfig(
697
+ parameter_config=ParameterStyleConfig(
698
+ default_parameter_style=ParameterStyle.QMARK, supported_parameter_styles={ParameterStyle.QMARK}
699
+ ),
700
+ dialect=safe_query.dialect,
701
+ )
702
+
703
+ sql_string = safe_query.sql
704
+ if (
705
+ config.dialect is not None
706
+ and config.dialect != safe_query.dialect
707
+ and isinstance(self._expression, exp.Expression)
708
+ ):
709
+ try:
710
+ identify = self._should_identify(config.dialect)
711
+ sql_string = self._expression.sql(dialect=config.dialect, pretty=True, identify=identify)
712
+ except Exception:
713
+ sql_string = safe_query.sql
714
+
715
+ if kwargs:
716
+ return SQL(sql_string, statement_config=config, **kwargs)
717
+ if parameters:
718
+ return SQL(sql_string, *parameters, statement_config=config)
719
+ return SQL(sql_string, statement_config=config)
720
+
721
+ def _extract_statement_parameters(
722
+ self, raw_parameters: Any
723
+ ) -> "tuple[dict[str, Any] | None, tuple[Any, ...] | None]":
724
+ """Extract parameters for SQL statement creation.
725
+
726
+ Args:
727
+ raw_parameters: Raw parameter data from SafeQuery
728
+
729
+ Returns:
730
+ Tuple of (kwargs, parameters) for SQL statement construction
731
+ """
732
+ if isinstance(raw_parameters, dict):
733
+ return raw_parameters, None
734
+
735
+ if isinstance(raw_parameters, tuple):
736
+ return None, raw_parameters
737
+
738
+ if raw_parameters:
739
+ return None, tuple(raw_parameters)
740
+
741
+ return None, None
742
+
743
+ def __str__(self) -> str:
744
+ """Return the SQL string representation of the query.
745
+
746
+ Returns:
747
+ str: The SQL string for this query.
748
+ """
749
+ return self.build().sql
750
+
751
+ @property
752
+ def dialect_name(self) -> "str | None":
753
+ """Returns the name of the dialect, if set."""
754
+ if isinstance(self.dialect, str):
755
+ return self.dialect
756
+ if self.dialect is None:
757
+ return None
758
+ if isinstance(self.dialect, type) and issubclass(self.dialect, Dialect):
759
+ return self.dialect.__name__.lower()
760
+ if isinstance(self.dialect, Dialect):
761
+ return type(self.dialect).__name__.lower()
762
+ return getattr(self.dialect, "__name__", str(self.dialect)).lower()
763
+
764
+ def _merge_sql_object_parameters(self, sql_obj: Any) -> None:
765
+ """Merge parameters from a SQL object into the builder.
766
+
767
+ Args:
768
+ sql_obj: Object with parameters attribute containing parameter mappings
769
+ """
770
+ if not has_expression_and_parameters(sql_obj):
771
+ return
772
+
773
+ sql_parameters = getattr(sql_obj, "parameters", {})
774
+ for param_name, param_value in sql_parameters.items():
775
+ unique_name = self._generate_unique_parameter_name(param_name)
776
+ self.add_parameter(param_value, name=unique_name)
777
+
778
+ @property
779
+ def parameters(self) -> dict[str, Any]:
780
+ """Public access to query parameters."""
781
+ return self._parameters
782
+
783
+ def set_parameters(self, parameters: dict[str, Any]) -> None:
784
+ """Set query parameters (public API)."""
785
+ self._parameters = parameters.copy()
786
+
787
+ def _is_oracle_dialect(self, dialect: "DialectType | str | None") -> bool:
788
+ """Check if target dialect is Oracle."""
789
+ if dialect is None:
790
+ return False
791
+ return str(dialect).lower() == "oracle"
792
+
793
+ def _unquote_identifiers_for_oracle(self, expression: exp.Expression) -> exp.Expression:
794
+ """Remove identifier quoting to avoid Oracle case-sensitive lookup issues."""
795
+
796
+ def _strip(node: exp.Expression) -> exp.Expression:
797
+ if isinstance(node, exp.Identifier):
798
+ node.set("quoted", False)
799
+ return node
800
+
801
+ return expression.copy().transform(_strip, copy=False)
802
+
803
+ def _strip_lock_identifier_quotes(self, sql_string: str) -> str:
804
+ for keyword in ("FOR UPDATE OF ", "FOR SHARE OF "):
805
+ if keyword in sql_string and not self._lock_targets_quoted:
806
+ head, tail = sql_string.split(keyword, 1)
807
+ tail = tail.replace('"', "")
808
+ return f"{head}{keyword}{tail}"
809
+ if sql_string.startswith('MERGE INTO "') and not self._merge_target_quoted:
810
+ # Remove quotes around target table only, leave alias/rest intact
811
+ end_quote = sql_string.find('"', len('MERGE INTO "'))
812
+ if end_quote > 0:
813
+ table_name = sql_string[len('MERGE INTO "') : end_quote]
814
+ remainder = sql_string[end_quote + 1 :]
815
+ return f"MERGE INTO {table_name}{remainder}"
816
+ return sql_string
817
+
818
+ def _should_identify(self, dialect: "DialectType | str | None") -> bool:
819
+ """Determine whether to quote identifiers for the given dialect."""
820
+ if dialect is None:
821
+ return True
822
+ dialect_name = str(dialect).lower()
823
+ # Oracle folds unquoted identifiers to uppercase; quoting lower-case breaks table lookup
824
+ return dialect_name != "oracle"
825
+
826
+ @property
827
+ def with_ctes(self) -> "dict[str, exp.CTE]":
828
+ """Get WITH clause CTEs (public API)."""
829
+ return dict(self._with_ctes)
830
+
831
+ def generate_unique_parameter_name(self, base_name: str) -> str:
832
+ """Generate unique parameter name (public API)."""
833
+ return self._generate_unique_parameter_name(base_name)
834
+
835
+ def build_static_expression(
836
+ self,
837
+ expression: exp.Expression | None = None,
838
+ parameters: dict[str, Any] | None = None,
839
+ *,
840
+ cache_key: str | None = None,
841
+ expression_factory: Callable[[], exp.Expression] | None = None,
842
+ copy: bool = True,
843
+ optimize_expression: bool | None = None,
844
+ dialect: DialectType | None = None,
845
+ ) -> "SafeQuery":
846
+ """Compile a pre-built expression with optional caching and parameters.
847
+
848
+ Designed for hot paths that construct an AST once and reuse it with
849
+ different parameters, avoiding repeated parse/optimize cycles.
850
+
851
+ Args:
852
+ expression: Pre-built sqlglot expression to render (required when cache_key is not provided).
853
+ parameters: Optional parameter mapping to include in the result.
854
+ cache_key: When provided, the expression will be cached under this key.
855
+ expression_factory: Factory used to build the expression on cache miss.
856
+ copy: Copy the expression before rendering to avoid caller mutation.
857
+ optimize_expression: Override builder optimization toggle for this call.
858
+ dialect: Optional dialect override for SQL generation.
859
+
860
+ Returns:
861
+ SafeQuery containing SQL and parameters.
862
+ """
863
+
864
+ expr: exp.Expression | None = None
865
+
866
+ if cache_key is not None:
867
+ cache = get_cache()
868
+ cached_expr = cache.get("static_expression", cache_key)
869
+ if cached_expr is None:
870
+ if expression_factory is None:
871
+ msg = "expression_factory is required when cache_key is provided"
872
+ self._raise_sql_builder_error(msg)
873
+ expr_candidate = expression_factory()
874
+ if not is_expression(expr_candidate):
875
+ self._raise_invalid_expression_type(expr_candidate)
876
+ expr_to_store = expr_candidate.copy() if copy else expr_candidate
877
+ should_optimize = self.enable_optimization if optimize_expression is None else optimize_expression
878
+ if should_optimize:
879
+ expr_to_store = self._optimize_expression(expr_to_store)
880
+ cache.put("static_expression", cache_key, expr_to_store)
881
+ cached_expr = expr_to_store
882
+ expr = cached_expr.copy() if copy else cached_expr
883
+ else:
884
+ if expression is None:
885
+ msg = "expression must be provided when cache_key is not set"
886
+ self._raise_sql_builder_error(msg)
887
+ expr = expression.copy() if copy else expression
888
+ should_optimize = self.enable_optimization if optimize_expression is None else optimize_expression
889
+ if should_optimize:
890
+ expr = self._optimize_expression(expr)
891
+
892
+ if expr is None:
893
+ self._raise_sql_builder_error("Static expression could not be resolved.")
894
+
895
+ target_dialect = str(dialect) if dialect else self.dialect_name
896
+ identify = self._should_identify(target_dialect)
897
+ sql_string = expr.sql(dialect=target_dialect, pretty=True, identify=identify)
898
+ return SafeQuery(
899
+ sql=sql_string, parameters=parameters.copy() if parameters else {}, dialect=dialect or self.dialect
900
+ )