Merge pull request #26 from ko4life-net/maintenance-docs

Prefix migration scripts with 4 leading zeros and update docs
ko4life-net · May 22, 2024 · 8e38ba5 · 8e38ba5
2 parents 1ad79c1 + 40f2882
commit 8e38ba5
Show file tree

Hide file tree

Showing 46 changed files with 4 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 *.bak
 tmp/
+.venv/
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ Note that the development process is inspired from [different db development env
 
 During development we only create migration scripts to alter the current state of the base. The base here refers to the generated scripts in data, procedure and schema.
 
-Every migration script will be prefixed by index. For example, `1_insert_steve_user.sql` will contain an insert statement to `TB_USER` table.
+Every migration script will be prefixed by max 4 leading zeros. For example, `0001_insert_steve_user.sql` will contain an insert statement to `TB_USER` table.
 
 Apart from the benifit of having the database under version control, this also makes it easy to use any SQL version you want. I use both 2008 and 2022 and it works perfectly fine with both.
 

diff --git a/src/migration/README.md b/src/migration/README.md
@@ -3,12 +3,10 @@
 Add here scripts that alters the existing database's schema, procedures, data and misc changes.
 
 Couple of rules and notes when writing migration scripts:
-- Try to avoid any unnecessary formatting (eventually we'll add a formatter and automation), as it bloats the final diff when exporting the db
 - Always assume the database containing data, even if you just modify an empty table
-- When altering Stored Procedures, always create a separate script for it
 - When altering the schema, adding comments (`--` for tsql) are encouraged
-- When merging Pull Requests, if the server or client also needs changes, first merge the db PRs before the client / server
-- When submitting a PR, providing a `*.diff` file is encouraged (`.\import.ps1 -generate_diffs $true`)
+- When submitting a PR, please generate a `*.diff` file and commit it (`.\import.ps1 -generate_diffs $true`)
+- Every migration script should start with max 4 leading zeros (example `0001_insert_user.sql`)
 
 ## Creating a new release
 

diff --git a/src/migration/archive/.gitkeep b/src/migration/archive/.gitkeep
diff --git a/...ration/archive/1_fix_aiserver_columns.sql → ...ion/archive/0001_fix_aiserver_columns.sql b/...ration/archive/1_fix_aiserver_columns.sql → ...ion/archive/0001_fix_aiserver_columns.sql
diff --git a/...n/archive/1_fix_aiserver_columns.sql.diff → ...rchive/0001_fix_aiserver_columns.sql.diff b/...n/archive/1_fix_aiserver_columns.sql.diff → ...rchive/0001_fix_aiserver_columns.sql.diff
diff --git a/src/migration/archive/2_insert_steve.sql → src/migration/archive/0002_insert_steve.sql b/src/migration/archive/2_insert_steve.sql → src/migration/archive/0002_insert_steve.sql
diff --git a/...migration/archive/2_insert_steve.sql.diff → ...ration/archive/0002_insert_steve.sql.diff b/...migration/archive/2_insert_steve.sql.diff → ...ration/archive/0002_insert_steve.sql.diff
diff --git a/...chive/3_alter_account_login_procedure.sql → ...ve/0003_alter_account_login_procedure.sql b/...chive/3_alter_account_login_procedure.sql → ...ve/0003_alter_account_login_procedure.sql
diff --git a/.../3_alter_account_login_procedure.sql.diff → ...03_alter_account_login_procedure.sql.diff b/.../3_alter_account_login_procedure.sql.diff → ...03_alter_account_login_procedure.sql.diff
diff --git a/...rchive/4_create_char_select_procedure.sql → ...ive/0004_create_char_select_procedure.sql b/...rchive/4_create_char_select_procedure.sql → ...ive/0004_create_char_select_procedure.sql
diff --git a/...e/4_create_char_select_procedure.sql.diff → ...004_create_char_select_procedure.sql.diff b/...e/4_create_char_select_procedure.sql.diff → ...004_create_char_select_procedure.sql.diff
diff --git a/...hive/5_alter_load_char_info_procedure.sql → ...e/0005_alter_load_char_info_procedure.sql b/...hive/5_alter_load_char_info_procedure.sql → ...e/0005_alter_load_char_info_procedure.sql
diff --git a/...5_alter_load_char_info_procedure.sql.diff → ...5_alter_load_char_info_procedure.sql.diff b/...5_alter_load_char_info_procedure.sql.diff → ...5_alter_load_char_info_procedure.sql.diff
diff --git a/...hive/6_alter_load_user_data_procedure.sql → ...e/0006_alter_load_user_data_procedure.sql b/...hive/6_alter_load_user_data_procedure.sql → ...e/0006_alter_load_user_data_procedure.sql
diff --git a/...6_alter_load_user_data_procedure.sql.diff → ...6_alter_load_user_data_procedure.sql.diff b/...6_alter_load_user_data_procedure.sql.diff → ...6_alter_load_user_data_procedure.sql.diff
diff --git a/...chive/7_alter_nation_select_procedure.sql → ...ve/0007_alter_nation_select_procedure.sql b/...chive/7_alter_nation_select_procedure.sql → ...ve/0007_alter_nation_select_procedure.sql
diff --git a/.../7_alter_nation_select_procedure.sql.diff → ...07_alter_nation_select_procedure.sql.diff b/.../7_alter_nation_select_procedure.sql.diff → ...07_alter_nation_select_procedure.sql.diff
diff --git a/...gration/archive/8_alter_account_login.sql → ...tion/archive/0008_alter_account_login.sql b/...gration/archive/8_alter_account_login.sql → ...tion/archive/0008_alter_account_login.sql
diff --git a/...on/archive/8_alter_account_login.sql.diff → ...archive/0008_alter_account_login.sql.diff b/...on/archive/8_alter_account_login.sql.diff → ...archive/0008_alter_account_login.sql.diff
diff --git a/...e/9_drop_unused_tables_and_procedures.sql → ...009_drop_unused_tables_and_procedures.sql b/...e/9_drop_unused_tables_and_procedures.sql → ...009_drop_unused_tables_and_procedures.sql
diff --git a/...rop_unused_tables_and_procedures.sql.diff → ...rop_unused_tables_and_procedures.sql.diff b/...rop_unused_tables_and_procedures.sql.diff → ...rop_unused_tables_and_procedures.sql.diff
diff --git a/...ation/archive/10_fix_userdata_columns.sql → ...ion/archive/0010_fix_userdata_columns.sql b/...ation/archive/10_fix_userdata_columns.sql → ...ion/archive/0010_fix_userdata_columns.sql
diff --git a/.../archive/10_fix_userdata_columns.sql.diff → ...rchive/0010_fix_userdata_columns.sql.diff b/.../archive/10_fix_userdata_columns.sql.diff → ...rchive/0010_fix_userdata_columns.sql.diff
diff --git a/...e/11_alter_update_user_data_procedure.sql → ...0011_alter_update_user_data_procedure.sql b/...e/11_alter_update_user_data_procedure.sql → ...0011_alter_update_user_data_procedure.sql
diff --git a/...alter_update_user_data_procedure.sql.diff → ...alter_update_user_data_procedure.sql.diff b/...alter_update_user_data_procedure.sql.diff → ...alter_update_user_data_procedure.sql.diff
diff --git a/...ive/12_alter_load_char_info_procedure.sql → ...e/0012_alter_load_char_info_procedure.sql b/...ive/12_alter_load_char_info_procedure.sql → ...e/0012_alter_load_char_info_procedure.sql
diff --git a/...2_alter_load_char_info_procedure.sql.diff → ...2_alter_load_char_info_procedure.sql.diff b/...2_alter_load_char_info_procedure.sql.diff → ...2_alter_load_char_info_procedure.sql.diff
diff --git a/...ive/13_alter_load_user_data_procedure.sql → ...e/0013_alter_load_user_data_procedure.sql b/...ive/13_alter_load_user_data_procedure.sql → ...e/0013_alter_load_user_data_procedure.sql
diff --git a/...3_alter_load_user_data_procedure.sql.diff → ...3_alter_load_user_data_procedure.sql.diff b/...3_alter_load_user_data_procedure.sql.diff → ...3_alter_load_user_data_procedure.sql.diff
diff --git a/...hive/14_alter_deleted_userdata_schema.sql → ...ve/0014_alter_deleted_userdata_schema.sql b/...hive/14_alter_deleted_userdata_schema.sql → ...ve/0014_alter_deleted_userdata_schema.sql
diff --git a/...14_alter_deleted_userdata_schema.sql.diff → ...14_alter_deleted_userdata_schema.sql.diff b/...14_alter_deleted_userdata_schema.sql.diff → ...14_alter_deleted_userdata_schema.sql.diff
diff --git a/...rchive/15_alter_delete_char_procedure.sql → ...hive/0015_alter_delete_char_procedure.sql b/...rchive/15_alter_delete_char_procedure.sql → ...hive/0015_alter_delete_char_procedure.sql
diff --git a/...e/15_alter_delete_char_procedure.sql.diff → ...0015_alter_delete_char_procedure.sql.diff b/...e/15_alter_delete_char_procedure.sql.diff → ...0015_alter_delete_char_procedure.sql.diff
diff --git a/...hive/16_alter_warehouse_table_columns.sql → ...ve/0016_alter_warehouse_table_columns.sql b/...hive/16_alter_warehouse_table_columns.sql → ...ve/0016_alter_warehouse_table_columns.sql
diff --git a/...16_alter_warehouse_table_columns.sql.diff → ...16_alter_warehouse_table_columns.sql.diff b/...16_alter_warehouse_table_columns.sql.diff → ...16_alter_warehouse_table_columns.sql.diff
diff --git a/.../archive/17_alter_warehouse_procedure.sql → ...rchive/0017_alter_warehouse_procedure.sql b/.../archive/17_alter_warehouse_procedure.sql → ...rchive/0017_alter_warehouse_procedure.sql
diff --git a/...ive/17_alter_warehouse_procedure.sql.diff → ...e/0017_alter_warehouse_procedure.sql.diff b/...ive/17_alter_warehouse_procedure.sql.diff → ...e/0017_alter_warehouse_procedure.sql.diff
diff --git a/...rchive/18_fix_case_sensitivity_errors.sql → ...hive/0018_fix_case_sensitivity_errors.sql b/...rchive/18_fix_case_sensitivity_errors.sql → ...hive/0018_fix_case_sensitivity_errors.sql
diff --git a/...e/18_fix_case_sensitivity_errors.sql.diff → ...0018_fix_case_sensitivity_errors.sql.diff b/...e/18_fix_case_sensitivity_errors.sql.diff → ...0018_fix_case_sensitivity_errors.sql.diff
diff --git a/...hive/19_uppercase_fetch_status_usages.sql → ...ve/0019_uppercase_fetch_status_usages.sql b/...hive/19_uppercase_fetch_status_usages.sql → ...ve/0019_uppercase_fetch_status_usages.sql
diff --git a/...19_uppercase_fetch_status_usages.sql.diff → ...19_uppercase_fetch_status_usages.sql.diff b/...19_uppercase_fetch_status_usages.sql.diff → ...19_uppercase_fetch_status_usages.sql.diff
diff --git a/...ive/20_drop_create_knights2_procedure.sql → ...e/0020_drop_create_knights2_procedure.sql b/...ive/20_drop_create_knights2_procedure.sql → ...e/0020_drop_create_knights2_procedure.sql
diff --git a/...0_drop_create_knights2_procedure.sql.diff → ...0_drop_create_knights2_procedure.sql.diff b/...0_drop_create_knights2_procedure.sql.diff → ...0_drop_create_knights2_procedure.sql.diff
diff --git a/...tion/archive/21_capitalized_variables.sql → ...on/archive/0021_capitalized_variables.sql b/...tion/archive/21_capitalized_variables.sql → ...on/archive/0021_capitalized_variables.sql
diff --git a/...archive/21_capitalized_variables.sql.diff → ...chive/0021_capitalized_variables.sql.diff b/...archive/21_capitalized_variables.sql.diff → ...chive/0021_capitalized_variables.sql.diff
-Original file line number
+Diff line change
@@ -1,2 +1,3 @@
     *.bak
     tmp/
+    .venv/