pt
/
superset
mirror of https://github.com/apache/superset.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Docs] Running DB migration (#5748) 

* Add doc to add new columns

* spelling

* spelling
This commit is contained in:
Hugh A. Miles II 2018-09-12 07:16:58 -10:00 committed by GitHub
parent 166058d95f
commit 1e35030a90
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING.md
View File

@ -570,3 +570,36 @@ migration hashes. Then run
`superset db merge {PASTE_SHA1_HERE} {PASTE_SHA2_HERE}`. This will create
a new merge migration. You can then `superset db upgrade` to this new
checkpoint.
## Running DB migration
1. First alter the model you want to change. For example I want to add a `Column` Annotations model.
https://github.com/apache/incubator-superset/commit/6c25f549384d7c2fc288451222e50493a7b14104
2. superset db migrate -m "this_will_be_in_the_migration_filename"
For our example we'll be running this command:
```
superset db migrate -m "add_metadata_column_to_annotation_model.py"
```
This will generate a file in `superset/migrations/version/{SHA}_this_will_be_in_the_migration_filename.py`
https://github.com/apache/incubator-superset/commit/d3e83b0fd572c9d6c1297543d415a332858e262
3. Run `superset db upgrade`
The output should look like this:
```
INFO [alembic.runtime.migration] Context impl SQLiteImpl.
INFO [alembic.runtime.migration] Will assume transactional DDL.
INFO [alembic.runtime.migration] Running upgrade 1a1d627ebd8e -> 40a0a483dd12, add_metadata_column_to_annotation_model.py
```
4. Add column to view
Since there is a new column, we need to add it to the AppBuilder Model view.
https://github.com/apache/incubator-superset/pull/5745/commits/6220966e2a0a0cf3e6d87925491f8920fe8a3458