Updates to Manage Vehicles DB schema and DB version management process

[john-fletcher-aot]

Description

DDL for Manage Vehicles, previously stored in /database/mssql/ddl/sample_ddl.sql has been moved into /database/mssql/scripts/versions/ directory.

DDL is implemented as individual DDL script files to be applied in sequential order, starting at version 1 and up to version x, where x is the most recent version of the ORBC database. Individual script files are named according to a pattern recognized by the sql server container startup shell script. Comments are in the shell scripts, located at /database/mssql/*.sh.

This is the first step towards allowing us to normalize the process required to keep the SQL Server databases in sync between dev, test, and production. Also, it is compatible with the standard MOTI process for incrementing production database versions with incremental script file executions.

Note this commit requires that developers use a local .env file to store environment variable secrets (and other not-quite-so-secret configuration). Details of the .env file have been posted to the devs MS Teams conversation.

Fixes # (issue)

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

• Run docker compose run --build -d sql-server-db, verify container starts successfully
• Once sql-server-db container running successfully, connect using SQL Server Management Studio and inspect the database schema to ensure it matches the DDL (all 7 tables have been created, etc).
• When connected in SSMS, inspect the ORBC_SYS_VERSION table to ensure both versions (1 and 2) are represented with descriptions accurately

Checklist

• I have read the CONTRIBUTING doc
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have already been accepted and merged

Further comments

The versioning approach was influenced by the TypeORM migrations pattern, but allows for compatibility with MOTI database standards. MOTI DBAs will be responsible for executing DDL for each version upgrade in production, and they require SQL DDL instead of TypeScript or JavaScript which TypeORM migrations use.

Manually creating DDL instead of using TypeORM to generate DDL for us allows us to include additional required elements such as table and column comments, and allows us to be flexible with respect to the data types we use.

---

Thanks for the PR!

Any successful deployments (not always required) will be available below.
Backend available
Frontend available

Once merged, code will be promoted and handed off to following workflow run.
Main Merge Workflow

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[devin-aot]

Successfully ran the following tests:

• Run docker compose run --build -d sql-server-db, verify container starts successfully
• Once sql-server-db container running successfully, connect using SQL Server Management Studio and inspect the database schema to ensure it matches the DDL (all 7 tables have been created, etc).
• When connected in SSMS, inspect the ORBC_SYS_VERSION table to ensure both versions (1 and 2) are represented with descriptions accurately

Screenshot: