Cinchy Platform Documentation
Cinchy v5.8
Search
⌃K
Comment on page

Cinchy Upgrade Utility

This page details information on the Cinchy Upgrade Utility.

Overview

The Cinchy Upgrade Utility was first introduced in v5.2 to ease a mandatory INT to BigInt upgrade. This tool has continued to be used in subsequent releases as an easy way to deploy necessary changes to your Cinchy platform.

Considerations

  • Upgrades will also be specified on the applicable Upgrade Guide page for each release.
  • Depending on your upgrade path, certain upgrades must be performed in sequential and/or specific order. This will be clearly marked in the "Overview and Considerations" section.
    • For example: To go from v5.1 to v5.5, you would first have to run the 5.2 upgrade utility and deploy the release. Once validated, you would then run the 5.5 upgrade and deploy that version.
  • Not all new releases will have changes that require the utility to be run. Review the table in section 4 for the full list.

Prerequisites

  • You will need to run this process as a user with admin/dbowner privileges to your database.
  • You will need to have .NET Core 6.0.x installed on the machine that you will run the utility on.
  • Retrieve the Upgrade Utility from the Cinchy Releases table.

Upgrades

Release
Upgrade
Kubernetes Upgrade
IIS Upgrade
5.2
5.5

Overview and considerations

v5.2: INT to BigInt
Overview
Cinchy v5.2 introduced the update from INT to BigInt data types to increase the number of possible Cinchy IDs that can be generated. This in turn allows the creation of more records within one table, so that you can create and manage larger data sets.
Previous Limit: 2,147,483,647 (2^31-1) Cinchy IDs per table
Updated Limit: 9,223,372,036,854,775,807 (2^63-1) Cinchy IDs per table
This upgrade is REQUIRED** when upgrading from v5.1 or lower to v5.2 or higher.**
Considerations
  • If you are upgrading from any non-5.x version (3.x or 4.x), we recommend first upgrading to v5.1.4 to process the major database change. Once v5.1.4 has been deployed, you may run the 5.2 utility upgrade.
  • To run the 5.2 upgrade, use the -v "5.2" flag in the upgrade utility. Remember to deploy the release once the upgrade is validated.
v5.5: 4000 Character Bug
Overview
To upgrade to Cinchy version 5.5, you must run the Upgrade Utility to fix a row-breaking issue that could be triggered on cells with over 4000 characters, where you are unable to update any column in your record.
This upgrade is REQUIRED when upgrading to Cinchy v5.5.
Considerations
  • If you are upgrading from any version lower than 5.2, you must first perform the v5.2 INT to BigInt upgrade and deploy that release.
  • To run the 5.5 upgrade, use the -v "5.5" flag in the upgrade utility. Remember to deploy the release once the upgrade is validated.

Upgrade instructions

We recommend you follow this process during off-peak hours.
  1. 1.
    Turn off your Cinchy platform. (Note: This step is only required for the 5.2 upgrade)
    1. 1.
      In a Kubernetes deployment, you can do so via ArgoCD.​
    2. 2.
      In an IIS Deployment:
      1. 1.
        Open your Windows Services Panel.
      2. 2.
        Select IIS Admin Service.
      3. 3.
        Stop the service.
      4. 4.
        Right-click IIS Admin Service and select Properties.
      5. 5.
        Change 'Start Up Type' to 'Disabled'.
  2. 2.
    Create a backup snapshot of your platform.
    1. 1.
      In a Kubernetes deployment on AWS, you can follow the documentation here.​
    2. 2.
      In a Kubernetes deployment on Azure, you can follow the documentation here.​
    3. 3.
      In an IIS Deployment, you can follow the documentation here.​
  3. 3.
    Retrieve the Upgrade Utility from the Cinchy Releases table if you haven't already.
  4. 4.
    Run the following command through a command window as an admin/dbowner, using the table below as a guide.
dotnet cinchy.upgrade-utility.dll -d "TSQL" -s "Server=LAPTOP-4SUPR0L6;Database=T6;User ID=cinchy;Password=cinchy;Trusted_Connection=False;Connection Timeout=30;Min Pool Size=10;Encrypt=False" -v "5.2"
Value
Description
-d
Mandatory. Database type. This can be either TSQL or PGSQL.
-s
Mandatory. Connection String. You must provide the unencrypted connection string for your database.
-v
Mandatory. This specifies the upgrade version that you wish to deploy. Ex: specifying "5.2" will run the 5.2 upgrade.
-c
Optional and not recommended to be used on your first run of the utility. This "clean up" value will delete any extra metadata the application created on the database
  1. 5.
    You will see the below progress bar as your upgrade completes (Image 1). Once it's done, you will see a VALIDATION PASSED check.
Tip: Click on the image below to enlarge it.
Image 1: You will see the below progress bar as your upgrade completes
If there are any errors during execution or your validation fails, we suggest that you restore your database from the backup and contact Cinchy support.
Note: You must deploy whichever version of the platform you ran the upgrade utility for.
  1. 7.
    If it was turned off in step 1, turn your Cinchy platform back on.
    1. 1.
      In a Kubernetes deployment, you can do so via Argo CD​
    2. 2.
      In an IIS deployment:
      1. 1.
        Open your Windows Services Panel.
      2. 2.
        Select IIS Admin Service.
      3. 3.
        Start the service.
      4. 4.
        Right-click IIS Admin Service and select Properties.
      5. 5.
        Change 'Start Up Type' to 'Enabled'.
Upgrade guide - Previous
Upgrade Cinchy
Next
Kubernetes upgrades
Last modified 2mo ago