Skip to content

Commit 0c70977

Browse files
committed
Updated readmes
1 parent 3d9ab0e commit 0c70977

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,21 @@ For an overview and code examples, see the
4242
To understand the protocol in more depth, consult the
4343
[protocol reference docs](https://questdb.io/docs/reference/api/ilp/overview/).
4444

45+
## Protocol Versions
46+
47+
The library supports the following ILP protocol versions.
48+
49+
These protocol versions are supported over both HTTP and TCP.
50+
51+
If you use HTTP, the library will automatically detect the server's
52+
latest supported protocol version and use it. If you use TCP, you can specify the
53+
`protocol_version=N` parameter when constructing the `Sender` object.
54+
55+
| Version | Description | Server Comatibility |
56+
| ------- | ------------------------------------------------------- | --------------------- |
57+
| **1** | Over HTTP it's compatible InfluxDB Line Protocol (ILP) | All QuestDB versions |
58+
| **2** | 64-bit floats sent as binary, adds n-dimentional arrays | 8.4.0+ (2023-10-30) |
59+
4560
## Getting Started
4661

4762
To get started, read the language-specific guides.

questdb-rs/README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,20 @@ Ingestion Line Protocol (ILP) over either HTTP (recommended) or TCP.
99
* [QuestDB Database docs](https://questdb.io/docs/)
1010
* [Docs on Ingestion Line Protocol](https://questdb.io/docs/reference/api/ilp/overview/)
1111

12-
When connecting to QuestDB over HTTP, the library will auto-detect the server's
13-
latest supported version and use it. Version 1 is compatible with
14-
the [InfluxDB Line Protocol](https://docs.influxdata.com/influxdb/v2/reference/syntax/line-protocol/).
12+
## Protocol Versions
13+
14+
The library supports the following ILP protocol versions.
15+
16+
These protocol versions are supported over both HTTP and TCP.
17+
18+
If you use HTTP, the library will automatically detect the server's
19+
latest supported protocol version and use it. If you use TCP, you can specify the
20+
`protocol_version=N` parameter when constructing the `Sender` object.
21+
22+
| Version | Description | Server Comatibility |
23+
| ------- | ------------------------------------------------------- | --------------------- |
24+
| **1** | Over HTTP it's compatible InfluxDB Line Protocol (ILP) | All QuestDB versions |
25+
| **2** | 64-bit floats sent as binary, adds n-dimentional arrays | 8.4.0+ (2023-10-30) |
1526

1627
## Quick Start
1728

@@ -78,6 +89,9 @@ These features are opt-in:
7889
certificates store.
7990
* `insecure-skip-verify`: Allows skipping server certificate validation in TLS
8091
(this compromises security).
92+
* `ndarray`: Enables integration with the `ndarray` crate for working with
93+
n-dimensional arrays. Without this feature, you can still send slices,
94+
or integrate custom array types via the `NdArrayView` trait.
8195

8296
## C, C++ and Python APIs
8397

0 commit comments

Comments
 (0)