Struct testcontainers_modules::surrealdb::SurrealDb

pub struct SurrealDb { /* private fields */ }

Available on crate feature surrealdb only.

Module to work with SurrealDB inside of tests. Starts an instance of SurrealDB. This module is based on the official SurrealDB docker image. Default user and password is root, and exposed port is 8000 (SURREALDB_PORT).

Example

use testcontainers_modules::{surrealdb, testcontainers::runners::SyncRunner};

let surrealdb_instance = surrealdb::SurrealDb::default().start();

let connection_string = format!(
   "127.0.0.1:{}",
   surrealdb_instance.get_host_port_ipv4(surrealdb::SURREALDB_PORT)
);

let db: Surreal<Client> = Surreal::init();
db.connect::<Ws>(connection_string).await.expect("Failed to connect to SurrealDB");

Implementations

impl SurrealDb

pub fn with_user(self, user: &str) -> Self

Sets the user for the SurrealDB instance.

pub fn with_password(self, password: &str) -> Self

Sets the password for the SurrealDB instance.

pub fn with_authentication(self, authentication: bool) -> Self

Sets authentication for the SurrealDB instance.

pub fn with_strict(self, strict: bool) -> Self

Sets strict mode for the SurrealDB instance.

pub fn with_all_capabilities(self, allow_all: bool) -> Self

Sets all capabilities for the SurrealDB instance.

Trait Implementations

impl Debug for SurrealDb

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

Formats the value using the given formatter.

impl Default for SurrealDb

fn default() -> Self

Returns the “default value” for a type.

impl Image for SurrealDb

type Args = SurrealDbArgs

A type representing the arguments for an Image.

fn name(&self) -> String

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> String

Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn env_vars(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_>

There are a couple of things regarding the environment variables of images:

fn expose_ports(&self) -> Vec<u16>

Returns the ports that needs to be exposed when a container is created.

fn mounts(&self) -> Box<dyn Iterator<Item = &Mount> + '_>

There are a couple of things regarding the mounts of images:

fn entrypoint(&self) -> Option<String>

Returns the entrypoint this instance was created with.

fn exec_after_start(&self, cs: ContainerState) -> Vec<ExecCommand>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.