Struct ConnectionBuilder 

pub struct ConnectionBuilder { /* private fields */ }

A builder for creating database connections.

This provides a flexible way to configure a connection with various options like authentication, database creation mode, and transport settings.

Transport Auto-Detection

The transport is automatically detected from the endpoint URL:

• https:// or http:// → gRPC transport (read-only)
• Otherwise → TCP transport (e.g., localhost:7483)

Example

use hyperdb_api::{ConnectionBuilder, CreateMode, Result};

fn main() -> Result<()> {
    // TCP connection
    let conn = ConnectionBuilder::new("localhost:7483")
        .database("example.hyper")
        .create_mode(CreateMode::CreateIfNotExists)
        .user("myuser")
        .password("mypassword")
        .build()?;
    Ok(())
}

// gRPC connection (auto-detected from URL)
let conn = ConnectionBuilder::new("https://hyper-server.example.com:443")
    .database("example.hyper")
    .build()?;

Implementations

impl ConnectionBuilder

pub fn new(endpoint: impl Into<String>) -> Self

Creates a new builder for the given endpoint.

Arguments

• endpoint - The server endpoint (host:port).

pub fn database(self, path: impl AsRef<Path>) -> Self

Sets the database path.

pub fn create_mode(self, mode: CreateMode) -> Self

Sets the database creation mode.

Default is CreateMode::DoNotCreate.

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

Sets the username for authentication.

Default is “tableau_internal_user”.

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

Sets the password for authentication.

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

Sets the login timeout.

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

Sets the query timeout.

Queries that exceed this duration will be cancelled automatically. Default is no timeout (queries run until completion).

pub fn application_name(self, name: impl Into<String>) -> Self

Sets the application name sent to the server.

This appears in server logs and can be used for monitoring.

pub fn auth(self, user: impl Into<String>, password: impl Into<String>) -> Self

Convenience method to set user and password at once.

pub fn create_new_database(self, database_path: impl AsRef<Path>) -> Self

Convenience method to create a new database.

pub fn create_or_open_database(self, database_path: impl AsRef<Path>) -> Self

Convenience method to create database if it doesn’t exist.

pub fn open_database(self, database_path: impl AsRef<Path>) -> Self

Convenience method to open an existing database.

pub fn transfer_mode(self, mode: TransferMode) -> Self

Sets the transfer mode for gRPC connections.

This setting is ignored for TCP connections.

• TransferMode::Sync - All results in one response (simple, 100s timeout)
• TransferMode::Async - Header only, fetch results via GetQueryResult
• TransferMode::Adaptive - First chunk inline, rest streamed (default, recommended)

Example

use hyperdb_api::{ConnectionBuilder, CreateMode, Result};
use hyperdb_api::grpc::TransferMode;

fn example() -> Result<()> {
    let conn = ConnectionBuilder::new("https://hyper-server:443")
        .database("example.hyper")
        .transfer_mode(TransferMode::Adaptive)
        .build()?;
    Ok(())
}

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

Builds and establishes the connection.

The transport is automatically detected from the endpoint URL:

• https:// or http:// → gRPC transport
• Otherwise → TCP transport

Errors

Returns an error if the connection fails or if database creation fails.

Trait Implementations

impl Clone for ConnectionBuilder

fn clone(&self) -> ConnectionBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConnectionBuilder

fn default() -> Self

Returns the “default value” for a type.