feat: Add Parameters fields to GET Database by hughhhh · Pull Request #14653 · apache/superset

hughhhh · 2021-05-16T00:35:25Z

SUMMARY

Update the api to surface parameters in GET database. This will be leveraged for whenever a user wants to edit a database assuming configuration type is dynamic.

Also, updated all engine specs to allow for abstract classes while we implement them.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TEST PLAN

ADDITIONAL INFORMATION

Has associated issue:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- Migration is atomic, supports rollback & is backwards-compatible
- Confirm DB migration upgrade and downgrade tested
- Runtime estimates and downtime expectations provided
Introduces new feature or API
Removes existing feature or API

…/add-parameters-api

codecov · 2021-05-16T00:35:44Z

Codecov Report

Merging #14653 (b903411) into master (32f5f36) will decrease coverage by 0.21%.
The diff coverage is 66.66%.

❗ Current head b903411 differs from pull request most recent head ef0f9a8. Consider uploading reports for the commit ef0f9a8 to get more accurate results

@@            Coverage Diff             @@
##           master   #14653      +/-   ##
==========================================
- Coverage   77.51%   77.30%   -0.22%     
==========================================
  Files         958      958              
  Lines       48560    48598      +38     
  Branches     5703     5715      +12     
==========================================
- Hits        37642    37568      -74     
- Misses      10718    10829     +111     
- Partials      200      201       +1

Flag	Coverage Δ
hive	`?`
javascript	`72.49% <60.97%> (-0.04%)`	⬇️
presto	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...-frontend/src/SqlLab/components/SouthPane/state.ts	`100.00% <ø> (ø)`
...erset-frontend/src/SqlLab/components/SqlEditor.jsx	`54.62% <ø> (ø)`
...src/components/FilterableTable/FilterableTable.tsx	`82.26% <ø> (ø)`
superset/databases/api.py	`92.41% <ø> (ø)`
superset/db_engine_specs/base.py	`87.90% <50.00%> (-0.56%)`	⬇️
...erset-frontend/src/SqlLab/components/ResultSet.tsx	`67.31% <57.89%> (-2.69%)`	⬇️
...rset-frontend/src/SqlLab/components/QueryTable.jsx	`67.85% <100.00%> (+1.19%)`	⬆️
...tend/src/SqlLab/components/SouthPane/SouthPane.tsx	`79.54% <100.00%> (ø)`
superset/models/core.py	`89.70% <100.00%> (-0.08%)`	⬇️
superset/views/core.py	`75.48% <100.00%> (ø)`
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a7a011c...ef0f9a8. Read the comment docs.

pkdotson · 2021-05-17T18:09:15Z

/testenv up

github-actions · 2021-05-17T19:41:36Z

@pkdotson Ephemeral environment spinning up at http://54.188.67.191:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

…parameters-api

hughhhh · 2021-05-17T22:05:39Z


    // should show error alerts
-    cy.get('.toast').contains('error').should('be.visible');
+    // TODO(hugh): Update this test


We have a clubhouse ticket to re write this test once we are done with updating the modal

betodealmeida · 2021-05-17T22:10:30Z

+            if len(parameters.keys()) < 2:
+                return data


Why do we need this?

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

betodealmeida · 2021-05-18T16:39:42Z

+    def build_sqlalchemy_url(cls, parameters: Any) -> str:
+        raise NotImplementedError("build_sqlalchemy_url is not implemented")


This was renamed to build_sqlalchemy_uri:

superset/superset/databases/commands/validate.py

Line 85 in 3a81e6a

