questdb 2.0.1__tar.gz → 2.0.3__tar.gz

{questdb-2.0.1 → questdb-2.0.3}/CHANGELOG.rst

@@ -3,7 +3,37 @@
 Changelog
 =========
 
-2.0.1 (2024-03-22)
+2.0.3 (2024-06-06)
+------------------
+
+Patch release with bug fixes. No breaking changes.
+
+Bug fixes
+~~~~~~~~~
+* HTTP timeout wasn't always being correctly applied in the downstream ``c-questdb-client`` dependency.
+* ``request_timeout > 0`` will now be enforced. This was always required, but would not error.
+* Fixed the source distribution "sdist" package: This allows the package to be installed from source
+  via "pip install" on previously unsupported platforms (YMMV).
+
+2.0.2 (2024-04-11)
+------------------
+
+Patch release with a performance bug fix. No breaking changes.
+
+Bug fixes
+~~~~~~~~~
+* Fixed the defaulting logic for ``auto_flush_rows`` parameter for HTTPS.
+  It is now correctly set to 75000 rows by default. The old incorrect default
+  of 600 rows was causing the sender to flush too often, impacting performance.
+  Note that TCP, TCPS and HTTP were not affected.
+
+Features
+~~~~~~~~
+* The sender now exposes the ``auto_flush`` settings as read-only properties.
+  You can inspect the values in use with ``.auto_flush``, ``.auto_flush_rows``,
+  ``.auto_flush_interval`` and ``.auto_flush_bytes``.
+
+2.0.1 (2024-04-03)
 ------------------
 
 Patch release with bug fixes, no API changes and some documentation tweaks.

{questdb-2.0.1 → questdb-2.0.3}/DEV_NOTES.rst

@@ -108,58 +108,44 @@ As this is very time-consuming, instead download all targets
 (except for Apple Silicon) from the CI.
 
 
-Checking `pip install` works
-----------------------------
-
-You can generally skip this if you used ``cibuildwheel`` as the tool did this
-already and ran tests against each built wheel.
+The "sdist" source distribution
+-------------------------------
 
-.. code-block:: bash
+This is a tarball containing all the sources necessary to build the package
+locally.
 
-    python3 -m pip install -e .
+Its contents are controlled by the ``MANIFEST.in`` file.
 
-The `-e` flag links to the current directory rather than copying.
+To test it:
 
 .. code-block:: bash
 
