Sample Project


A Quary project is a collection of seeds, models, and tests all of which work in tandem to wrangle and analyze your data. Don't worry about those words for now, we'll get to them. The following Getting Started guide will help you to get set up in the fastest way possible. It's not necessarily the way we recommend you setting your own project, but it should show you Quary in action in the browser.

Note: You will need a GitHub account for this guide, this guide assumes you already have one.

Opening the sample project

Open the template repository in GitHub's browser editor by clicking the link. This will open the repository in GitHub's browser editor. It should look like the following image: the repo opened on the models/shifts_summary.sql file.

First model

Installing Quary

After having opened the repository in the browser editor, you should see a prompt to install the Quary extension. It may take a little moment. If you don't see this prompt, you can install the extension by searching for Quary in the "extensions" tab. The prompt looks like this. After

Install extensions

Signing in to Quary

After having installed the Quary extension, three icons will appear at the top right of the browser editor in the model editor view first opened in the previous step.

First model

If you click on the book icon, which opens the models documentation view, you will be prompted to sign in to Quary. Click the "Sign in" button and follow the prompts to sign in to Quary. Once you have signed in go back to the model editor view. It will look something a little like below.

Confirm code

Model documentation

Once signed in, try clicking on the book icon again. This time you should see the documentation for the model. It should look a little something like

Documentation view

Scrolling in this view, you should see the documentation for the model: the model's columns/tests/docs, the model's lineage as well as the results returned from the model. Now that you've seen the documentation for the model, it's time to try running your own model.