Skip to content

quarylabs/quary

Repository files navigation

quary

Quary Community

quary_core_image

What is Quary?

Quary enables teams to design, document, test and deploy data transformations to your SQL data stores. Quary is a SQL engine and CLI tool that lets you manage your data transformation projects with ease.

Teams use Quary to transform their raw data tables into actionable and trustworthy insights. Teams do so by layering well documented and tested transformations into useful insights ready for consumption. A Quary project is formed of a collection of these SQL SELECT statements, that build on top of each other.

Getting Started

Installation

The following Quary repository contains the core Quary library as well as the Quary CLI tool. The Quary CLI tool can be installed as following

Homebrew installation for macOS

Quary can be installed using Homebrew on macOS using the following command:

brew install quarylabs/quary/quary

Other installations

Other builds are available in the releases page to download.

Usage

Once installed, a sample project can be created and run as follows:

mkdir example # create an empty project folder
cd example
quary init    # initialize demo project with sample seeds & models inside current directory
quary compile # validate the project structure and model references without database
quary test -s # run defined tests against target database
quary build   # build and execute the model views/seeds against target database

Note that you will most likely want to use our Visual Studio Code extension to visualise the project.

Support

If you run into any problems using Quary, please let us know. We want Quary to be easy-to-use, so if you are getting confused, it is our fault, not yours. Create an issue and we'll be happy to help you out.