refactor: Migration for Tabbed Sql Editor by AAfghahi · Pull Request #17925 · apache/superset

AAfghahi · 2022-01-04T22:44:24Z

SUMMARY

This is the first portion of a larger bug issue of retaining a query's saved status when refreshing the page in sql lab. In order to create this we needed to create a foreign key in the tab state view that links it to the saved query.

This migration does that, and the subsequent logic is here: #17771

Benchmark


Running benchmark will downgrade the Superset DB to bb38f40aa3ff and upgrade to c53bae8f08dd again. There may be data loss in downgrades. Continue? [y/N]: y
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running downgrade c53bae8f08dd -> bb38f40aa3ff, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777

Identifying models used in the migration:
- ab_user (1 rows in table ab_user)
- dbs (1 rows in table dbs)
- query (0 rows in table query)
- tab_state (0 rows in table tab_state)
Benchmarking migration
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade bb38f40aa3ff -> c53bae8f08dd, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Migration on current DB took: 0.29 seconds
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running downgrade c53bae8f08dd -> bb38f40aa3ff, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Running with at least 10 entities of each model
- Adding 9 entities to the ab_user model
Processing ████████████████████████████████ 100%
- Adding 9 entities to the dbs model
Processing ████████████████████████████████ 100%
- Adding 10 entities to the query model
Processing ████████████████████████████████ 100%
- Adding 10 entities to the tab_state model
Processing ████████████████████████████████ 100%
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade bb38f40aa3ff -> c53bae8f08dd, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Migration for 10+ entities took: 0.29 seconds
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running downgrade c53bae8f08dd -> bb38f40aa3ff, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Running with at least 100 entities of each model
- Adding 90 entities to the ab_user model
Processing ████████████████████████████████ 100%
- Adding 90 entities to the dbs model
Processing ████████████████████████████████ 100%
- Adding 90 entities to the query model
Processing ████████████████████████████████ 100%
- Adding 90 entities to the tab_state model
Processing ████████████████████████████████ 100%
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade bb38f40aa3ff -> c53bae8f08dd, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Migration for 100+ entities took: 0.43 seconds
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running downgrade c53bae8f08dd -> bb38f40aa3ff, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Running with at least 1000 entities of each model
- Adding 900 entities to the ab_user model
Processing ████████████████████████████████ 100%
- Adding 900 entities to the dbs model
Processing ████████████████████████████████ 100%
- Adding 900 entities to the query model
Processing ████████████████████████████████ 100%
- Adding 900 entities to the tab_state model
Processing ████████████████████████████████ 100%
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade bb38f40aa3ff -> c53bae8f08dd, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Migration for 1000+ entities took: 0.28 seconds
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running downgrade c53bae8f08dd -> bb38f40aa3ff, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Running with at least 10000 entities of each model
- Adding 9000 entities to the ab_user model
Processing ████████████████████████████████ 100%
- Adding 9000 entities to the dbs model
Processing ████████████████████████████████ 100%
- Adding 9000 entities to the query model
Processing ████████████████████████████████ 100%
- Adding 9000 entities to the tab_state model
Processing ████████████████████████████████ 100%
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade bb38f40aa3ff -> c53bae8f08dd, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Migration for 10000+ entities took: 0.54 seconds
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running downgrade c53bae8f08dd -> bb38f40aa3ff, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Running with at least 100000 entities of each model
- Adding 90000 entities to the ab_user model
Processing ████████████████████████████████ 100%
- Adding 90000 entities to the dbs model
Processing ████████████████████████████████ 100%
- Adding 90000 entities to the query model
Processing ████████████████████████████████ 100%
- Adding 90000 entities to the tab_state model
Processing ████████████████████████████████ 100%
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade bb38f40aa3ff -> c53bae8f08dd, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Migration for 100000+ entities took: 0.51 seconds
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running downgrade c53bae8f08dd -> bb38f40aa3ff, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Running with at least 1000000 entities of each model
- Adding 900000 entities to the ab_user model
Processing ████████████████████████████████ 100%
- Adding 900000 entities to the dbs model
Processing ████████████████████████████████ 100%
- Adding 900000 entities to the query model
Processing ████████████████████████████████ 100%
- Adding 900000 entities to the tab_state model
Processing ████████████████████████████████ 100%
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade bb38f40aa3ff -> c53bae8f08dd, add_saved_query_foreign_key_to_tab_state
Revision ID: c53bae8f08dd
Revises: bb38f40aa3ff
Create Date: 2021-12-15 15:05:21.845777
Migration for 1000000+ entities took: 2.09 seconds

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

