SQL Server¶

Integration with Microsoft SQL Server using the Microsoft SQL Server Docker Image

Installation¶

pip install pytest-databases[mssql]

The mssql extra is kept as a compatibility group. The fixture provides a running SQL Server service and validates availability with SQL Server’s bundled tools. Install the SQL Server client library that your application already uses.

Usage Example¶

import pyodbc
from pytest_databases.docker.mssql import MSSQLService

pytest_plugins = ["pytest_databases.docker.mssql"]

def test_sql_server_service(mssql_service: MSSQLService) -> None:
    with pyodbc.connect(mssql_service.connection_string) as conn:
        cursor = conn.cursor()
        cursor.execute("SELECT 1 AS is_available")
        row = cursor.fetchone()
        assert row is not None and row[0] == 1

Available Fixtures¶

mssql_image: The Docker image to use for SQL Server.
mssql_user: The SQL Server user exposed on mssql_service.
mssql_password: The SQL Server password exposed on mssql_service.
mssql_database: The database created for mssql_service.
mssql_service: A fixture that provides a SQL Server service.

Service API¶

pytest_databases.docker.mssql.xdist_mssql_isolation_level()[source]¶

Return type:: Literal['database', 'server']

pytest_databases.docker.mssql.mssql_image()[source]¶

Return type:: str

pytest_databases.docker.mssql.mssql_user()[source]¶

Return type:: str

pytest_databases.docker.mssql.mssql_password()[source]¶

Return type:: str

pytest_databases.docker.mssql.mssql_database()[source]¶

Return type:: str

class pytest_databases.docker.mssql.MSSQLService(container, host, port, user, password, database)[source]¶

Bases: ServiceContainer

user: str¶

password: str¶

database: str¶

property connection_string: str¶

__init__(container, host, port, user, password, database)¶

pytest_databases.docker.mssql.mssql_service(docker_service, xdist_mssql_isolation_level, mssql_image, mssql_user, mssql_password, mssql_database)[source]¶

Return type:: Generator[MSSQLService, None, None]