sqlalchemy_uri = engine_spec.build_sqlalchemy_uri(

Suggested change

def build_sqlalchemy_url(cls, parameters: Any) -> str:

raise NotImplementedError("build_sqlalchemy_url is not implemented")

def build_sqlalchemy_uri(cls, parameters: Any) -> str:

raise NotImplementedError("build_sqlalchemy_uri is not implemented")

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

betodealmeida · 2021-05-19T02:42:48Z


+    @property
+    def parameters(self) -> Dict[str, Any]:
+        # Build parameters if db_engine_spec is a subclass of BasicParametersMixin


Nit:

Suggested change

# Build parameters if db_engine_spec is a subclass of BasicParametersMixin

# Build parameters if db_engine_spec supports it

github-actions · 2021-05-19T14:25:53Z

Ephemeral environment shutdown and build artifacts deleted.

hughhhh added 3 commits May 14, 2021 13:04

save types and update api

182eb3c

remove parameters for now

5f30cee

Merge branch 'master' of https://github.com/apache/superset into hugh…

6886fee

…/add-parameters-api

pull-request-size Bot added the size/M label May 16, 2021

checkout js files

35d4ebc

pull-request-size Bot added size/S and removed size/M labels May 16, 2021

checkout

8ab60e4

hughhhh mentioned this pull request May 16, 2021

feat: Surface parameters fields for database model #14646

Closed

8 tasks

hughhhh added 7 commits May 15, 2021 20:57

fix

7713d57

this is it

bbc25a5

yerp

88a4279

whats next

9e765c0

yea

9ef6c0f

lit

59beb61

put condition to override parameters

2b79e49

long wait

265685b

hughhhh added 4 commits May 17, 2021 16:48

remove flaky test

ec0b13e

status

7862776

Merge branch 'master' of https://github.com/apache/superset into add-…

958adec

…parameters-api

another 1

fd97243

hughhhh commented May 17, 2021

View reviewed changes

betodealmeida self-requested a review May 17, 2021 22:09

betodealmeida requested changes May 17, 2021

View reviewed changes

hughhhh and others added 3 commits May 17, 2021 21:11

Update superset/models/core.py

9b4d95a

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

address concerns

93333fe

inherit base class

0238a95

pull-request-size Bot added size/M and removed size/S labels May 18, 2021

allow abstract classes

c3b0687

pull-request-size Bot added size/L and removed size/M labels May 18, 2021

ignore linting

6c47b50

pull-request-size Bot added size/M and removed size/L labels May 18, 2021

betodealmeida reviewed May 18, 2021

View reviewed changes

hughhhh and others added 7 commits May 18, 2021 14:07

Update superset/db_engine_specs/base.py

d78af21

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

Update superset/models/core.py

eb3009e

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

Merge branch 'master' into add-parameters-api

756fc02

Update superset/db_engine_specs/base.py

b9ce116

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

Update superset/db_engine_specs/base.py

9a783fc

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

ad lint back

2b90ddd

fix logic

ef0f9a8

pull-request-size Bot added size/S and removed size/M labels May 18, 2021

hughhhh mentioned this pull request May 18, 2021

feat(add-db): Add Big Query Form #14700

Closed

8 tasks

betodealmeida approved these changes May 19, 2021

View reviewed changes

hughhhh merged commit ec0a792 into master May 19, 2021

cccs-RyanS pushed a commit to CybercentreCanada/superset that referenced this pull request Dec 17, 2021

feat: Add Parameters fields to GET Database (apache#14653)

36e21ac

QAlexBall pushed a commit to QAlexBall/superset that referenced this pull request Dec 29, 2021

feat: Add Parameters fields to GET Database (apache#14653)

5b8d27b

rusackas deleted the add-parameters-api branch January 30, 2023 19:21

cccs-rc pushed a commit to CybercentreCanada/superset that referenced this pull request Mar 6, 2024

feat: Add Parameters fields to GET Database (apache#14653)

5874219

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.3.0 First shipped in 1.3.0 labels Mar 12, 2024

qfcwell pushed a commit to qfcwell/superset that referenced this pull request May 12, 2026

feat: Add Parameters fields to GET Database (apache#14653)

7273641

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Parameters fields to GET Database#14653

feat: Add Parameters fields to GET Database#14653
hughhhh merged 29 commits into
masterfrom
add-parameters-api

hughhhh commented May 16, 2021 •

edited

Loading

Uh oh!

codecov Bot commented May 16, 2021 •

edited

Loading

Uh oh!

pkdotson commented May 17, 2021

Uh oh!

github-actions Bot commented May 17, 2021

Uh oh!

hughhhh May 17, 2021

Uh oh!

betodealmeida May 17, 2021

Uh oh!

Uh oh!

betodealmeida May 18, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

betodealmeida May 19, 2021

Uh oh!

github-actions Bot commented May 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		def build_sqlalchemy_url(cls, parameters: Any) -> str:
		raise NotImplementedError("build_sqlalchemy_url is not implemented")

	# Build parameters if db_engine_spec is a subclass of BasicParametersMixin
	# Build parameters if db_engine_spec supports it

Conversation

hughhhh commented May 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TEST PLAN

ADDITIONAL INFORMATION

Uh oh!

codecov Bot commented May 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pkdotson commented May 17, 2021

Uh oh!

github-actions Bot commented May 17, 2021

Uh oh!

hughhhh May 17, 2021

Choose a reason for hiding this comment

Uh oh!

betodealmeida May 17, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

betodealmeida May 18, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

betodealmeida May 19, 2021

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hughhhh commented May 16, 2021 •

edited

Loading

codecov Bot commented May 16, 2021 •

edited

Loading