Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder for creating a Client

Implementations

impl ClientBuilder

pub fn new() -> Self

Create a new ClientBuilder

pub fn base_url(self, url: impl Into<String>) -> Self

Set the base URL for the ekoDB server

Example

use ekodb_client::Client;

let client = Client::builder()
    .base_url("https://api.ekodb.net")
    .api_key("your-api-key")
    .build()?;

pub fn api_key(self, key: impl Into<String>) -> Self

Set the API key for authentication

The API key will be exchanged for a JWT token automatically.

Example

use ekodb_client::Client;

let client = Client::builder()
    .base_url("https://api.ekodb.net")
    .api_key("your-api-key")
    .build()?;

pub fn api_token(self, token: impl Into<String>) -> Self

👎Deprecated since 0.1.0:

Use api_key instead

Set the API token for authentication (alias for api_key for backward compatibility)

pub fn timeout(self, timeout: Duration) -> Self

Set the request timeout

Default: 30 seconds

pub fn max_retries(self, retries: usize) -> Self

Set the maximum number of retry attempts

Default: 3

pub fn should_retry(self, should_retry: bool) -> Self

Enable or disable automatic retries for rate limiting and transient errors

When enabled (default), the client will automatically retry requests that fail due to rate limiting (429), service unavailable (503), timeouts, or connection errors. The retry delay respects the server’s Retry-After header for rate limits.

When disabled, all errors are returned immediately to the caller for manual handling.

Default: true

Example

use ekodb_client::Client;

// Disable automatic retries
let client = Client::builder()
    .base_url("https://api.ekodb.net")
    .api_key("your-api-key")
    .should_retry(false)
    .build()?;

pub fn serialization_format(self, format: SerializationFormat) -> Self

Set the serialization format for client-server communication

Supports JSON (default, human-readable) and MessagePack (binary, faster). MessagePack can provide 2-3x performance improvement over JSON.

Default: JSON

Example

use ekodb_client::{Client, SerializationFormat};

// Use MessagePack for better performance
let client = Client::builder()
    .base_url("https://api.ekodb.net")
    .api_key("your-api-key")
    .serialization_format(SerializationFormat::MessagePack)
    .build()?;

pub fn schema_cache(self, enabled: bool) -> Self

Enable the in-memory schema cache for primary_key_alias resolution.

When enabled, CRUD results use cached schema metadata to correctly extract record IDs regardless of the collection’s primary_key_alias config. The cache is invalidated automatically via WS SchemaChanged events.

pub fn schema_cache_ttl(self, seconds: u64) -> Self

Set the schema cache TTL (time-to-live) in seconds. Default: 300 (5 min).

pub fn schema_cache_max(self, max: usize) -> Self

Set the max number of collections the schema cache holds. Default: 100.

pub fn build(self) -> Result<Client>

Build the client

Errors

Returns an error if required fields are missing or invalid

Trait Implementations

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.