questdb

================================= QuestDB Client Library for Python

This is the official Python client library for QuestDB <https://questdb.io>_.

This client library implements QuestDB's variant of the InfluxDB Line Protocol <https://questdb.io/docs/reference/api/ilp/overview/>_ (ILP) over HTTP and TCP.

ILP provides the fastest way to insert data into QuestDB.

This implementation supports authentication <https://py-questdb-client.readthedocs.io/en/latest/conf.html#authentication>_ and full-connection encryption with TLS <https://py-questdb-client.readthedocs.io/en/latest/conf.html#tls>_.

Quickstart

The latest version of the library is 2.0.3 (changelog <https://py-questdb-client.readthedocs.io/en/latest/changelog.html>_).

::

python3 -m pip install -U questdb[dataframe]

Please start by setting up QuestDB <https://questdb.io/docs/quick-start/>_ . Once set up, you can use this library to insert data.

The most common way to insert data is from a Pandas dataframe.

.. code-block:: python

import pandas as pd
from questdb.ingress import Sender

df = pd.DataFrame({
    'symbol': pd.Categorical(['ETH-USD', 'BTC-USD']),
    'side': pd.Categorical(['sell', 'sell']),
    'price': [2615.54, 39269.98],
    'amount': [0.00044, 0.001],
    'timestamp': pd.to_datetime(['2021-01-01', '2021-01-02'])})

conf = f'http::addr=localhost:9000;'
with Sender.from_conf(conf) as sender:
    sender.dataframe(df, table_name='trades', at='timestamp')

You can also send individual rows. This only requires a more minimal installation::

python3 -m pip install -U questdb

.. code-block:: python

from questdb.ingress import Sender, TimestampNanos

conf = f'http::addr=localhost:9000;'
with Sender.from_conf(conf) as sender:
    sender.row(
        'trades',
        symbols={'symbol': 'ETH-USD', 'side': 'sell'},
        columns={'price': 2615.54, 'amount': 0.00044},
        at=TimestampNanos.now())
    sender.flush()

To connect via the older TCP protocol <https://py-questdb-client.readthedocs.io/en/latest/sender.html#ilp-tcp-or-ilp-http>, set the configuration string <https://py-questdb-client.readthedocs.io/en/latest/conf.html> to:

.. code-block:: python

conf = f'tcp::addr=localhost:9009;'
with Sender.from_conf(conf) as sender:
    ...

You can continue by reading the Sending Data Over ILP <https://py-questdb-client.readthedocs.io/en/latest/sender.html>_ guide.

Links

• Core database documentation <https://questdb.io/docs/>_

• Python library documentation <https://py-questdb-client.readthedocs.io/>_

• GitHub repository <https://github.com/questdb/py-questdb-client>_

• Package on PyPI <https://pypi.org/project/questdb/>_

Community

Stop by our Community Forum <https://community.questdb.io>_ to chat with the QuestDB team.

You can also sign up to our mailing list <https://questdb.io/contributors/>_ to get notified of new releases.

License

The code is released under the Apache License 2.0 <https://github.com/questdb/py-questdb-client/blob/main/LICENSE.txt>_.