Skip to content

Commit 03f403f

Browse files
authored
Use sequential Alembic migration versions instead of hashes (#479)
* Refactor API key migration: remove obsolete script and update migration process * Rename alembic version to sequential number instead of random hash * reanme alembic version to number instead of random hash * fix migrations * update doc
1 parent 4621f50 commit 03f403f

File tree

42 files changed

+161
-370
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+161
-370
lines changed

backend/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,11 @@ $ docker compose exec backend bash
138138
* After changing a model (for example, adding a column), inside the container, create a revision, e.g.:
139139

140140
```console
141-
$ alembic revision --autogenerate -m "Add column last_name to User model"
141+
$ alembic revision --autogenerate -m "Add column last_name to User model" --rev-id 040
142142
```
143143

144+
* The rev-id should always be the latest existing revision ID plus 1.
145+
144146
* Commit to the git repository the files generated in the alembic directory.
145147

146148
* After creating the revision, run the migration in the database (this is what will actually change the database):

backend/alembic.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# path to migration scripts
55
script_location = app/alembic
66

7+
78
# template used to generate migration files
89
# file_template = %%(rev)s_%%(slug)s
910

backend/app/alembic/migrate_api_key.py

Lines changed: 0 additions & 198 deletions
This file was deleted.

backend/app/alembic/versions/e2412789c190_initialize_models.py renamed to backend/app/alembic/versions/001_initialize_models.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Initialize models
22
3-
Revision ID: e2412789c190
3+
Revision ID: 001
44
Revises:
55
Create Date: 2023-11-24 22:55:43.195942
66
@@ -10,7 +10,7 @@
1010
from alembic import op
1111

1212
# revision identifiers, used by Alembic.
13-
revision = "e2412789c190"
13+
revision = "001"
1414
down_revision = None
1515
branch_labels = None
1616
depends_on = None

backend/app/alembic/versions/9c0a54914c78_add_max_length_for_string_varchar_.py renamed to backend/app/alembic/versions/002_add_max_length_for_string_varchar_.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Add max length for string(varchar) fields in User and Items models
22
3-
Revision ID: 9c0a54914c78
4-
Revises: e2412789c190
3+
Revision ID: 002
4+
Revises: 001
55
Create Date: 2024-06-17 14:42:44.639457
66
77
"""
@@ -11,8 +11,8 @@
1111

1212

1313
# revision identifiers, used by Alembic.
14-
revision = "9c0a54914c78"
15-
down_revision = "e2412789c190"
14+
revision = "002"
15+
down_revision = "001"
1616
branch_labels = None
1717
depends_on = None
1818

backend/app/alembic/versions/d98dd8ec85a3_edit_replace_id_integers_in_all_models_.py renamed to backend/app/alembic/versions/003_edit_replace_id_integers_in_all_models_.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Edit replace id integers in all models to use UUID instead
22
3-
Revision ID: d98dd8ec85a3
4-
Revises: 9c0a54914c78
3+
Revision ID: 003
4+
Revises: 002
55
Create Date: 2024-07-19 04:08:04.000976
66
77
"""
@@ -12,8 +12,8 @@
1212

1313

1414
# revision identifiers, used by Alembic.
15-
revision = "d98dd8ec85a3"
16-
down_revision = "9c0a54914c78"
15+
revision = "003"
16+
down_revision = "002"
1717
branch_labels = None
1818
depends_on = None
1919

backend/app/alembic/versions/1a31ce608336_add_cascade_delete_relationships.py renamed to backend/app/alembic/versions/004_add_cascade_delete_relationships.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Add cascade delete relationships
22
3-
Revision ID: 1a31ce608336
4-
Revises: d98dd8ec85a3
3+
Revision ID: 004
4+
Revises: 003
55
Create Date: 2024-07-31 22:24:34.447891
66
77
"""
@@ -11,8 +11,8 @@
1111

1212

1313
# revision identifiers, used by Alembic.
14-
revision = "1a31ce608336"
15-
down_revision = "d98dd8ec85a3"
14+
revision = "004"
15+
down_revision = "003"
1616
branch_labels = None
1717
depends_on = None
1818

backend/app/alembic/versions/99f4fc325617_add_organization_project_setup.py renamed to backend/app/alembic/versions/005_add_organization_project_setup.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""add organization project setup
22
3-
Revision ID: 99f4fc325617
4-
Revises: 1a31ce608336
3+
Revision ID: 005
4+
Revises: 004
55
Create Date: 2025-03-21 20:51:00.759926
66
77
"""
@@ -11,8 +11,8 @@
1111

1212

1313
# revision identifiers, used by Alembic.
14-
revision = "99f4fc325617"
15-
down_revision = "1a31ce608336"
14+
revision = "005"
15+
down_revision = "004"
1616
branch_labels = None
1717
depends_on = None
1818

backend/app/alembic/versions/0f205e3779ee_add_api_key_table.py renamed to backend/app/alembic/versions/006_add_api_key_table.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""add api key table
22
3-
Revision ID: 0f205e3779ee
4-
Revises: 99f4fc325617
3+
Revision ID: 006
4+
Revises: 005
55
Create Date: 2025-03-21 23:43:34.181704
66
77
"""
@@ -11,8 +11,8 @@
1111

1212

1313
# revision identifiers, used by Alembic.
14-
revision = "0f205e3779ee"
15-
down_revision = "99f4fc325617"
14+
revision = "006"
15+
down_revision = "005"
1616
branch_labels = None
1717
depends_on = None
1818

backend/app/alembic/versions/c43313eca57d_add_document_tables.py renamed to backend/app/alembic/versions/007_add_document_tables.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Add document tables
22
3-
Revision ID: c43313eca57d
4-
Revises: 0f205e3779ee
3+
Revision ID: 007
4+
Revises: 006
55
Create Date: 2025-04-07 10:04:10.414165
66
77
"""
@@ -11,8 +11,8 @@
1111

1212

1313
# revision identifiers, used by Alembic.
14-
revision = "c43313eca57d"
15-
down_revision = "0f205e3779ee"
14+
revision = "007"
15+
down_revision = "006"
1616
branch_labels = None
1717
depends_on = None
1818

0 commit comments

Comments
 (0)