Skip to main content

Python client for Dremio. See

Project description

Dremio client Documentation Status Updates Codacy Codecov

The un-official python client for Dremio’s REST API. This enables both administrators and data scientists to get the most out of Dremio in Python


  • Cross platform support

  • All Pythons between 2.7 - 3.7 supported

  • Full support for Dremio’s REST API

  • Optional Support for Dremio’s ODBC or experimental Arrow Flight capabilities

  • Rich config file support via confuse yaml config library. Simple to create a client (config stored in a yaml file)

    from dremio_client import init
    client = init() # initialise connectivity to Dremio via config file
    catalog = # fetch catalog
    vds = # fetch a specific dataset
    df = vds.query() # query the first 1000 rows of the dataset and return as a DataFrame
    pds = catalog.source.pds.get() # fetch a physical dataset
    pds.metadata_refresh() # refresh metadata on that dataset
  • CLI interface for integration with scripts

    $ dremio_client query --sql 'select * from sys.options'
    $ dremio_client refresh-metadata --table ''
  • Catalog autocompletion in Jupyter Notebooks


This is still alpha software and is relatively incomplete. Contributions in the form of Github Issues or Pull requests are welcome. See CONTRIBUTING


  • put, delete and post
  • add reflections into catalog
  • test for larger spaces and ensure it doesnt fetch everytihgn if we hit directly
  • search
  • docs
  • logging
  • handle exceptions correctly in cli
  • osx & appveyor
  • testing


0.1.0 (2019-07-04)

  • First code, unreleased.

0.2.4 (2019-08-13)

  • Alpha quality release with partial implementation of features. First PyPI release.

0.2.4 (2019-08-14)

  • Beta quality release for GET based endpoints

0.5.0 (2019-10-30)

  • Most endpoint supported
  • flight support with tls & auth
  • minor bugfixes

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for dremio-client, version 0.5.0
Filename, size File type Python version Upload date Hashes
Filename, size dremio_client-0.5.0-py2.py3-none-any.whl (42.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size dremio_client-0.5.0.tar.gz (3.5 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page