-    $ python3  sdist
-
-
-Uploading to PyPI
------------------
-
-Update the change log file that describes the latest changes in aggregate.
-
-.. code-block:: bash
-
-    vim CHANGELOG.rst
-
+    ./proj clean
+    ./proj sdist
+    python3 -m pip install dist/*.tar.gz --user -v
 
-Create a tag, update versions etc using ``bump2version``.
 
-For more command line options, see: https://pypi.org/project/bump2version/
+Checking `pip install` works
+----------------------------
 
-Note that here ``patch`` would bump from (for example) ``0.1.0`` to
-``0.1.1``. ``minor`` would bump from ``0.1.0`` to ``0.2.0`` and ``major``
-would bump from ``0.1.0`` to ``1.0.0``.
+You can generally skip this if you used ``cibuildwheel`` as the tool did this
+already and ran tests against each built wheel.
 
 .. code-block:: bash
 
-    bump2version --config-file .bumpversion.cfg patch
-
+    python3 -m pip install -e .
 
-Now make sure you push the tag or it will not show up in GitHub:
+The `-e` flag links to the current directory rather than copying.
 
 .. code-block:: bash
 
-    git push --tags
-
+    $ python3  sdist
 
-Once you've triple-checked everything is in ``dist/``, you can upload to PyPI.
 
-.. code-block:: bash
+Cutting a release
+-----------------
 
-    python3 -m twine upload dist/*
+This is a semi-automated process, covered in ``RELEASING.rst``.
 
 
 Debugging with on Linux

{questdb-2.0.1 → questdb-2.0.3}/MANIFEST.in

@@ -9,6 +9,13 @@ include proj
 recursive-include src *.html
 recursive-include src *.pxd
 recursive-include src *.pyx
+recursive-include src *.h
+recursive-include src *.inc
+recursive-include src *.py
+recursive-include src *.md
+recursive-include src *.pxi
+recursive-include src *.c
+graft pystr-to-utf8
 graft c-questdb-client
 prune c-questdb-client/src/tests/json_tests.rs
 prune c-questdb-client/.git

{questdb-2.0.1 → questdb-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: questdb
-Version: 2.0.1
+Version: 2.0.3
 Summary: QuestDB client library for Python
 Author-email: Adam Cimarosti <adam@questdb.io>
 License: Apache License 2.0
@@ -56,7 +56,7 @@ and full-connection encryption with
 Quickstart
 ==========
 
-The latest version of the library is 2.0.1 (`changelog <https://py-questdb-client.readthedocs.io/en/latest/changelog.html>`_).
+The latest version of the library is 2.0.3 (`changelog <https://py-questdb-client.readthedocs.io/en/latest/changelog.html>`_).
 
 ::
 

{questdb-2.0.1 → questdb-2.0.3}/README.rst

@@ -18,7 +18,7 @@ and full-connection encryption with
 Quickstart
 ==========
 
-The latest version of the library is 2.0.1 (`changelog <https://py-questdb-client.readthedocs.io/en/latest/changelog.html>`_).
+The latest version of the library is 2.0.3 (`changelog <https://py-questdb-client.readthedocs.io/en/latest/changelog.html>`_).
 
 ::
 

questdb-2.0.3/RELEASING.rst

@@ -0,0 +1,208 @@
+Cutting a new release
+=====================
+
+Overview
+--------
+
+We will collate the generated binaries from CI, together with a final
+binary we need to build manually from for MacOS ARM within a MacOS VM.
+
+We cut from a VM to use as old of a MacOS version as possible to ensure
+backwards compatibility with older MacOS versions.
+
+From the VM we will also bundle a source distribution and perform the final
+upload to PyPI.
+
+Bumping Version and updating Changelog
+--------------------------------------
+
+Create a new PR with the new changes in ``CHANGELOG.rst``.
+
+Make a commit and push the changes to a new branch.
+
+You also want to bump the version.
+
+This process is automated by the following command:
+
+.. code-block:: bash
+
+    bump2version --config-file .bumpversion.cfg --no-tag patch
+
+Here use:
+
+* ``patch`` to bump the version to the next patch version, e.g. 1.0.0 -> 1.0.1
+
+* ``minor`` to bump the version to the next minor version, e.g. 1.0.0 -> 1.1.0
+
+* ``major`` to bump the version to the next major version, e.g. 1.0.0 -> 2.0.0
+
+Now merge the PR with the title "Bump version: V.V.V → W.W.W".
+
+Note that CI will run all the ``cibuildwheel`` jobs which will in turn 
+generate the binaries for all the platforms, except for MacOS ARM.
+
+Double-check the date in the CHANGELOG
+--------------------------------------
+
+Open ``CHANGELOG.rst`` and ensure that the date next to the version you are releasing matches today's date. 
+If the CHANGELOG was created earlier, it might have an older date. If so, update it.
+
+Preparing the MacOS VM
+----------------------
+
+Skip if you already have the MacOS VM set up in UTM.
+
+.. warn::
+    
+    Releasing from an up to date MacOS install will not work as the binaries
+    may be incompatible with older MacOS versions.
+
+From a MacOS ARM computer install UTM.
+
+* Download from https://mac.getutm.app/
+* Install MacOS X 12.4 (Monterey). See https://docs.getutm.app/guest-support/macos/
+* Install Rust from https://rustup.rs/
+* Install Firefox
+* Install *all* OFFICIAL Python Releases from Python 3.8 onwards. Use the latest patch version for each minor release. 
+    * https://www.python.org/downloads/macos/
+    * Do NOT use Homebrew to install Python.
+    * Python 3.8.10 requires Rosetta, install it when prompted to do so. 
+
+* Optionally install VS Code
+
+Now clone the repository. The rest of the steps will assume this is done as so::
+
+    cd ~
+    mkdir -p questdb
+    cd questdb
+    git clone https://github.com/questdb/py-questdb-client.git
+    cd py-questdb-client
+    git submodule update --init --recursive
+
+Updating the MacOS VM
+---------------------
+
+Do this before every release.
+
+Inside the VM, open a terminal (or use the terminal Window in VSCode) and run the following commands::
+
+    cd ~/questdb/py-questdb-client
+    git checkout main
+    git pull
+    git submodule update --init --recursive
+
+    rustup update stable
+
+    /Library/Frameworks/Python.framework/Versions/3.8/bin/python3 \
+        -m pip install -U pip
+    /Library/Frameworks/Python.framework/Versions/3.8/bin/python3 \
+        -m pip install -U setuptools wheel twine Cython cibuildwheel pandas numpy pyarrow
+
+Smoke-testing the build
+-----------------------
+
+From ``~/questdb/py-questdb-client`` run the following commands::
+
+    ./proj clean
+    ./proj build
+    ./proj test
+
+
+Building the MacOS ARM binaries
+-------------------------------
+
+Clean and build the final binaries for each Python version::
+
+    ./proj clean
+    ./proj cibuildwheel
+
+This should have created new binaries in the ``dist/`` directory.
+
+Prepare the source distribution
+-------------------------------
+
+The source code distribution is for any other platforms that we don't have
+binaries for. I don't think it's _actually_ used by anyone, but it might get
+used by IDEs.
+
+.. code-block:: bash
+
+    python3 setup.py sdist
+
+Download the other binaries from CI
+-----------------------------------
+
+From the MacOS VM, From a terminal, run::
+
+    cd ~/Downloads
+    rm drop.zip
+    rm -rf drop
+
+Launch Firefox and log into GitHub and open the last (closed and merged) PR.
+
+Click on the "Checks" tab and open up the last "questdb.py-questdb-client (1)"
+check. There will be a link to the Azure DevOps page.
+
+The following link might also work: https://dev.azure.com/questdb/questdb/_build?definitionId=21&_a=summary
+
+If you open up the last run, you'll find a link called "1 published".
+This will redirect you to the "Publushed artifacts" page.
+
+There will be a "drop" directory.
+* Don't open it.
+* Instead use click on the three vertical dots on the right-hand
+side and select download artifacts.
+
+This will download a file called "drop.zip".
+
+double-check it in Finder: It will extract to a directory called "drop".
+
+Now from the terminal, run::
+
+    cd ~/questdb/py-questdb-client
+    cp -vr ~/Downloads/drop/* dist/
+
+
+Tagging the release
+-------------------
+
+In GitHub with a web browser create a new release with the tag "vX.Y.Z"
+(where X.Y.Z is the new version number).
+
+The release notes should be copied from the ``CHANGELOG.rst`` file,
+but reformatted as Markdown.
+
+
+Uploading to PyPI
+-----------------
+
+Now the MacOS VM has all the binaries and the source distribution, ready to be
+uploaded to PyPI.
+
+This is a good time to double-check you can log into PyPI and have set up an
+API token. If you don't have one (or lost it), you can create a new one here:
+https://pypi.org/manage/account/ (scroll down to "API tokens").
+
+Once you've triple-checked everything is in ``dist/``, you can upload to PyPI.
+
+.. code-block:: bash
+
+    python3 -m twine upload dist/*
+
+This will prompt you for your PyPI username and token.
+
+Once the upload is complete, you can check the PyPI page to see if the new
+release is there: https://pypi.org/project/questdb/
+
+
+Updating the docs
+-----------------
+
+Log into ReadTheDocs and trigger a new build for the project.
+
+https://readthedocs.org/dashboard/py-questdb-client/users/
+
+Watch it to ensure there are no errors.
+
+Once the build is complete, COMMAND-SHIFT-R to refresh the page (without cache)
+and check the new version is there.

{questdb-2.0.1 → questdb-2.0.3}/c-questdb-client/.bumpversion.cfg

@@ -1,6 +1,6 @@
 [bumpversion]
-current_version = 4.0.0
-commit = True
+current_version = 4.0.2
+commit = False
 tag = False
 
 [bumpversion:file:CMakeLists.txt]
@@ -15,10 +15,6 @@ replace = questdb-rs/{new_version}/
 search = version = "{current_version}"
 replace = version = "{new_version}"
 
-[bumpversion:file:questdb-rs/README.md]
-search = questdb-rs = "{current_version}"
-replace = questdb-rs = "{new_version}"
-
 [bumpversion:file:./questdb-rs/README.md]
 search = questdb-rs/{current_version}/
 replace = questdb-rs/{new_version}/

{questdb-2.0.1 → questdb-2.0.3}/c-questdb-client/CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.15.0)
-project(c-questdb-client VERSION 4.0.0)
+project(c-questdb-client VERSION 4.0.2)
 
 set(CPACK_PROJECT_NAME ${PROJECT_NAME})
 set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})

{questdb-2.0.1 → questdb-2.0.3}/c-questdb-client/README.md

@@ -4,7 +4,7 @@
 This library makes it easy to insert data into [QuestDB](https://questdb.io/).
 
 This client library implements the [InfluxDB Line Protocol](
-https://questdb.io/docs/reference/api/ilp/overview/) (ILP) over TCP or HTTP.
+https://questdb.io/docs/reference/api/ilp/overview/) (ILP) over HTTP and TCP.
 
 * Implementation is in Rust, with no additional
   [run-time or link-time dependencies](doc/BUILD.md#pre-requisites-and-dependencies)
@@ -24,7 +24,7 @@ streaming use cases).
 | Protocol | Record Insertion Reporting | Data Insertion Performance |
 | -------- | -------------------------- | -------------------------- |
 | **[ILP/HTTP](https://questdb.io/docs/reference/api/ilp/overview/)** | Transaction-level (on flush) | **Excellent** |
-| [ILP/TCP](https://questdb.io/docs/reference/api/ilp/overview/)| Errors in logs; Disconnect on error | **Best** (tolerates higher latency networks) |
+| [ILP/TCP](https://questdb.io/docs/reference/api/ilp/overview/)| Errors in logs; Disconnect on error | **Best** (tolerates higher-latency networks) |
 | [CSV Upload via HTTP](https://questdb.io/docs/reference/api/rest/#imp---import-data) | Configurable | Very Good |
 | [PostgreSQL](https://questdb.io/docs/reference/api/postgres/) | Transaction-level | Good |
 
@@ -33,7 +33,7 @@ See the [flush troubleshooting](doc/CONSIDERATIONS.md) docs for more details on
 how to debug ILP/TCP.
 
 For an overview and code examples, see the
-[ILP page of the developer docs](https://questdb.io/docs/develop/insert-data/#influxdb-line-protocol).
+[InfluxDB Line Protocol page of the developer docs](https://questdb.io/docs/develop/insert-data/#influxdb-line-protocol).
 
 To understand the protocol in more depth, consult the
 [protocol reference docs](https://questdb.io/docs/reference/api/ilp/overview/).

{questdb-2.0.1 → questdb-2.0.3}/c-questdb-client/doc/DEPENDENCY.md

@@ -43,7 +43,8 @@ In all examples below, we will attempt to compile:
 
 int main()
 {
-    questdb::ingress::line_sender sender{"localhost", 9009};
+    auto sender = questdb::ingress::line_sender::from_conf(
+        "http::addr=localhost:9000;");
     return 0;
 }
 ```

questdb-2.0.3/c-questdb-client/doc/RELEASING.md

@@ -0,0 +1,90 @@
+# How to publish a new release
+
+## 1. Ensure you're fully in sync with the remote repo
+
+```bash
+git switch main
+git pull
+git status
+```
+
+## 2. Create the release branch
+
+```bash
+git switch -c vX.Y.Z
+```
+
+## 3. Update all the occurrences of the version in the repo
+
+```bash
+bump2version --config-file .bumpversion.cfg <increment>
+```
+
+The `increment` parameter can be:
+
+- `patch`
+- `minor`
+- `major`
+
+Use the one appropriate to the version increment you're releasing.
+
+## 4. Refresh `Cargo.lock`
+
+```bash
+cd questdb-rs-ffi
+cargo clean
+cargo build
+```
+
+## 5. Merge the release branch to master
+
+```bash
+git commit -a -m "Bump version: <current> → <new>"
+git push
+```
+
+Replace the `<current>` and `<new>` placeholders!
+
+Create and merge a PR with the same name: "Bump version: \<current\> → \<new\>"
+
+## 6. Tag the new version
+
+Once the PR is merged, pull main and add the version tag:
+
+```bash
+git switch main
+git pull --prune
+git tag X.Y.Z
+git push --tags
+```
+
+## 7. Create a new release on GitHub
+
+[GitHub Release Page](https://github.com/questdb/c-questdb-client/releases)
+
+On that page you'll see all the previous releases. Follow their manually-written
+style, and note that the style differs between patch, minor, and major releases.
+
+## 8. Publish the Rust crate to crates.io
+
+Ensure once more you're fully in sync with the remote repo:
+
+```bash
+git switch main
+git pull
+git status
+```
+
+Publish the crate:
+
+```bash
+cd questdb-rs
+cargo publish --dry-run --token [your API token from crates.io]
+cargo publish --token [your API token from crates.io]
+```
+
+## 9. Ensure the docs are online on docs.rs
+
+The release is immediately visible on crates.io, but there's a delay until it
+becomes available on [https://docs.rs/](docs.rs). Watch that site and ensure it
+appears there.

{questdb-2.0.1 → questdb-2.0.3}/c-questdb-client/doc/SECURITY.md

@@ -35,7 +35,7 @@ A few important technical details on TLS:
     are managed centrally.
 
 For API usage:
-* Rust: `SenderBuilder`'s [`auth`](https://docs.rs/questdb-rs/4.0.0/questdb/ingress/struct.SenderBuilder.html#method.auth)
-  and [`tls`](https://docs.rs/questdb-rs/4.0.0/questdb/ingress/struct.SenderBuilder.html#method.tls) methods.
+* Rust: `SenderBuilder`'s [`auth`](https://docs.rs/questdb-rs/4.0.2/questdb/ingress/struct.SenderBuilder.html#method.auth)
+  and [`tls`](https://docs.rs/questdb-rs/4.0.2/questdb/ingress/struct.SenderBuilder.html#method.tls) methods.
 * C: [examples/line_sender_c_example_auth.c](../examples/line_sender_c_example_auth.c)
 * C++: [examples/line_sender_cpp_example_auth.cpp](../examples/line_sender_cpp_example_auth.cpp)