Skip to content

Commit 63964bb

Browse files
fix(test-db): engine params (apache#25615)
1 parent b97f8f0 commit 63964bb

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

superset/cli/test_db.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,10 @@ def test_datetime(console: Console, engine: Engine) -> None:
135135
@click.option(
136136
"--connect-args",
137137
"-c",
138-
"raw_connect_args",
138+
"raw_engine_kwargs",
139139
help="Connect args as JSON or YAML",
140140
)
141-
def test_db(sqlalchemy_uri: str, raw_connect_args: str | None = None) -> None:
141+
def test_db(sqlalchemy_uri: str, raw_engine_kwargs: str | None = None) -> None:
142142
"""
143143
Run a series of tests against an analytical database.
144144
@@ -161,13 +161,13 @@ def test_db(sqlalchemy_uri: str, raw_connect_args: str | None = None) -> None:
161161
console.clear()
162162

163163
console.print("[bold]Collecting additional connection information...")
164-
connect_args = collect_connection_info(console, sqlalchemy_uri, raw_connect_args)
164+
engine_kwargs = collect_connection_info(console, sqlalchemy_uri, raw_engine_kwargs)
165165

166166
console.print("[bold]\nChecking for a DB engine spec...")
167167
test_db_engine_spec(console, sqlalchemy_uri)
168168

169169
console.print("[bold]\nTesting the SQLAlchemy dialect...")
170-
engine = test_sqlalchemy_dialect(console, sqlalchemy_uri, connect_args)
170+
engine = test_sqlalchemy_dialect(console, sqlalchemy_uri, engine_kwargs)
171171

172172
console.print("[bold]\nTesting the database connectivity...")
173173
test_database_connectivity(console, engine)
@@ -176,26 +176,26 @@ def test_db(sqlalchemy_uri: str, raw_connect_args: str | None = None) -> None:
176176
def collect_connection_info(
177177
console: Console,
178178
sqlalchemy_uri: str,
179-
raw_connect_args: str | None = None,
179+
raw_engine_kwargs: str | None = None,
180180
) -> dict[str, Any]:
181181
"""
182-
Collect ``connect_args`` if needed.
182+
Collect ``engine_kwargs`` if needed.
183183
"""
184184
console.print(f"[green]SQLAlchemy URI: [bold]{sqlalchemy_uri}")
185-
if raw_connect_args is None:
186-
configure_connect_args = input(
185+
if raw_engine_kwargs is None:
186+
configure_engine_kwargs = input(
187187
"> Do you want to configure connection arguments? [y/N] "
188188
)
189-
if configure_connect_args.strip().lower() == "y":
189+
if configure_engine_kwargs.strip().lower() == "y":
190190
console.print(
191-
"Please paste the connect_args as JSON or YAML and press CTRL-D when "
191+
"Please paste the engine_kwargs as JSON or YAML and press CTRL-D when "
192192
"finished"
193193
)
194-
raw_connect_args = sys.stdin.read()
194+
raw_engine_kwargs = sys.stdin.read()
195195
else:
196-
raw_connect_args = "{}"
196+
raw_engine_kwargs = "{}"
197197

198-
return yaml.safe_load(raw_connect_args)
198+
return yaml.safe_load(raw_engine_kwargs)
199199

200200

201201
def test_db_engine_spec(
@@ -272,12 +272,12 @@ def test_db_engine_spec(
272272
def test_sqlalchemy_dialect(
273273
console: Console,
274274
sqlalchemy_uri: str,
275-
connect_args: dict[str, Any],
275+
engine_kwargs: dict[str, Any],
276276
) -> Engine:
277277
"""
278278
Test the SQLAlchemy dialect, making sure it supports everything Superset needs.
279279
"""
280-
engine = create_engine(sqlalchemy_uri, connect_args=connect_args)
280+
engine = create_engine(sqlalchemy_uri, **engine_kwargs)
281281
dialect = engine.dialect
282282

283283
console.print("[bold]Checking functions used by the inspector...")

0 commit comments

Comments
 (0)