ZenotiHelp

Handle schema changes and upgrades

ZTZenoti Docs Team Updated September 11, 2026 3 min readGuide

As Zenoti evolves, new columns, new tables, and modified schemas are periodically introduced. This article explains how to use the SchemaFull and SchemaUpgrade folders in your S3 bucket to set up your warehouse correctly and stay current with schema changes over time.

Before you begin

  • Your organization must have Analytics β€” Amazon S3 enabled.
  • You need read access to your S3 bucket.
  • You need database administration permissions to alter table structures and execute schema scripts in your data warehouse.
  • Take a backup of your data warehouse before applying an upgrade.

SchemaFull β€” initial setup

Location: <your-bucket>/SchemaFull/

The SchemaFull folder contains one schema definition file (.txt format) per table. Each file lists the column names, data types, and order for that table.

Use SchemaFull to:

  • Create all table structures in your data warehouse during initial setup.
  • Verify the column layout for any table when loading CSV data.

SchemaFull reflects the complete, current schema for your subscription. Apply it once when setting up your warehouse. You do not need to re-apply SchemaFull after each data refresh.

After running the SchemaFull scripts, verify that every dimension table (Bi_Dim*) and fact table (Bi_Fact*) was created. A complete star schema contains approximately 97 dimension tables and 57 fact tables.

SchemaUpgrade β€” ongoing schema changes

Location: <your-bucket>/SchemaUpgrade/

The SchemaUpgrade folder contains versioned subfolders. Each subfolder corresponds to a Zenoti release that introduced schema changes.

Example structure:

SchemaUpgrade/
  v2.1/
    Bi_FactInvoiceItem_upgrade.txt
    Bi_DimEmployee_upgrade.txt
  v2.2/
    Bi_DimCenter_upgrade.txt
    Bi_FactAppointment_upgrade.txt
    Bi_FactPackageRedemption_upgrade.txt   <- new table

Upgrade files describe what changed: new columns added to existing tables, new tables introduced, or data type modifications.

What Zenoti may change in an upgrade

Change type Description
New columns on existing tables Additional attributes added to a fact or dimension table
New tables Entirely new fact, dimension, or consolidated tables for new subject areas
Data type changes Column precision or type adjustments (rare)

Zenoti does not remove or rename existing columns in normal upgrades. This means your existing queries and integrations remain stable even when new columns are added.

How to apply a schema upgrade

  1. Check the SchemaUpgrade folder for any new version subfolders you have not yet applied.

  2. Review the upgrade files in each new subfolder. Each file describes the changes for that table β€” read these carefully before making any changes to your warehouse.

  3. Apply the changes to your data warehouse:

  • For new columns on existing tables: use ALTER TABLE... ADD COLUMN in your warehouse.

  • For new tables: create the table using the structure defined in the upgrade file.

    Execute the upgrade scripts in sequence order.

  1. Resume consuming incremental data. Once your schema is updated, new data files that include the new columns load correctly. Confirm that your BI tools can still connect to the updated schema and that existing queries and reports continue to return results.

Apply upgrades before loading new data that uses new columns. If you load a data file containing new columns before adding those columns to your warehouse table, the load may fail or silently drop data depending on your loader configuration.

Backward compatibility

Zenoti uses explicit column lists in all data exports β€” data files never use SELECT * style exports. This means:

  • Existing columns are always present and in a stable position.
  • New columns are appended at the end of the file.
  • Your existing queries continue to work even if you have not yet applied the latest schema upgrade, as long as you are not querying the new columns.

However, new columns appear as NULL in your warehouse rows until you apply the upgrade and the next data refresh populates values for those columns.

Best practices

  • Check SchemaUpgrade regularly. A weekly check is recommended, or review the folder after any Zenoti release notification.
  • Apply upgrades before loading new data that depends on the new columns or tables.
  • Keep a log of applied schema versions. Maintain a simple table or text file in your environment that records which SchemaUpgrade versions you have applied and when.
  • Test upgrades in a staging environment first before applying to production, especially for any upgrade that modifies existing columns.
  • New columns start as NULL. After applying an upgrade, rows already in your warehouse have NULL for new columns until the next data refresh repopulates them.

Quick reference

Folder When to use
SchemaFull/ Initial setup β€” create all tables once
SchemaUpgrade/ Ongoing β€” apply versioned changes after Zenoti releases
Was this article helpful?
Your feedback helps us improve our documentation.