Getting started

QueryZen ships a Python library to use and manage your Zens, the library has full feature parity with the HTTP api, we recommend that you use it if you are using python.

Installation

pipx

pipx install queryzen

poetry

poetry add queryzen

uv

uv add queryzen

Important

The queryzen package connects to the QueryZen backend, see [todo add link] on how to quickly get started.

Specify backend url

import os
os.environ['QUERYZEN_API_URL'] = 'https://yourqueryzenapi:8499'

By default, it uses 'http://localhost:8000'.

See [todo add link] for more constants.

Creating a Zen.

from queryzen import QueryZen

qz = QueryZen()

qz.create(collection='prod',
          name='myzen',
          query='select * from tbl1 where val > :val')

Getting a Zen.

from queryzen import QueryZen

qz = QueryZen()

zen = qz.get('myzen', collection='prod')

Running a Zen.

from queryzen import QueryZen

qz = QueryZen()

zen = qz.get('myzen', collection='prod')

result = qz.run(zen, val=123)

Deleting a Zen.

from queryzen import QueryZen

qz = QueryZen()

zen = qz.get('myzen', collection='prod')

qz.delete(zen)