Struct hdbconnect::ConnectParamsBuilder

source ·

pub struct ConnectParamsBuilder { /* private fields */ }

Expand description

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§

source §

impl ConnectParamsBuilder

source

pub fn new() -> ConnectParamsBuilder

Creates a new builder.

source

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

Creates a new builder based on the given URL.

source

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

Sets the hostname.

source

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

Sets the port.

source

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

Sets the database user.

source

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

Sets the database user.

source

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

Sets the password.

source

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

Sets the password.

source

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

Unsets the password.

source

pub fn is_tls(&self) -> bool

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

source

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.

source

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

Sets the network group.

source

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

Sets the client locale.

source

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

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

source

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)

source

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();

source

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.

source