Add custom database scripts

2 min

Configured Commerce uses database scripts internally to alter the state of the database when necessary, such as when a new feature is released or a bug must be fixed. As an added feature, custom database scripts can also be used within your own Configured Commerce solution.

Custom database scripts are executed during application startup and are only executed once for the entire life of the application. Before execution, these scripts are gathered and sorted alphabetically in ascending order (A-Z). This is the order in which they will be executed. After execution, Configured Commerce will note which scripts were executed so they are not executed another time.

As a best practice, the naming of the database scripts should follow a convention to ensure execution in the proper order. Internally, Optimizely uses the following format for naming database scripts.

{date_of_script_creation}.{sequential_order}.{script_name}.sql

The {date_of_script_creation} should follow the format YYYY.MM.DD. The {sequential_order} is a two-digit number starting at "01". This number solves the ordering problem when multiple scripts were created on the same date.

📘 Prerequisites ISC solution installed

Custom database script created

Open the Configured solution in Visual Studio.

Create a DatabaseScripts directory within your Extensions project.

Add the custom database script to that directory and include it in the project as an Embedded Resource. This lets Configured Commerce read and execute the script during application startup. Additionally, this gives the benefit of being able to deploy and execute these scripts in other environments, such as a sandbox or production.

Build the solution. The database scripts in this directory should be executed on the next application startup.