Olo has developed the Engage Warehouse to empower clients to leverage all of their Olo data with the flexibility of Snowflake. This guide outlines the necessary instructions in order to connect to your Engage warehouse data share. This data share is a live connection to our warehouse that provides real-time data updates that can be queried upon.
The warehouse data share solution is provided by Snowflake. As a result, your data ingest method must be able to connect to a Snowflake database and run compatible SQL commands. Olo provisions a dedicated database, credentials, and server that is used exclusively by you.
Note: Snowflake Data Share eligibility requires the brand’s Snowflake instance to align with Olo’s Snowflake instance, which is hosted on AWS us-east-1. Olo may also provide Snowflake Reader access in this region upon request and in accordance with your contract deliverables.
Skip To:
Setup
Credentials
An Olo Engage representative is able to share the credentials in order for you to access your warehouse data share. These credentials will include the hostname, username, and password.
For data security purposes, these credentials should be kept highly confidential. Olo recommends that you enable IP Whitelisting on your account share. Please reach out to an Olo Engage representative if you would like to enable this feature.
Connect (Web UI)
- In a browser, go to your unique URL that was shared with you
- Go to the “Worksheet” tab
- Near the top right corner of the worksheet, select the proper Schema if not already selected
- Verify that you see a database/table tree view on the left side of the worksheet
Connect (CLI - Command Line)
- Install the SnowSQL client here
- Configure your credentials in accordance with the SnowSQL install guide
- Test and verify your connection
- Once connected, run the following commands:
- SHOW SCHEMAS;
- USE SCHEMA wisely_share_v1;
- SHOW TABLES;
- Verify you can see tables
Data Share Overview
Server Resources
Fetching data and running SQL commands on the warehouse data share is run on hardware provisioned by Olo within Snowflake. This server, by default, is provisioned at the smallest size. This is likely fine unless your use case requires on-demand data in large quantities. If you require additional server resources, please reach out to an Olo Engage representative.
By default, your provisioned server will go to “sleep” after 15 minutes of inactivity. Any new activity, such as running a SQL command, will incur a startup latency of around 20-30 seconds. This is handled automatically in the background. Please reach out to an Olo Engage representative if you want this to be turned off.
Versioning
Over time, Olo may make changes to the schema and tables in your data share. These changes are fully backwards compatible with any queries you may be running (i.e.: adding a new column to a table).
If Olo needs to make a change that is not backwards compatible, these changes are instead only introduced into a new schema version. All schemas in the database are prefixed with a version like “wisely_share_v1” and will increment by one each time.
Data Dictionary Reference
The Engage team has created a Data Dictionary reference page to outline the meaning of all data types provided within the data warehouse.