Area: Optimizely CMS

Applies to versions: 12 and higher

Other versions:

ARCHIVED This content is retired and no longer maintained. See the version selector for other versions of this topic.

Installing database schema

Installing from the Visual Studio integration

A database schema is a way to logically group objects such as tables, views and stored procedures, in the database. When you create a new site from the Visual Studio integration, it automatically creates the database with the Optimizely schema. Each version of the database schema targets a specific version of the product. The following topics show how to deploy a database from development to production.

Installing on an empty database

If you need to install database schema on an empty database. See create site by template/cli.

Enabling automatic creation of database schemas

You can also configure a site to automatically create the database schema during site initialization. When the site starts up, Optimizely checks if the schema is installed in the current database as specified by the connection string. If no schema is found and automatic creation is enabled, it executes an SQL script that adds the schema to the database.

To enable automatic schema creation, add attribute createDatabaseSchema="true" to the appsetting.json:

{
      "EpiServer": {
        "Cms": {
            "DataAccess": {
                "CreateDatabaseSchema": "true"
            }
        }
}

or it can be configured by code like this:

public class Startup
{
        public void ConfigureServices(IServiceCollection services)
        {
            services.Configure<DataAccessOptions>(o =>
            {
                o.CreateDatabaseSchema= true;
            });
         }
}

The automatic schema creation is done using the same process as schema updates and it therefore allows you to interact with the schema creation process by registering an implementation of IDatabaseSchemaValidator in the Optimizely IOC container. See Automatic schema updates for further information and examples. Automatic database schema creation will be available for EPiServer.Commerce in upcoming versions.

Creating database manually

If you want to manually deploy the schema, you find the SQL script files in the EPiServer.CMS.Core NuGet package under the tools subfolder.

Best practices when setting up the database

Consider the following recommendations:

When upgrading, you should never directly access the tables or stored procedures in the database, or create custom tables that interfere with the tables created by Optimizely CMS. You should always use the documented API instead, because backwards compatibilty on the database level is not guaranteed.
Optimizely CMS supports several SQL Server high-availability options for availability and performance of the database, which include fail-over clustering and database mirroring. For instance, database mirroring retrieves a “hot” standby database that operates in read-only mode, and all transactions are copied to the mirror, either synchronously or asynchronously. You can configure instant fail-over using a “witness” server.
When you run an SQL Server in production, create a maintenance plan for the database including backup, checking database consistency, and rebuilding indexes. Performance of the database degrades over time if you do not create a maintenance plan, especially if indexes are never rebuilt since the query speed degrades as new content is added. For information, see Microsoft: Maintenance Plans.

Try our conversational search powered by Generative AI!