Struct testcontainers_modules::mssql_server::MssqlServer

pub struct MssqlServer { /* private fields */ }

Available on crate feature mssql_server only.

Microsoft SQL Server module for testcontainers.

This module is based on the official Microsoft SQL Server for Linux Docker image. Only amd64 images are available for SQL Server. If you use Apple silicon machines, you need to configure Rosetta emulation.

• Change Docker Desktop settings on Mac | Docker Docs

Example

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

let mssql_server = mssql_server::MssqlServer::default().start().unwrap();
let ado_connection_string = format!(
   "Server=tcp:{},{};Database=test;User Id=sa;Password=yourStrong(!)Password;TrustServerCertificate=True;",
   mssql_server.get_host().unwrap(),
   mssql_server.get_host_port_ipv4(1433).unwrap()
);

Environment variables

Refer to the documentation for a complite list of environment variables.

Following environment variables are required. A image provided by this module has default values for them.

ACCEPT_EULA

You need to accept the End-User Licensing Agreement before using the SQL Server image provided by this module. To accept EULA, you can set this environment variable to Y. The default value is Y.

MSSQL_SA_PASSWORD

The SA user password. This password is required to conform to the strong password policy. The default value is yourStrong(!)Password.

MSSQL_PID

The edition of SQL Server. The default value is Developer, which will run the container using the Developer Edition.

Implementations

impl MssqlServer

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

Sets the password as MSSQL_SA_PASSWORD.

Trait Implementations

impl Clone for MssqlServer

fn clone(&self) -> MssqlServer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MssqlServer

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

Formats the value using the given formatter.

impl Default for MssqlServer

fn default() -> Self

Returns the “default value” for a type.

impl Image for MssqlServer

fn name(&self) -> &str

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

fn tag(&self) -> &str

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, ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)>

Returns the environment variables that needs to be set when a container is created.

fn mounts(&self) -> impl IntoIterator<Item = &Mount>

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

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

Returns the entrypoint this image needs to be created with.

fn cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD this image needs to be created with.

fn expose_ports(&self) -> &[ContainerPort]

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

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

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