Struct ConnectParamsBuilder

pub struct ConnectParamsBuilder { /* private fields */ }

A builder for ConnectParams.

Instantiating a ConnectParamsBuilder programmatically

use hdbconnect::ConnectParams;

let connect_params = ConnectParams::builder()
    .hostname("abcd123")
    .port(2222)
    .dbuser("MEIER")
    .password("schlau")
    .build()
    .unwrap();

Instantiating a ConnectParamsBuilder from a URL

See module url for details about the supported URLs.

use hdbconnect::IntoConnectParamsBuilder;

let conn_params = "hdbsql://abcd123:2222"
    .into_connect_params_builder()
    .unwrap()
    .dbuser("MEIER")
    .password("schlau")
    .build()
    .unwrap();

Implementations

impl ConnectParamsBuilder

pub fn new() -> ConnectParamsBuilder

Creates a new builder.

pub fn from(url: &str) -> Result<ConnectParamsBuilder, HdbError>

Creates a new builder based on the given URL.

Errors

HdbError::Usage when parsing or evaluating the url failed.

pub fn hostname<H>(&mut self, hostname: H) -> &mut ConnectParamsBuilder

where H: AsRef<str>,

Sets the hostname.

pub fn port(&mut self, port: u16) -> &mut ConnectParamsBuilder

Sets the port.

pub fn dbuser<D>(&mut self, dbuser: D) -> &mut ConnectParamsBuilder

where D: AsRef<str>,

Sets the database user.

pub fn with_dbuser<D>(self, dbuser: D) -> ConnectParamsBuilder

where D: AsRef<str>,

Sets the database user.

pub fn password<P>(&mut self, pw: P) -> &mut ConnectParamsBuilder

where P: AsRef<str>,

Sets the password.

pub fn with_password<P>(self, pw: P) -> ConnectParamsBuilder

where P: AsRef<str>,

Sets the password.

pub fn unset_password(&mut self) -> &mut ConnectParamsBuilder

Unsets the password.

pub fn is_tls(&self) -> bool

Whether TLS or a plain TCP connection is to be used.

pub fn dbname<D>(&mut self, dbname: D) -> &mut ConnectParamsBuilder

where D: AsRef<str>,

Sets the database name.

This allows specifying host and port of the system DB and getting automatically redirected and connected to the specified tenant database.

pub fn network_group<D>( &mut self, network_group: D, ) -> &mut ConnectParamsBuilder

where D: AsRef<str>,

Sets the network group.

pub fn clientlocale<P>(&mut self, cl: P) -> &mut ConnectParamsBuilder

where P: AsRef<str>,

Sets the client locale.

pub fn clientlocale_from_env_lang(&mut self) -> &mut ConnectParamsBuilder

Sets the client locale from the value of the environment variable LANG

pub fn always_uncompressed( &mut self, uncompressed: bool, ) -> &mut ConnectParamsBuilder

Switch off compression (for debugging purposes?)

By default, compression is supported, like with always_uncompressed(false)

pub fn tls_with( &mut self, server_certs: ServerCerts, ) -> &mut ConnectParamsBuilder

Makes the driver use TLS for the connection to the database.

Requires that the server’s certificate is provided with one of the enum variants of ServerCerts.

If needed, you can call this function multiple times with different ServerCert variants.

Example:

let mut conn_params = ConnectParams::builder()
   // ...more settings required...
   .tls_with(ServerCerts::Direct(string_with_certificate))
   .build();

pub fn tls_without_server_verification(&mut self) -> &mut ConnectParamsBuilder

Makes the driver use TLS for the connection to the database, but hazardously without verifying the server’s certificate. Erases all already configured server certs.

pub fn build(&self) -> Result<ConnectParams, HdbError>

Constructs a ConnectParams from the builder.

Errors

HdbError::Usage if the builder was not yet configured to create a meaningful ConnectParams

pub fn to_url_without_password(&self) -> String

Returns the url for this connection, without the password.

pub fn to_url_with_password(&self) -> String

Returns the url for this connection with the password.

pub fn get_hostname(&self) -> Option<&str>

Returns the configured hostname.

pub fn get_dbuser(&self) -> Option<&str>

Returns the configured database user.

pub fn get_password(&self) -> Option<&SecUtf8>

Returns the configured password.

pub fn get_port(&self) -> Option<u16>

Returns the configured port number.

pub fn get_clientlocale(&self) -> Option<&str>

Returns the configured client locale.

pub fn get_dbname(&self) -> Option<&str>

Returns the configured database name.

pub fn get_networkgroup(&self) -> Option<&str>

Returns the configured network group.

pub fn get_server_certs(&self) -> Option<&Vec<ServerCerts>>

Returns the configured variants for validating the server certificate.

Trait Implementations

impl Clone for ConnectParamsBuilder

fn clone(&self) -> ConnectParamsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectParamsBuilder

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

Formats the value using the given formatter.

impl Default for ConnectParamsBuilder

fn default() -> ConnectParamsBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConnectParamsBuilder

fn deserialize<D>( deserializer: D, ) -> Result<ConnectParamsBuilder, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ConnectParamsBuilder

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

Formats the value using the given formatter.

impl IntoConnectParams for &ConnectParamsBuilder

fn into_connect_params(self) -> Result<ConnectParams, HdbError>

Converts the value of self into a ConnectParams.

impl IntoConnectParams for ConnectParamsBuilder

fn into_connect_params(self) -> Result<ConnectParams, HdbError>

Converts the value of self into a ConnectParams.

impl IntoConnectParamsBuilder for ConnectParamsBuilder

fn into_connect_params_builder(self) -> Result<ConnectParamsBuilder, HdbError>

Converts the value of self into a ConnectParamsBuilder.

impl PartialEq for ConnectParamsBuilder

fn eq(&self, other: &ConnectParamsBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConnectParamsBuilder

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ConnectParamsBuilder

impl StructuralPartialEq for ConnectParamsBuilder