Has associated issue:
Required feature flags:
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

betodealmeida · 2022-01-04T23:06:36Z

This looks great! But let's wait until we have the sibling PR ready and approved before merging this, in case we need to change the migration.

betodealmeida

Blocking this just in case.

github-actions · 2022-01-05T02:18:35Z

⚠️ @AAfghahi Your base branch master has just also updated superset/migrations.

❗ Please consider rebasing your branch to avoid db migration conflicts.

betodealmeida

Looks great!

* a lot of console logs * migration for tabbed Sql Editors

AAfghahi added 13 commits November 24, 2021 11:03

a lot of console logs

9c52557

Merge branch 'master' of ssh://github.com/apache/superset

bfaab74

Merge branch 'master' of ssh://github.com/apache/superset

c4a1205

Merge branch 'master' of ssh://github.com/apache/superset

cf06579

Merge branch 'master' of ssh://github.com/apache/superset

446314c

Merge branch 'master' of ssh://github.com/apache/superset

535e7f5

Merge branch 'master' of ssh://github.com/preset-io/superset

0362f56

Merge branch 'master' of ssh://github.com/apache/superset

040c10b

Merge branch 'master' of ssh://github.com/apache/superset

1f96238

Merge branch 'master' of ssh://github.com/apache/superset

076624d

Merge branch 'master' of ssh://github.com/apache/superset

fd5bcc6

Merge branch 'master' of ssh://github.com/apache/superset

41fa223

Merge branch 'master' of ssh://github.com/apache/superset

e609fda

AAfghahi requested a review from a team as a code owner January 4, 2022 22:44

pull-request-size Bot added the size/M label Jan 4, 2022

AAfghahi force-pushed the ch26571_tabbedSqlMigration branch from 1acb89d to ebb9b57 Compare January 4, 2022 22:46

betodealmeida self-requested a review January 4, 2022 22:56

betodealmeida requested changes Jan 4, 2022

View reviewed changes

AAfghahi mentioned this pull request Jan 5, 2022

refactor(sql_lab): SQL Lab Persistent Saved State #17771

Merged

9 tasks

eschutho reviewed Jan 5, 2022

View reviewed changes

Comment thread superset/migrations/versions/c53bae8f08dd_add_saved_query_foreign_key_to_tab_state.py Outdated

migration for tabbed Sql Editors

a8b27ce

AAfghahi force-pushed the ch26571_tabbedSqlMigration branch from ebb9b57 to a8b27ce Compare January 5, 2022 22:06

betodealmeida approved these changes Jan 12, 2022

View reviewed changes

AAfghahi merged commit 5e84fd1 into apache:master Jan 12, 2022

shcoderAlex pushed a commit to casual-precision/superset that referenced this pull request Feb 7, 2022

refactor: Migration for Tabbed Sql Editor (apache#17925)

c694a59

* a lot of console logs * migration for tabbed Sql Editors

bwang221 pushed a commit to casual-precision/superset that referenced this pull request Feb 10, 2022

refactor: Migration for Tabbed Sql Editor (apache#17925)

ebfde4b

* a lot of console logs * migration for tabbed Sql Editors

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

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

refactor: Migration for Tabbed Sql Editor (apache#17925)

266245e

* a lot of console logs * migration for tabbed Sql Editors

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Migration for Tabbed Sql Editor#17925

refactor: Migration for Tabbed Sql Editor#17925
AAfghahi merged 14 commits into
apache:masterfrom
preset-io:ch26571_tabbedSqlMigration

AAfghahi commented Jan 4, 2022 •

edited by betodealmeida

Loading

Uh oh!

betodealmeida commented Jan 4, 2022

Uh oh!

betodealmeida left a comment

Uh oh!

github-actions Bot commented Jan 5, 2022

Uh oh!

Uh oh!

betodealmeida left a comment •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

AAfghahi commented Jan 4, 2022 • edited by betodealmeida Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

Uh oh!

betodealmeida commented Jan 4, 2022

Uh oh!

betodealmeida left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jan 5, 2022

Uh oh!

Uh oh!

betodealmeida left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AAfghahi commented Jan 4, 2022 •

edited by betodealmeida

Loading

betodealmeida left a comment •

edited

Loading