-
Notifications
You must be signed in to change notification settings - Fork 174
/
impl.py
421 lines (357 loc) · 15.5 KB
/
impl.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
from dataclasses import dataclass
from typing import Mapping, Any, Optional, List, Union, Dict, FrozenSet, Tuple, TYPE_CHECKING
from dbt.adapters.base.impl import AdapterConfig, ConstraintSupport
from dbt.adapters.base.meta import available
from dbt.adapters.capability import CapabilityDict, CapabilitySupport, Support, Capability
from dbt.adapters.sql import SQLAdapter
from dbt.adapters.sql.impl import (
LIST_SCHEMAS_MACRO_NAME,
LIST_RELATIONS_MACRO_NAME,
)
from dbt_common.behavior_flags import BehaviorFlag
from dbt_common.contracts.constraints import ConstraintType
from dbt_common.contracts.metadata import (
TableMetadata,
StatsDict,
StatsItem,
CatalogTable,
ColumnMetadata,
)
from dbt_common.exceptions import CompilationError, DbtDatabaseError, DbtRuntimeError
from dbt_common.utils import filter_null_values
from dbt.adapters.snowflake.relation_configs import (
SnowflakeRelationType,
TableFormat,
)
from dbt.adapters.snowflake import SnowflakeColumn
from dbt.adapters.snowflake import SnowflakeConnectionManager
from dbt.adapters.snowflake import SnowflakeRelation
if TYPE_CHECKING:
import agate
SHOW_OBJECT_METADATA_MACRO_NAME = "snowflake__show_object_metadata"
@dataclass
class SnowflakeConfig(AdapterConfig):
transient: Optional[bool] = None
cluster_by: Optional[Union[str, List[str]]] = None
automatic_clustering: Optional[bool] = None
secure: Optional[bool] = None
copy_grants: Optional[bool] = None
snowflake_warehouse: Optional[str] = None
query_tag: Optional[str] = None
tmp_relation_type: Optional[str] = None
merge_update_columns: Optional[str] = None
target_lag: Optional[str] = None
# extended formats
table_format: Optional[str] = None
external_volume: Optional[str] = None
base_location_subpath: Optional[str] = None
class SnowflakeAdapter(SQLAdapter):
Relation = SnowflakeRelation
Column = SnowflakeColumn
ConnectionManager = SnowflakeConnectionManager
AdapterSpecificConfigs = SnowflakeConfig
CONSTRAINT_SUPPORT = {
ConstraintType.check: ConstraintSupport.NOT_SUPPORTED,
ConstraintType.not_null: ConstraintSupport.ENFORCED,
ConstraintType.unique: ConstraintSupport.NOT_ENFORCED,
ConstraintType.primary_key: ConstraintSupport.NOT_ENFORCED,
ConstraintType.foreign_key: ConstraintSupport.NOT_ENFORCED,
}
_capabilities: CapabilityDict = CapabilityDict(
{
Capability.SchemaMetadataByRelations: CapabilitySupport(support=Support.Full),
Capability.TableLastModifiedMetadata: CapabilitySupport(support=Support.Full),
Capability.TableLastModifiedMetadataBatch: CapabilitySupport(support=Support.Full),
Capability.GetCatalogForSingleRelation: CapabilitySupport(support=Support.Full),
}
)
@property
def _behavior_flags(self) -> List[BehaviorFlag]:
return [
{
"name": "enable_iceberg_materializations",
"default": False,
"description": (
"Enabling Iceberg materializations introduces latency to metadata queries, "
"specifically within the list_relations_without_caching macro. Since Iceberg "
"benefits only those actively using it, we've made this behavior opt-in to "
"prevent unnecessary latency for other users."
),
}
]
@classmethod
def date_function(cls):
return "CURRENT_TIMESTAMP()"
@classmethod
def _catalog_filter_table(
cls, table: "agate.Table", used_schemas: FrozenSet[Tuple[str, str]]
) -> "agate.Table":
# On snowflake, users can set QUOTED_IDENTIFIERS_IGNORE_CASE, so force
# the column names to their lowercased forms.
lowered = table.rename(column_names=[c.lower() for c in table.column_names])
return super()._catalog_filter_table(lowered, used_schemas)
def _make_match_kwargs(self, database, schema, identifier):
quoting = self.config.quoting
if identifier is not None and quoting["identifier"] is False:
identifier = identifier.upper()
if schema is not None and quoting["schema"] is False:
schema = schema.upper()
if database is not None and quoting["database"] is False:
database = database.upper()
return filter_null_values(
{"identifier": identifier, "schema": schema, "database": database}
)
def _get_warehouse(self) -> str:
_, table = self.execute("select current_warehouse() as warehouse", fetch=True)
if len(table) == 0 or len(table[0]) == 0:
# can this happen?
raise DbtRuntimeError("Could not get current warehouse: no results")
return str(table[0][0])
def _use_warehouse(self, warehouse: str):
"""Use the given warehouse. Quotes are never applied."""
self.execute("use warehouse {}".format(warehouse))
def pre_model_hook(self, config: Mapping[str, Any]) -> Optional[str]:
default_warehouse = self.config.credentials.warehouse
warehouse = config.get("snowflake_warehouse", default_warehouse)
if warehouse == default_warehouse or warehouse is None:
return None
previous = self._get_warehouse()
self._use_warehouse(warehouse)
return previous
def post_model_hook(self, config: Mapping[str, Any], context: Optional[str]) -> None:
if context is not None:
self._use_warehouse(context)
def list_schemas(self, database: str) -> List[str]:
try:
results = self.execute_macro(LIST_SCHEMAS_MACRO_NAME, kwargs={"database": database})
except DbtDatabaseError as exc:
msg = f"Database error while listing schemas in database " f'"{database}"\n{exc}'
raise DbtRuntimeError(msg)
# this uses 'show terse schemas in database', and the column name we
# want is 'name'
return [row["name"] for row in results]
def get_columns_in_relation(self, relation):
try:
return super().get_columns_in_relation(relation)
except DbtDatabaseError as exc:
if "does not exist or not authorized" in str(exc):
return []
else:
raise
def _show_object_metadata(self, relation: SnowflakeRelation) -> Optional[dict]:
try:
kwargs = {"relation": relation}
results = self.execute_macro(SHOW_OBJECT_METADATA_MACRO_NAME, kwargs=kwargs)
if len(results) == 0:
return None
return results
except DbtDatabaseError:
return None
def get_catalog_for_single_relation(
self, relation: SnowflakeRelation
) -> Optional[CatalogTable]:
object_metadata = self._show_object_metadata(relation.as_case_sensitive())
if not object_metadata:
return None
row = object_metadata[0]
is_dynamic = row.get("is_dynamic") in ("Y", "YES")
kind = row.get("kind")
if is_dynamic and kind == str(SnowflakeRelationType.Table).upper():
table_type = str(SnowflakeRelationType.DynamicTable).upper()
else:
table_type = kind
# https://docs.snowflake.com/en/sql-reference/sql/show-views#output
# Note: we don't support materialized views in dbt-snowflake
is_view = kind == str(SnowflakeRelationType.View).upper()
table_metadata = TableMetadata(
type=table_type,
schema=row.get("schema_name"),
name=row.get("name"),
database=row.get("database_name"),
comment=row.get("comment"),
owner=row.get("owner"),
)
stats_dict: StatsDict = {
"has_stats": StatsItem(
id="has_stats",
label="Has Stats?",
value=True,
include=False,
description="Indicates whether there are statistics for this table",
),
"row_count": StatsItem(
id="row_count",
label="Row Count",
value=row.get("rows"),
include=(not is_view),
description="Number of rows in the table as reported by Snowflake",
),
"bytes": StatsItem(
id="bytes",
label="Approximate Size",
value=row.get("bytes"),
include=(not is_view),
description="Size of the table as reported by Snowflake",
),
}
catalog_columns = {
c.column: ColumnMetadata(type=c.dtype, index=i + 1, name=c.column)
for i, c in enumerate(self.get_columns_in_relation(relation))
}
return CatalogTable(
metadata=table_metadata,
columns=catalog_columns,
stats=stats_dict,
)
def list_relations_without_caching(
self, schema_relation: SnowflakeRelation
) -> List[SnowflakeRelation]:
kwargs = {"schema_relation": schema_relation}
try:
schema_objects = self.execute_macro(LIST_RELATIONS_MACRO_NAME, kwargs=kwargs)
except DbtDatabaseError as exc:
# if the schema doesn't exist, we just want to return.
# Alternatively, we could query the list of schemas before we start
# and skip listing the missing ones, which sounds expensive.
if "Object does not exist" in str(exc):
return []
raise
# this can be collapsed once Snowflake adds is_iceberg to show objects
columns = ["database_name", "schema_name", "name", "kind", "is_dynamic"]
if self.behavior.enable_iceberg_materializations.no_warn:
columns.append("is_iceberg")
return [self._parse_list_relations_result(obj) for obj in schema_objects.select(columns)]
def _parse_list_relations_result(self, result: "agate.Row") -> SnowflakeRelation:
# this can be collapsed once Snowflake adds is_iceberg to show objects
if self.behavior.enable_iceberg_materializations.no_warn:
database, schema, identifier, relation_type, is_dynamic, is_iceberg = result
else:
database, schema, identifier, relation_type, is_dynamic = result
is_iceberg = "N"
try:
relation_type = self.Relation.get_relation_type(relation_type.lower())
except ValueError:
relation_type = self.Relation.External
if relation_type == self.Relation.Table and is_dynamic == "Y":
relation_type = self.Relation.DynamicTable
table_format = TableFormat.ICEBERG if is_iceberg in ("Y", "YES") else TableFormat.DEFAULT
quote_policy = {"database": True, "schema": True, "identifier": True}
return self.Relation.create(
database=database,
schema=schema,
identifier=identifier,
type=relation_type,
table_format=table_format,
quote_policy=quote_policy,
)
def quote_seed_column(self, column: str, quote_config: Optional[bool]) -> str:
quote_columns: bool = False
if isinstance(quote_config, bool):
quote_columns = quote_config
elif quote_config is None:
pass
else:
msg = (
f'The seed configuration value of "quote_columns" has an '
f"invalid type {type(quote_config)}"
)
raise CompilationError(msg)
if quote_columns:
return self.quote(column)
else:
return column
@available
def standardize_grants_dict(self, grants_table: "agate.Table") -> dict:
grants_dict: Dict[str, Any] = {}
for row in grants_table:
grantee = row["grantee_name"]
granted_to = row["granted_to"]
privilege = row["privilege"]
if privilege != "OWNERSHIP" and granted_to not in ["SHARE", "DATABASE_ROLE"]:
if privilege in grants_dict.keys():
grants_dict[privilege].append(grantee)
else:
grants_dict.update({privilege: [grantee]})
return grants_dict
def timestamp_add_sql(self, add_to: str, number: int = 1, interval: str = "hour") -> str:
return f"DATEADD({interval}, {number}, {add_to})"
def submit_python_job(self, parsed_model: dict, compiled_code: str):
schema = parsed_model["schema"]
database = parsed_model["database"]
identifier = parsed_model["alias"]
python_version = parsed_model["config"].get("python_version", "3.8")
packages = parsed_model["config"].get("packages", [])
imports = parsed_model["config"].get("imports", [])
external_access_integrations = parsed_model["config"].get(
"external_access_integrations", []
)
secrets = parsed_model["config"].get("secrets", {})
# adding default packages we need to make python model work
default_packages = ["snowflake-snowpark-python"]
package_names = [package.split("==")[0] for package in packages]
for default_package in default_packages:
if default_package not in package_names:
packages.append(default_package)
packages = "', '".join(packages)
imports = "', '".join(imports)
external_access_integrations = ", ".join(external_access_integrations)
secrets = ", ".join(f"'{key}' = {value}" for key, value in secrets.items())
# we can't pass empty imports, external_access_integrations or secrets clause to snowflake
if imports:
imports = f"IMPORTS = ('{imports}')"
if external_access_integrations:
# Black is trying to make this a tuple.
# fmt: off
external_access_integrations = f"EXTERNAL_ACCESS_INTEGRATIONS = ({external_access_integrations})"
if secrets:
secrets = f"SECRETS = ({secrets})"
if self.config.args.SEND_ANONYMOUS_USAGE_STATS:
snowpark_telemetry_string = "dbtLabs_dbtPython"
snowpark_telemetry_snippet = f"""
import sys
sys._xoptions['snowflake_partner_attribution'].append("{snowpark_telemetry_string}")"""
else:
snowpark_telemetry_snippet = ""
common_procedure_code = f"""
RETURNS STRING
LANGUAGE PYTHON
RUNTIME_VERSION = '{python_version}'
PACKAGES = ('{packages}')
{external_access_integrations}
{secrets}
{imports}
HANDLER = 'main'
EXECUTE AS CALLER
AS
$$
{snowpark_telemetry_snippet}
{compiled_code}
$$"""
use_anonymous_sproc = parsed_model["config"].get("use_anonymous_sproc", True)
if use_anonymous_sproc:
proc_name = f"{identifier}__dbt_sp"
python_stored_procedure = f"""
WITH {proc_name} AS PROCEDURE ()
{common_procedure_code}
CALL {proc_name}();
"""
else:
proc_name = f"{database}.{schema}.{identifier}__dbt_sp"
python_stored_procedure = f"""
CREATE OR REPLACE PROCEDURE {proc_name} ()
{common_procedure_code};
CALL {proc_name}();
"""
response, _ = self.execute(python_stored_procedure, auto_begin=False, fetch=False)
if not use_anonymous_sproc:
self.execute(
f"drop procedure if exists {proc_name}()",
auto_begin=False,
fetch=False,
)
return response
def valid_incremental_strategies(self):
return ["append", "merge", "delete+insert", "microbatch"]
def debug_query(self):
"""Override for DebugTask method"""
self.execute("select 1 as id")