Skip to content

Commit 1272583

Browse files
ideomaideoma
authored
build: release 3.0.0 (#39)
1 parent 4784a7f commit 1272583

File tree

3 files changed

+37
-26
lines changed

3 files changed

+37
-26
lines changed

‎README.md‎

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -138,30 +138,41 @@ The config string format is:
138138
{http/https/tcp/tcps}::addr={host}:{port};key1=val1;key2=val2;keyN=valN;
139139
```
140140

141-
| Name | Default | Description |
142-
|--------------------------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
143-
| `protocol` (schema) | `http` | The transport protocol to use. Options are http(s)/tcp(s). |
144-
| `addr` | `localhost:9000` | The {host}:{port} pair denoting the QuestDB server. By default, port 9000 for HTTP, port 9009 for TCP. |
145-
| `auto_flush` | `on` | Enables or disables auto-flushing functionality. By default, the buffer will be flushed every 75,000 rows, or every 1000ms, whichever comes first. |
146-
| `auto_flush_rows` | `75000 (HTTP)` `600 (TCP)` | The row count after which the buffer will be flushed. Effectively a batch size. |
147-
| `auto_flush_bytes` | `Int.MaxValue` | The byte buffer length which when exceeded, will trigger a flush. |
148-
| `auto_flush_interval` | `1000` | The millisecond interval, which once has elapsed, the next row triggers a flush. |
149-
| `init_buf_size` | `65536` | The starting byte buffer length. Overflowing this buffer will cause the allocation `init_buf_size` bytes (an additional buffer). |
150-
| `max_buf_size` | `104857600` | Maximum size of the byte buffer in bytes. If exceeded, an exception will be thrown. |
151-
| `username` | | The username for authentication. Used for Basic Authentication and TCP JWK Authentication. |
152-
| `password` | | The password for authentication. Used for Basic Authentication. |
153-
| `token` | | The token for authentication. Used for Token Authentication and TCP JWK Authentication, needs additional reference to `net-questdb-client-tcp-auth` assembly |
154-
| `token_x` | | Un-used. |
155-
| `token_y` | | Un-used. |
156-
| `tls_verify` | `on` | Denotes whether TLS certificates should or should not be verifed. Options are on/unsafe_off. |
157-
| `tls_ca` | | Un-used. |
158-
| `tls_roots` | | Used to specify the filepath for a custom .pem certificate. |
159-
| `tls_roots_password` | | Used to specify the filepath for the private key/password corresponding to the `tls_roots` certificate. |
160-
| `auth_timeout` | `15000` | The time period to wait for authenticating requests, in milliseconds. |
161-
| `request_timeout` | `10000` | Base timeout for HTTP requests before any additional time is added. |
162-
| `request_min_throughput` | `102400` | Expected minimum throughput of requests in bytes per second. Used to add additional time to `request_timeout` to prevent large requests timing out prematurely. |
163-
| `retry_timeout` | `10000` | The time period during which retries will be attempted, in milliseconds. |
164-
| `max_name_len` | `127` | The maximum allowed bytes, in UTF-8 format, for column and table names. |
141+
| Name | Default | Description |
142+
|--------------------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
143+
| `protocol` (schema) | `http` | The transport protocol to use. Options are http(s)/tcp(s). |
144+
| `addr` | `localhost:9000` | The {host}:{port} pair denoting the QuestDB server. By default, port 9000 for HTTP, port 9009 for TCP. |
145+
| `auto_flush` | `on` | Enables or disables auto-flushing functionality. By default, the buffer will be flushed every 75,000 rows, or every 1000ms, whichever comes first. |
146+
| `auto_flush_rows` | `75000 (HTTP)` `600 (TCP)` | The row count after which the buffer will be flushed. Effectively a batch size. |
147+
| `auto_flush_bytes` | `Int.MaxValue` | The byte buffer length which when exceeded, will trigger a flush. |
148+
| `auto_flush_interval` | `1000` | The millisecond interval, which once has elapsed, the next row triggers a flush. |
149+
| `init_buf_size` | `65536` | The starting byte buffer length. Overflowing this buffer will cause the allocation `init_buf_size` bytes (an additional buffer). |
150+
| `max_buf_size` | `104857600` | Maximum size of the byte buffer in bytes. If exceeded, an exception will be thrown. |
151+
| `username` | | The username for authentication. Used for Basic Authentication and TCP JWK Authentication. |
152+
| `password` | | The password for authentication. Used for Basic Authentication. |
153+
| `token` | | The token for authentication. Used for Token Authentication and TCP JWK Authentication. |
154+
| `token_x` | | Un-used. |
155+
| `token_y` | | Un-used. |
156+
| `tls_verify` | `on` | Denotes whether TLS certificates should or should not be verifed. Options are on/unsafe_off. |
157+
| `tls_ca` | | Un-used. |
158+
| `tls_roots` | | Used to specify the filepath for a custom .pem certificate. |
159+
| `tls_roots_password` | | Used to specify the filepath for the private key/password corresponding to the `tls_roots` certificate. |
160+
| `auth_timeout` | `15000` | The time period to wait for authenticating requests, in milliseconds. |
161+
| `request_timeout` | `10000` | Base timeout for HTTP requests before any additional time is added. |
162+
| `request_min_throughput` | `102400` | Expected minimum throughput of requests in bytes per second. Used to add additional time to `request_timeout` to prevent large requests timing out prematurely. |
163+
| `retry_timeout` | `10000` | The time period during which retries will be attempted, in milliseconds. |
164+
| `max_name_len` | `127` | The maximum allowed bytes, in UTF-8 format, for column and table names. |
165+
| `protocol_version` | | Explicitly specifies the version of InfluxDB Line Protocol to use for sender. Valid options are:<br>• protocol_version=1<br>• protocol_version=2<br>• protocol_version=auto (default, if unspecified) |
166+
167+
### Protocol Version
168+
169+
Behavior details:
170+
171+
| Value | Behavior |
172+
|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
173+
| 1 | - Plain text serialization<br>- Compatible with InfluxDB servers<br>- No array type support |
174+
| 2 | - Binary encoding for double arrays<br>- Full support for array |
175+
| `auto` | - **HTTP/HTTPS**: Auto-detects server capability during handshake (supports version negotiation)<br>- **TCP/TCPS**: Defaults to version 1 for compatibility |
165176

166177
### net-questdb-client specific parameters
167178

‎src/net-questdb-client-tcp-auth-tests/net-questdb-client-tcp-auth-tests.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
<ItemGroup>
2323
<ProjectReference Include="..\dummy-http-server\dummy-http-server.csproj"/>
24-
<ProjectReference Include="..\net-client-questdb-tcp-auth\net-client-questdb-tcp-auth.csproj" />
24+
<ProjectReference Include="..\net-questdb-client-tcp-auth\net-questdb-client-tcp-auth.csproj" />
2525
<ProjectReference Include="..\net-questdb-client-tests\net-questdb-client-tests.csproj" />
2626
<ProjectReference Include="..\net-questdb-client\net-questdb-client.csproj"/>
2727
</ItemGroup>

‎src/net-questdb-client/net-questdb-client.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<RepositoryUrl>https://github.com/questdb/net-questdb-client</RepositoryUrl>
1717
<PackageTags>QuestDB, ILP</PackageTags>
1818
<Company>QuestDB Limited</Company>
19-
<PackageVersion>2.1.0</PackageVersion>
19+
<PackageVersion>3.0.0</PackageVersion>
2020
<GenerateDocumentationFile>true</GenerateDocumentationFile>
2121
<TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
2222
</PropertyGroup>

0 commit comments

Comments
 (0)