Struct edgedb_client::Builder

pub struct Builder { /* fields omitted */ }

A builder used to create connections

Implementations

impl Builder

pub async fn from_env() -> Result<Builder, Error>

Initializes Builder using project or environment variables

pub async fn read_project(
    &mut self,
    override_dir: Option<&Path>,
    search_parents: bool
) -> Result<&mut Self, Error>

Reads the project config if found

Projects are initialized using command-line tool:

edgedb project init

Linking to already running EdgeDB is also possible:

edgedb project init --link

Returns boolean value of whether project have been found

pub fn display_addr<'x>(&'x self) -> impl Display + 'x

A displayable form for address

pub fn is_initialized(&self) -> bool

Are credentials set on this builder

pub async fn read_env_vars(&mut self) -> Result<&mut Self, Error>

Read environment variables and set respective configuration parameters

This function initializes builder if one of the following is set:

• EDGEDB_CREDENTIALS_FILE
• EDGEDB_INSTANCE
• EDGEDB_DSN
• EDGEDB_HOST or EDGEDB_PORT

On the same ocassion it will reset all previously credentials.

If one of the following are set:

• EDGEDB_DATABASE
• EDGEDB_USER
• EDGEDB_PASSWORD

Then this function overrides just specified parameters.

The insecure_dev_mode and connection parameters are never modified by this function for now.

pub fn read_extra_env_vars(&mut self) -> Result<&mut Self, Error>

Read environment variables that aren’t credentials

pub fn credentials(
    &mut self,
    credentials: &Credentials
) -> Result<&mut Self, Error>

Set whole credentials

This marks builder as initialized

pub async fn read_instance(&mut self, name: &str) -> Result<&mut Self, Error>

Read credentials from named instance

Named instances are created using command-line tool, directly:

edgedb instance create <name>

or when initializing a project:

edgedb project init

In the latter case you should use read_project instead if possible.

This will mark builder as initialized (if reading is successful) and overwrite all the credentials. Although, insecure_dev_mode, pools sizes and timeouts are kept intact.

pub async fn read_credentials(
    &mut self,
    path: impl AsRef<Path>
) -> Result<&mut Self, Error>

Read credentials from a file

This will mark builder as initialized (if reading is successful) and overwrite all the credentials. Although, insecure_dev_mode, pools sizes and timeouts are kept intact.

pub async fn read_dsn(&mut self, dsn: &str) -> Result<&mut Self, Error>

Initialize credentials using data source name (DSN)

DSN’s that EdgeDB like are URL with egdgedb::/scheme:

edgedb://user:secret@localhost:5656/

All the credentials can be specified using DSN, although ingesing DSN may also include reading environment variables (if query arguments of the for *_env are specified) and local files (for query arguments named *_file).

This will mark builder as initialized (if reading is successful) and overwrite all the credentials. Although, insecure_dev_mode, pools sizes and timeouts are kept intact.

pub fn uninitialized() -> Builder

Creates a new builder that has to be intialized by calling some methods

Useful only if you have connections to multiple unrelated databases, or want to have total control on the initialization of the database.

Usually Builder::from_env() should be used instead.

pub fn as_credentials(&self) -> Result<Credentials, Error>

Extract credentials from the Builder so they can be saved as JSON

pub fn get_host(&self) -> &str

Get host this builder is configured to connect to

pub fn get_port(&self) -> u16

Get port this builder is configured to connect to

pub fn host_port(
    &mut self,
    host: Option<impl Into<String>>,
    port: Option<u16>
) -> &mut Self

Initialize credentials using host/port data

If any of host or port is None it is replaced with the default of localhost and 5656 respectively.

This will mark builder as initialized and overwrite all the credentials. Although, insecure_dev_mode, pools sizes and timeouts are kept intact.

pub fn get_user(&self) -> &str

Get user name for SCRAM authentication

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

Set user name for SCRAM authentication

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

Set password for SCRAM authentication

pub fn database(&mut self, database: impl Into<String>) -> &mut Self

Set database name

pub fn get_database(&self) -> &str

Get database name

pub fn wait_until_available(&mut self, time: Duration) -> &mut Self

Time to wait for database server to become available

This works by ignoring certain errors known to happen while database is starting up or restarting (e.g. “connecction refused” or early “connection reset”)

Note: the whole time that connection is being established can be up to wait_until_available + connect_timeout

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

A timeout for a single connect attempt

Default is 10 seconds. Subsecond timeout should be fine for most networks, but since this timeout includes authentication, and currently that means:

• Checking a password (slow by design)
• Creating a compiler process (slow now, may be optimized later)

So in concurrent case on slower VM (such as CI with parallel tests) 10 seconds is more reasonable default.

The wait_until_available should be larger than this value to allow multiple attempts. And also the whole time that connection is being established can be up to wait_until_available + connect_timeout

pub fn pem_certificates(
    &mut self,
    cert_data: &String
) -> Result<&mut Self, Error>

Set allowed certificate as pem file

pub fn verify_hostname(&mut self, value: bool) -> &mut Self

Instructs TLS code to enable or disable verification

By default verification is disable if specific certificate are configured and enabled if root certificates are used.

pub fn insecure_dev_mode(&mut self, value: bool) -> &mut Self

Enables insecure dev mode

This disables certificate validation entirely

pub fn max_connections(&mut self, value: usize) -> &mut Self

Maximum number of underlying database connections

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.