Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

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


  • see issues


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.3.0 (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

0.6.3 (2020-01-29)

  • All endpoints supported
  • lots of bugfixes
  • utilities for building spaces/folders vds
  • removed recordclass library in favor of attrs

0.8.4 (2020-01-29)

  • history re-written

0.8.8 (2020-02-19)

  • minor bug fixes

0.8.9 (2020-02-19)

  • ensure use correct name for Spaces

0.8.11 (2020-03-09)

  • bug fixes when creating sources and folders

0.9.2 (2020-03-17)

  • add promote endpoint
  • update versions from pyup

0.10.1 (2020-03-19)

  • fix ssl verify flag in cli

0.11.1 (2020-04-09)

  • a number of bug fixes and improvements from the community

0.12.0 (2020-04-22)

  • add graph endpoint and cli flag
  • add more detailed exception handling

0.12.1 (2020-05-04)

  • few bug fixes and API extensions

0.13.0 (2020-05-21)

  • add version flag
  • upgrades and additions to some commands

0.13.1 (2020-05-21)

  • simplify delete cli command

0.13.2 (2020-05-22)

  • bugfixes

0.13.3 (2020-09-07)

  • fix wlm bug
  • bump dependencies

0.13.6 (2020-09-16)

  • add new apis
  • version bumps

0.14.0 (2021-04-01)

  • add new apis
  • version bumps
  • docs updates
  • fix to query to produce correct pandas data frame
  • fix to cli, dup args

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.14.0
Filename, size File type Python version Upload date Hashes
Filename, size dremio_client-0.14.0-py2.py3-none-any.whl (49.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size dremio_client-0.14.0.tar.gz (3.5 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page