Struct hdbconnect::ConnectParams

pub struct ConnectParams { /* fields omitted */ }

An immutable struct with all information necessary to open a new connection to a HANA database.

An instance of ConnectParams can be created in various ways:

Using the builder

The builder allows specifying all necessary details programmatically.

Example with TLS

use hdbconnect::{ConnectParams, ServerCerts};
let certificate: String = read_certificate();
let connect_params = ConnectParams::builder()
   .hostname("the_host")
   .port(2222)
   .dbuser("my_user")
   .password("my_passwd")
   .tls_with(ServerCerts::Direct(certificate))
   .build()
   .unwrap();

Using a URL

The URL is supposed to have the form

<scheme>://<username>:<password>@<host>:<port>[<options>]

where

<scheme> = hdbsql | hdbsqls
<username> = the name of the DB user to log on
<password> = the password of the DB user
<host> = the host where HANA can be found
<port> = the port at which HANA can be found on <host>
<options> = ?<key>[=<value>][{&<key>[=<value>}]]

Special option keys are:

client_locale=<value> specifies the client locale
client_locale_from_env (no value): lets the driver read the client's locale from the environment variabe LANG
tls_certificate_dir=<value>: points to a folder with pem files that contain certificates; all pem files in that folder are evaluated
tls_certificate_env=<value>: denotes an environment variable that contains certificates use_mozillas_root_certificates (no value): use the root certificates from https://mkcert.org/

The client locale is used in language-dependent handling within the SAP HANA database calculation engine.

Example

use hdbconnect::IntoConnectParams;
let conn_params = "hdbsql://my_user:my_passwd@the_host:2222"
    .into_connect_params()
    .unwrap();

Reading a URL from a file

The shortcut ConnectParams::from_file reads a URL from a file and converts it into an instance of ConnectParams.

Methods

impl ConnectParams

pub fn builder() -> ConnectParamsBuilder

Returns a new builder for ConnectParams.

pub fn from_file<P: AsRef<Path>>(path: P) -> HdbResult<ConnectParams>

Reads a url from the given file and converts it into ConnectParams.

pub fn server_certs(&self) -> Option<&ServerCerts>

The ServerCerts.

pub fn host(&self) -> &str

The host.

pub fn addr(&self) -> &str

The socket address.

pub fn use_tls(&self) -> bool

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

pub fn dbuser(&self) -> &String

The database user.

pub fn password(&self) -> &SecStr

The password.

pub fn clientlocale(&self) -> Option<&String>

The client locale.

Trait Implementations

impl IntoConnectParams for ConnectParams

fn into_connect_params(self) -> HdbResult<ConnectParams>

Converts the value of self into a ConnectParams.

impl Clone for ConnectParams

fn clone(&self) -> ConnectParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectParams

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

Formats the value using the given formatter.