Cache Tool

The cache tool option within the Metrix Sync CLI allows users to generate a snapshot GeoPackage of the views from the EXISTING local SQL Server database configured with the Metrix Sync CLI tool. That is, it requires that the local SQL Server database has already been populated (and maintained) with the necessary Metrix data through a prior sync pull operation.

The GeoPackage file is optimised for fast read-only access to your Metrix data. It can be useful for end-user facing Geospatial Applications such as Pozi.

The cache tool guarantees the file structure within the GeoPackage, ensuring that it can be recreated without conflicting with the abovementioned Geospatial Applications.

To run a cache operation, use the following command, with the appropriate parameters specified:

./metrix-sync.exe cache --o <output_file_path> -osgeo <path_to_osgeo_tools> [-skip-errors (optional)]

Parameters

  • --o <output_file_path>: Specifies the path where the generated GeoPackage file will be saved. Please note, it is safest to wrap this path in quotes (mandatory if the path contains spaces).
  • -osgeo <path_to_osgeo_tools>: The cache tool relies on a set of OSGeo tools for performing the creation of the output GeoPackage file. A valid osgeo path is, for example, a QGIS installation directory (i.e. C:\Program Files\QGIS).
  • -skip-errors (optional): If specified, the tool will continue processing even if errors are encountered. This can be useful in gdal operations that may encounter non-critical errors, allowing the process to continue without interruption.
Note

If you are unsure about your OSGeo tools path, please reach out to our support team (support@metrixassets.com) for assistance in getting setup.