Database Requirements

The Metrix Sync CLI tool handles all of the database initialisation, and data population. The only pre-requisite is that you have a locally configured SQL Server database prepared for the tools use. The only requirement we have around this database is for the specific collation that is compatible with the Metrix Sync CLI tool - SQL_Latin1_General_CP1_CS_AS. This collation is case-sensitive and accent-sensitive, ensuring that string comparisons within the database are performed accurately according to the Metrix Sync CLI tool’s requirements.

Creating a compliant database

To create a compliant database, you can use the following SQL command:

CREATE DATABASE MetrixSync
COLLATE SQL_Latin1_General_CP1_CS_AS;

Securing the database

We leave the security configuration of the database to each individual organisation. The only requirement from the side of the Metrix Sync CLI tool, is an account that has sufficient privilges to create and maintain the neccesary schema, and populate the database with the necessary data. As a minimum, the tool’s user account needs to be a member of the following roles:

  • db_datareader
  • db_datawriter
  • db_ddladmin

To achieve the above, you can run:

ALTER ROLE db_datareader ADD MEMBER [metrix_cli_user];
ALTER ROLE db_datawriter ADD MEMBER [metrix_cli_user];
ALTER ROLE db_ddladmin ADD MEMBER [metrix_cli_user];

Replace [metrix_cli_user] with the actual username of the account you have created for the Metrix Sync CLI tool to uses.