Skip to content

build: release 3.0.0 #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 14, 2025
Merged

build: release 3.0.0 #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05a5496
build: release 3.0.0
ideoma Jul 14, 2025
52e3fb6
update readme
ideoma Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 35 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,30 +138,41 @@ The config string format is:
{http/https/tcp/tcps}::addr={host}:{port};key1=val1;key2=val2;keyN=valN;
```

| Name | Default | Description |
|--------------------------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `protocol` (schema) | `http` | The transport protocol to use. Options are http(s)/tcp(s). |
| `addr` | `localhost:9000` | The {host}:{port} pair denoting the QuestDB server. By default, port 9000 for HTTP, port 9009 for TCP. |
| `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. |
| `auto_flush_rows` | `75000 (HTTP)` `600 (TCP)` | The row count after which the buffer will be flushed. Effectively a batch size. |
| `auto_flush_bytes` | `Int.MaxValue` | The byte buffer length which when exceeded, will trigger a flush. |
| `auto_flush_interval` | `1000` | The millisecond interval, which once has elapsed, the next row triggers a flush. |
| `init_buf_size` | `65536` | The starting byte buffer length. Overflowing this buffer will cause the allocation `init_buf_size` bytes (an additional buffer). |
| `max_buf_size` | `104857600` | Maximum size of the byte buffer in bytes. If exceeded, an exception will be thrown. |
| `username` | | The username for authentication. Used for Basic Authentication and TCP JWK Authentication. |
| `password` | | The password for authentication. Used for Basic Authentication. |
| `token` | | The token for authentication. Used for Token Authentication and TCP JWK Authentication, needs additional reference to `net-questdb-client-tcp-auth` assembly |
| `token_x` | | Un-used. |
| `token_y` | | Un-used. |
| `tls_verify` | `on` | Denotes whether TLS certificates should or should not be verifed. Options are on/unsafe_off. |
| `tls_ca` | | Un-used. |
| `tls_roots` | | Used to specify the filepath for a custom .pem certificate. |
| `tls_roots_password` | | Used to specify the filepath for the private key/password corresponding to the `tls_roots` certificate. |
| `auth_timeout` | `15000` | The time period to wait for authenticating requests, in milliseconds. |
| `request_timeout` | `10000` | Base timeout for HTTP requests before any additional time is added. |
| `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. |
| `retry_timeout` | `10000` | The time period during which retries will be attempted, in milliseconds. |
| `max_name_len` | `127` | The maximum allowed bytes, in UTF-8 format, for column and table names. |
| Name | Default | Description |
|--------------------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `protocol` (schema) | `http` | The transport protocol to use. Options are http(s)/tcp(s). |
| `addr` | `localhost:9000` | The {host}:{port} pair denoting the QuestDB server. By default, port 9000 for HTTP, port 9009 for TCP. |
| `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. |
| `auto_flush_rows` | `75000 (HTTP)` `600 (TCP)` | The row count after which the buffer will be flushed. Effectively a batch size. |
| `auto_flush_bytes` | `Int.MaxValue` | The byte buffer length which when exceeded, will trigger a flush. |
| `auto_flush_interval` | `1000` | The millisecond interval, which once has elapsed, the next row triggers a flush. |
| `init_buf_size` | `65536` | The starting byte buffer length. Overflowing this buffer will cause the allocation `init_buf_size` bytes (an additional buffer). |
| `max_buf_size` | `104857600` | Maximum size of the byte buffer in bytes. If exceeded, an exception will be thrown. |
| `username` | | The username for authentication. Used for Basic Authentication and TCP JWK Authentication. |
| `password` | | The password for authentication. Used for Basic Authentication. |
| `token` | | The token for authentication. Used for Token Authentication and TCP JWK Authentication. |
| `token_x` | | Un-used. |
| `token_y` | | Un-used. |
| `tls_verify` | `on` | Denotes whether TLS certificates should or should not be verifed. Options are on/unsafe_off. |
| `tls_ca` | | Un-used. |
| `tls_roots` | | Used to specify the filepath for a custom .pem certificate. |
| `tls_roots_password` | | Used to specify the filepath for the private key/password corresponding to the `tls_roots` certificate. |
| `auth_timeout` | `15000` | The time period to wait for authenticating requests, in milliseconds. |
| `request_timeout` | `10000` | Base timeout for HTTP requests before any additional time is added. |
| `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. |
| `retry_timeout` | `10000` | The time period during which retries will be attempted, in milliseconds. |
| `max_name_len` | `127` | The maximum allowed bytes, in UTF-8 format, for column and table names. |
| `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) |

### Protocol Version

Behavior details:

| Value | Behavior |
|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 | - Plain text serialization<br>- Compatible with InfluxDB servers<br>- No array type support |
| 2 | - Binary encoding for double arrays<br>- Full support for array |
| `auto` | - **HTTP/HTTPS**: Auto-detects server capability during handshake (supports version negotiation)<br>- **TCP/TCPS**: Defaults to version 1 for compatibility |

### net-questdb-client specific parameters

Expand Down
2 changes: 1 addition & 1 deletion src/net-questdb-client-tcp-auth-tests/net-questdb-client-tcp-auth-tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

<ItemGroup>
<ProjectReference Include="..\dummy-http-server\dummy-http-server.csproj"/>
<ProjectReference Include="..\net-client-questdb-tcp-auth\net-client-questdb-tcp-auth.csproj" />
<ProjectReference Include="..\net-questdb-client-tcp-auth\net-questdb-client-tcp-auth.csproj" />
<ProjectReference Include="..\net-questdb-client-tests\net-questdb-client-tests.csproj" />
<ProjectReference Include="..\net-questdb-client\net-questdb-client.csproj"/>
</ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/net-questdb-client/net-questdb-client.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<RepositoryUrl>https://github.com/questdb/net-questdb-client</RepositoryUrl>
<PackageTags>QuestDB, ILP</PackageTags>
<Company>QuestDB Limited</Company>
<PackageVersion>2.1.0</PackageVersion>
<PackageVersion>3.0.0</PackageVersion>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
</PropertyGroup>
Expand Down