https://github.com/questdb/py-questdb-client

Python client for QuestDB InfluxDB Line Protocol
https://github.com/questdb/py-questdb-client

client-library pandas python python3 questdb questdb-ilp-client

Last synced: 9 months ago
JSON representation

Python client for QuestDB InfluxDB Line Protocol

• Host: GitHub
• URL: https://github.com/questdb/py-questdb-client
• Owner: questdb
• License: apache-2.0
• Created: 2022-06-13T16:15:57.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T12:11:18.000Z (about 2 years ago)
• Last Synced: 2024-04-24T05:23:08.402Z (about 2 years ago)
• Topics: client-library, pandas, python, python3, questdb, questdb-ilp-client
• Language: Python
• Homepage: https://py-questdb-client.readthedocs.io
• Size: 448 KB
• Stars: 47
• Watchers: 6
• Forks: 7
• Open Issues: 12
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
=================================

QuestDB Client Library for Python

=================================

This is the official Python client library for `QuestDB `_.

This client library implements QuestDB's variant of the

`InfluxDB Line Protocol `_

(ILP) over HTTP and TCP.

ILP provides the fastest way to insert data into QuestDB.

This implementation supports `authentication

`_

and full-connection encryption with

`TLS `_.

Install

=======

The latest version of the library is **3.0.0** (`changelog `_).

::

    python3 -m pip install -U questdb[dataframe]

Quickstart

==========

Start by `setting up QuestDB `_ .

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],

        # NumPy float64 arrays are supported from v3.0.0rc1 onwards.

        # Note that requires QuestDB server >= 9.0.0 for array support

        'ord_book_bids': [

            np.array([2615.54, 2618.63]),

            np.array([39269.98, 39270.00])

        ],

        '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,

                # NumPy float64 arrays are supported from v3.0.0rc1 onwards.

                # Note that requires QuestDB server >= 9.0.0 for array support

                'ord_book_bids': np.array([2615.54, 2618.63]),

            },

            at=TimestampNanos.now())

        sender.flush()

To connect via the `older TCP protocol `_, set the

`configuration string `_ 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 `_

guide.

Links

=====

* `Core database documentation `_

* `Python library documentation `_

* `GitHub repository `_

* `Package on PyPI `_

Community

=========

Stop by our `Community Forum `_ to 

chat with the QuestDB team.

You can also `sign up to our mailing list `_

to get notified of new releases.

License

=======

The code is released under the `Apache License 2.0

`_.