Configure Sync Tool
Configuring the Metrix Sync CLI Sync tool is (typically) a one-time process that involves supplying the connection parameters for the SQL Server database that will store the locally synced Metrix data. To configure the tool, simply run the following command and follow the prompts with connection details:
./metrix-sync.exe sync configureYou will be asked for the following details:
- SQL Server Host: the name of the database server where the SQL Server instance is running.
- Instance Name: the name of the SQL Server instance to connect to - leave this blank in most cases.
- Port Number: the port number on which the SQL Server instance is listening - leave this blank to use the default port (1433).
- Database Name: the name of the database where the Metrix data will be stored. Ensure that this database has
the required collation (
SQL_Latin1_General_CP1_CS_AS). - Geometry EPSG: the EPSG code for the spatial reference system to be used for storing geometry data in the database. This should match the EPSG code used within your Metrix environment for geometry data.
- Authentication Mode: the authentication mode to be used for connecting to the SQL Server instance. This can be either ‘integrated’ for Windows Authentication or ‘sql’ for SQL Server Authentication.
- Username (if using SQL Server Authentication): the username to be used for connecting to the SQL Server instance.
- Password (if using SQL Server Authentication): the password to be used for connecting to the SQL Server instance.
Once all the required details are provided, the Metrix Sync CLI will attempt to connect to the specified SQL Server instance. If it cannot connect, an error will be returned. If no error is returned, you’re good to go.
Much like your API token, the configuration for the SQL Server connection is specific to your user account. If another user logs onto the machine, they will need to configure the sync tool separately with their own connection details.