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
|
from __future__ import annotations
import sqlite3
import sys
from pathlib import Path
import pytest
from harlequin.catalog import Catalog, CatalogItem, InteractiveCatalogItem
from harlequin.exception import HarlequinConfigError, HarlequinConnectionError
from harlequin_sqlite import HarlequinSqliteAdapter
@pytest.fixture
def extension_path(data_dir: Path) -> Path:
return data_dir / "adapter_tests" / "sqlite" / "extensions" / "hello0"
def test_connect(tiny_sqlite: Path, small_sqlite: Path) -> None:
tiny = str(tiny_sqlite)
small = str(small_sqlite)
assert HarlequinSqliteAdapter([]).connect()
assert HarlequinSqliteAdapter([":memory:"]).connect()
assert HarlequinSqliteAdapter([tiny], read_only=False).connect()
assert HarlequinSqliteAdapter([tiny], read_only=True).connect()
assert HarlequinSqliteAdapter([tiny], connection_mode="ro").connect()
assert HarlequinSqliteAdapter([tiny, small, ":memory:"], read_only=False).connect()
assert HarlequinSqliteAdapter(
[],
read_only=False,
timeout="100",
isolation_level="EXCLUSIVE",
check_same_thread=False,
cached_statements="10",
)
def test_cannot_connect(tmp_path: Path, tiny_sqlite: Path) -> None:
nonexistent_db = tmp_path / "no.db"
with pytest.raises(HarlequinConnectionError):
HarlequinSqliteAdapter((str(nonexistent_db),), read_only=True).connect()
with pytest.raises(HarlequinConnectionError):
HarlequinSqliteAdapter(
(str(nonexistent_db), ":memory:"), read_only=True
).connect()
with pytest.raises(HarlequinConnectionError):
HarlequinSqliteAdapter(
(str(tiny_sqlite),), read_only=True, connection_mode="rwc"
).connect()
def test_get_databases(tiny_sqlite: Path, tmp_path: Path) -> None:
new_db = tmp_path / "new.db"
conn = HarlequinSqliteAdapter((str(tiny_sqlite), str(new_db))).connect()
assert conn._get_databases() == ["main", "new"]
def test_get_tables(tiny_sqlite: Path, small_sqlite: Path) -> None:
conn = HarlequinSqliteAdapter(
[str(tiny_sqlite), str(small_sqlite)], read_only=True
).connect()
assert conn._get_relations("main") == [("foo", "table")]
assert conn._get_relations("small") == [("drivers", "table")]
def test_get_columns(small_sqlite: Path) -> None:
conn = HarlequinSqliteAdapter([str(small_sqlite)], read_only=True).connect()
cols = conn._get_columns(db_name="main", rel_name="drivers")
assert [(col_name, col_type) for _, col_name, col_type, *_ in cols] == [
("driverId", "BIGINT"),
("driverRef", "VARCHAR"),
("number", "VARCHAR"),
("code", "VARCHAR"),
("forename", "VARCHAR"),
("surname", "VARCHAR"),
("dob", "VARCHAR"),
("nationality", "VARCHAR"),
("url", "VARCHAR"),
]
def test_get_catalog(tiny_sqlite: Path, small_sqlite: Path) -> None:
conn = HarlequinSqliteAdapter(
[str(tiny_sqlite), str(small_sqlite)], read_only=True
).connect()
expected = Catalog(
items=[
CatalogItem(
qualified_identifier='"main"',
query_name='"main"',
label="main",
type_label="db",
children=[
CatalogItem(
qualified_identifier='"main"."foo"',
query_name='"main"."foo"',
label="foo",
type_label="t",
children=[
CatalogItem(
qualified_identifier='"main"."foo"."foo_col"',
query_name='"foo_col"',
label="foo_col",
type_label="##",
)
],
)
],
),
CatalogItem(
qualified_identifier='"small"',
query_name='"small"',
label="small",
type_label="db",
children=[
CatalogItem(
qualified_identifier='"small"."drivers"',
query_name='"small"."drivers"',
label="drivers",
type_label="t",
children=[
CatalogItem(
qualified_identifier='"small"."drivers"."driverId"',
query_name='"driverId"',
label="driverId",
type_label="##",
),
CatalogItem(
qualified_identifier='"small"."drivers"."driverRef"',
query_name='"driverRef"',
label="driverRef",
type_label="s",
),
CatalogItem(
qualified_identifier='"small"."drivers"."number"',
query_name='"number"',
label="number",
type_label="s",
),
CatalogItem(
qualified_identifier='"small"."drivers"."code"',
query_name='"code"',
label="code",
type_label="s",
),
CatalogItem(
qualified_identifier='"small"."drivers"."forename"',
query_name='"forename"',
label="forename",
type_label="s",
),
CatalogItem(
qualified_identifier='"small"."drivers"."surname"',
query_name='"surname"',
label="surname",
type_label="s",
),
CatalogItem(
qualified_identifier='"small"."drivers"."dob"',
query_name='"dob"',
label="dob",
type_label="s",
),
CatalogItem(
qualified_identifier='"small"."drivers"."nationality"',
query_name='"nationality"',
label="nationality",
type_label="s",
),
CatalogItem(
qualified_identifier='"small"."drivers"."url"',
query_name='"url"',
label="url",
type_label="s",
),
],
)
],
),
]
)
catalog = conn.get_catalog()
assert [item.label for item in catalog.items] == [
item.label for item in expected.items
]
for i, database_item in enumerate(catalog.items):
assert isinstance(database_item, InteractiveCatalogItem)
assert database_item.children == []
schema_items = database_item.fetch_children()
assert [item.label for item in schema_items] == [
item.label for item in expected.items[i].children
]
for j, schema_item in enumerate(schema_items):
assert isinstance(schema_item, InteractiveCatalogItem)
assert schema_item.children == []
relation_items = schema_item.fetch_children()
assert [(item.label, item.type_label) for item in relation_items] == [
(item.label, item.type_label)
for item in expected.items[i].children[j].children
]
for k, relation_item in enumerate(relation_items):
assert isinstance(relation_item, InteractiveCatalogItem)
assert relation_item.children == []
column_items = relation_item.fetch_children()
assert [(item.label, item.type_label) for item in column_items] == [
(item.label, item.type_label)
for item in expected.items[i].children[j].children[k].children
]
def test_init_script(tiny_sqlite: Path, tmp_path: Path) -> None:
script = (
f".bail on\nselect \n1;\n.bail off\n.open {tiny_sqlite}\n"
"create table test_init as select 2;"
)
commands = HarlequinSqliteAdapter._split_script(script)
assert len(commands) == 5
rewritten = [HarlequinSqliteAdapter._rewrite_init_command(cmd) for cmd in commands]
assert rewritten[0] == ""
assert rewritten[1] == commands[1]
assert rewritten[2] == ""
assert rewritten[3].startswith(f"attach '{tiny_sqlite}'")
assert rewritten[4] == commands[4]
with open(tmp_path / "myscript", "w") as f:
f.write(script)
conn = HarlequinSqliteAdapter(
[":memory:"], init_path=tmp_path / "myscript"
).connect()
cur = conn.execute("select * from test_init")
assert cur
assert cur.fetchall() == [(2,)]
def test_rewrite_load(extension_path: Path) -> None:
cmd = f".load {extension_path.as_posix()}"
rewritten = HarlequinSqliteAdapter._rewrite_init_command(cmd)
assert rewritten.startswith("select load_extension")
@pytest.mark.skipif(
not hasattr(sqlite3.Connection, "enable_load_extension"),
reason="Not supported on many Pythons.",
)
def test_load_extension(extension_path: Path) -> None:
conn = HarlequinSqliteAdapter(
[":memory:"], extension=[extension_path.as_posix()]
).connect()
assert conn
@pytest.mark.skipif(
hasattr(sqlite3.Connection, "enable_load_extension"),
reason="Not supported on many Pythons.",
)
def test_load_extension_raises(extension_path: Path) -> None:
with pytest.raises(HarlequinConfigError) as exc_info:
_ = HarlequinSqliteAdapter(
[":memory:"], extension=[extension_path.as_posix()]
).connect()
assert "harlequin.sh" in str(exc_info)
def test_initialize_adapter_ignores_extra_kwargs() -> None:
adapter = HarlequinSqliteAdapter((":memory:",), foo="bar")
assert adapter
assert adapter.connect()
def test_limit(small_sqlite: Path) -> None:
adapter = HarlequinSqliteAdapter((str(small_sqlite),))
conn = adapter.connect()
cur = conn.execute("select * from drivers")
assert cur
results = cur.fetchall()
assert len(results) == 857 # type: ignore
cur = conn.execute("select * from drivers")
assert cur
cur = cur.set_limit(100)
results = cur.fetchall()
assert len(results) == 100 # type: ignore
@pytest.mark.py12
@pytest.mark.skipif(
sys.version_info < (3, 12), reason="Transactions only supported on py3.12+"
)
def test_transaction_mode() -> None:
adapter = HarlequinSqliteAdapter((":memory:",))
conn = adapter.connect()
assert conn.transaction_mode is not None
assert conn.transaction_mode.label == "Auto"
assert conn.transaction_mode.commit is None
assert conn.transaction_mode.rollback is None
new_mode = conn.toggle_transaction_mode()
assert new_mode
assert new_mode.label == "Manual"
assert new_mode.commit is not None
assert new_mode.rollback is not None
assert conn.transaction_mode.label == "Manual"
assert conn.toggle_transaction_mode()
assert conn.transaction_mode.label == "Auto"
|
