Programově budujte spojovací řetězce

Mnoho aplikací potřebuje dynamicky vytvářet spojovací řetězce místo jejich ukládání jako statické konfigurační hodnoty. Vyberte si přístup, který odpovídá vašemu nasazení:

• Proměnné prostředí: Nejlepší pro kontejnery, CI/CD a 12faktorové aplikace. Jednoduché a široce podporované.
• JSON/YAML konfigurační soubory: Nejlepší pro aplikace s více prostředími (vývoj, staging, produkci), které vyžadují strukturovanou konfiguraci.
• Azure Key Vault: Nejlepší pro produkční nasazení, kde je třeba tajemství centrálně spravovat a auditovat.
• Třída Builder: Vhodné pro knihovny nebo frameworky, které potřebují vytvářet připojovací řetězce z uživatelského vstupu s automatickým escapováním.

Základní konstrukce strun

Použijte f-řetězce

F-stringy jsou běžným přístupem pro rychlé skripty a prototypy. Vyhněte se tomuto vzorci, když hodnoty pocházejí z uživatelského vstupu, protože škodlivá hodnota jako mydb;Server=evil.com může změnit cíl spojení:

import mssql_python

server = "<server>.database.windows.net"
database = "<database>"

connection_string = f"Server={server};Database={database};Authentication=ActiveDirectoryDefault;Encrypt=yes;"

conn = mssql_python.connect(connection_string)

Použijte join

Přístup join odděluje páry klíč-hodnota do volání funkce ve stylu slovníku, které se snáze čte a spravuje než dlouhý f-string. Také automaticky filtruje hodnoty None , takže můžete předat volitelné parametry bez další podmíněné logiky:

def build_connection_string(**kwargs) -> str:
    """Build connection string from keyword arguments."""
    return ";".join(f"{key}={value}" for key, value in kwargs.items() if value is not None)

conn_str = build_connection_string(
    Server="<server>.database.windows.net",
    Database="<database>",
    Authentication="ActiveDirectoryDefault",
    Encrypt="yes"
)

conn = mssql_python.connect(conn_str)

Třída sestavovače připojovacího řetězce

Třída builder poskytuje plynulé API s automatickým únikem. Tento přístup je užitečný v knihovnách nebo multitenant aplikacích, kde parametry spojení pocházejí z různých zdrojů:

import mssql_python

class ConnectionStringBuilder:
    """Builder for SQL Server connection strings."""

    def __init__(self):
        self._params = {}

    def server(self, value: str) -> "ConnectionStringBuilder":
        self._params["Server"] = value
        return self

    def database(self, value: str) -> "ConnectionStringBuilder":
        self._params["Database"] = value
        return self

    def trusted_connection(self) -> "ConnectionStringBuilder":
        self._params["Trusted_Connection"] = "yes"
        return self

    def sql_auth(self, username: str, password: str) -> "ConnectionStringBuilder":
        self._params["UID"] = username
        self._params["PWD"] = password
        return self

    def entra_default(self) -> "ConnectionStringBuilder":
        self._params["Authentication"] = "ActiveDirectoryDefault"
        return self

    def entra_msi(self, client_id: str = None) -> "ConnectionStringBuilder":
        self._params["Authentication"] = "ActiveDirectoryMSI"
        if client_id:
            self._params["UID"] = client_id
        return self

    def encrypt(self, value: bool = True) -> "ConnectionStringBuilder":
        self._params["Encrypt"] = "yes" if value else "no"
        return self

    def trust_server_certificate(self, value: bool = True) -> "ConnectionStringBuilder":
        self._params["TrustServerCertificate"] = "yes" if value else "no"
        return self

    def connect_timeout(self, seconds: int) -> "ConnectionStringBuilder":
        self._timeout = seconds
        return self

    def build(self) -> str:
        """Build the connection string."""
        return ";".join(f"{k}={v}" for k, v in self._params.items())

    def connect(self) -> mssql_python.Connection:
        """Build and connect."""
        return mssql_python.connect(self.build(), timeout=getattr(self, '_timeout', 0))


# Usage examples
# Microsoft Entra authentication (recommended)
conn = (ConnectionStringBuilder()
    .server("<server>.database.windows.net")
    .database("<database>")
    .entra_default()
    .encrypt()
    .connect())

# Azure with managed identity
conn = (ConnectionStringBuilder()
    .server("<server>.database.windows.net")
    .database("<database>")
    .entra_msi()
    .encrypt()
    .connect())

Konfigurace založená na prostředí

Z proměnných prostředí

Načítání parametrů připojení z proměnných prostředí zajišťuje, že přihlašovací údaje nejsou součástí zdrojového kódu, a funguje jak v místním vývoji, tak v kontejnerech a CI/CD pipelinech. Funkce kontroluje, kterou autentizační metodu použít na základě nastavených proměnných:

import os
import mssql_python

def get_connection_from_env() -> mssql_python.Connection:
    """Build connection from environment variables."""
    server = os.environ.get("SQL_SERVER")
    database = os.environ.get("SQL_DATABASE")

    if not server or not database:
        raise ValueError("SQL_SERVER and SQL_DATABASE environment variables required")

    # Check for authentication method
    if os.environ.get("SQL_USE_MSI", "").lower() == "true":
        # Azure Managed Identity
        conn_str = f"Server={server};Database={database};Authentication=ActiveDirectoryMSI;Encrypt=yes;"
    elif os.environ.get("SQL_TRUSTED_CONNECTION", "").lower() == "true":
        # Windows authentication
        conn_str = f"Server={server};Database={database};Trusted_Connection=yes;Encrypt=yes;"
    else:
        # SQL authentication
        username = os.environ.get("SQL_USERNAME")
        password = os.environ.get("SQL_PASSWORD")
        if not username or not password:
            raise ValueError("SQL_USERNAME and SQL_PASSWORD required for SQL authentication")
        conn_str = f"Server={server};Database={database};UID={username};PWD={password};Encrypt=yes;"

    return mssql_python.connect(conn_str)

# Usage
conn = get_connection_from_env()

S knihovnou python-dotenv

Balíček python-dotenv načítá páry klíč–hodnota ze souboru .env do proměnných prostředí, takže váš kód čte přístupové údaje stejným způsobem v místním vývoji i v produkci. Soubor .env zůstává mimo správu zdrojového kódu (přidat ho do .gitignore), zatímco nasazená prostředí vkládají stejné proměnné do svého platformového tajného úložiště.

Nainstalujte pomocí pip install python-dotenv.

Vytvořte .env soubor v kořeni projektu s parametry připojení:

# .env - add this file to .gitignore
SQL_SERVER=<server>.database.windows.net
SQL_DATABASE=<database>
SQL_USE_MSI=true

Pak načtěte a použijte tyto hodnoty ve svém skriptu:

from dotenv import load_dotenv
import os
import mssql_python

# Load .env file into os.environ (no-op if the file doesn't exist)
load_dotenv()

server = os.getenv("SQL_SERVER")
database = os.getenv("SQL_DATABASE")

if not server or not database:
    raise ValueError("SQL_SERVER and SQL_DATABASE must be set in .env or as environment variables")

use_msi = os.getenv("SQL_USE_MSI", "false").lower() == "true"

if use_msi:
    conn_str = f"Server={server};Database={database};Authentication=ActiveDirectoryMSI;Encrypt=yes;"
else:
    conn_str = f"Server={server};Database={database};Authentication=ActiveDirectoryDefault;Encrypt=yes;"

conn = mssql_python.connect(conn_str)

Tip

load_dotenv() nepřepisuje proměnné, které jsou už nastavené v prostředí. V produkci nastavte stejné názvy proměnných prostřednictvím vaší platformy (například pomocí nastavení aplikace ve službě App Service nebo proměnných prostředí kontejneru) a soubor .env zcela vynechejte.

Konfigurace založená na souborech

Z konfigurace JSON

JSON konfigurační soubor vám umožní definovat nastavení připojení pro více prostředí (vývoj, staging, produkce) na jednom místě. Funkce přečte soubor, vybere cílové prostředí a vytvoří připojovací řetězec ze strukturovaných nastavení:

import json
import io
import mssql_python

def load_connection_from_json(config_file, environment: str = "development") -> str:
    """Load connection settings from a JSON config file or file-like object."""
    config = json.load(config_file)

    env_config = config.get(environment, {})
    db_config = env_config.get("database", {})

    params = {
        "Server": db_config.get("server"),
        "Database": db_config.get("database"),
        "Encrypt": "yes" if db_config.get("encrypt", True) else "no",
    }

    auth_type = db_config.get("authentication", "sql")
    if auth_type == "msi":
        params["Authentication"] = "ActiveDirectoryMSI"
    elif auth_type == "default":
        params["Authentication"] = "ActiveDirectoryDefault"
    elif auth_type == "windows":
        params["Trusted_Connection"] = "yes"
    else:
        params["UID"] = db_config.get("username")
        params["PWD"] = db_config.get("password")

    return ";".join(f"{k}={v}" for k, v in params.items() if v)

# Example: load from an inline JSON config (in production, use open("config.json"))
sample_config = json.dumps({
    "development": {
        "database": {
            "server": "localhost",
            "database": "devdb",
            "authentication": "windows",
            "encrypt": False
        }
    },
    "production": {
        "database": {
            "server": "prod.database.windows.net",
            "database": "proddb",
            "authentication": "msi",
            "encrypt": True
        }
    }
})

conn_str = load_connection_from_json(io.StringIO(sample_config), "production")
print(f"Connection string: {conn_str}")

Z konfigurace YAML

YAML konfigurační soubory jsou čitelnou alternativou k JSON. Běžně se používají v Python projektech a nasazeních Kubernetes. Tento přístup čte nastavení spojení ze strukturovaného YAML souboru a vytváří připojovací řetězec na základě autentizačního typu definovaného v konfiguraci.

Nainstalujte balíček spuštěním pip install pyyaml.

Vytvořte database.yml soubor ve svém projektu:

database:
  server: <server>.database.windows.net
  name: <database>
  authentication: msi
  encrypt: true

Pak načtěte a použijte tato nastavení ve svém skriptu:

import yaml
import mssql_python

def load_from_yaml(config_path: str) -> mssql_python.Connection:
    """Load connection from YAML config."""
    with open(config_path) as f:
        config = yaml.safe_load(f)

    db = config["database"]

    parts = [
        f"Server={db['server']}",
        f"Database={db['name']}",
    ]

    if db.get("trusted_connection"):
        parts.append("Trusted_Connection=yes")
    elif db.get("authentication") == "msi":
        parts.append("Authentication=ActiveDirectoryMSI")
    else:
        parts.append(f"UID={db['username']}")
        parts.append(f"PWD={db['password']}")

    if db.get("encrypt", True):
        parts.append("Encrypt=yes")
    if db.get("trust_server_certificate"):
        parts.append("TrustServerCertificate=yes")

    return mssql_python.connect(";".join(parts))

conn = load_from_yaml("database.yml")

Integrace služby Azure Key Vault

Pro produkční nasazení ukládejte přihlašovací údaje k připojení do Azure Key Vault místo do konfiguračních souborů nebo proměnných prostředí. Key Vault poskytuje centralizovanou správu tajemství, auditování přístupu a automatickou rotaci. Nainstalujte potřebné balíčky spuštěním pip install azure-keyvault-secrets azure-identity. Pro kompletní průchod viz Quickstart: Azure Key Vault secret client library for Python.

import os
from azure.identity import DefaultAzureCredential
from azure.keyvault.secrets import SecretClient
import mssql_python

def get_connection_from_keyvault(vault_url: str) -> mssql_python.Connection:
    """Build connection using secrets from Azure Key Vault."""
    credential = DefaultAzureCredential()
    client = SecretClient(vault_url=vault_url, credential=credential)

    server = client.get_secret("sql-server").value
    database = client.get_secret("sql-database").value
    username = client.get_secret("sql-username").value
    password = client.get_secret("sql-password").value

    conn_str = f"Server={server};Database={database};UID={username};PWD={password};Encrypt=yes;"
    return mssql_python.connect(conn_str)

vault_url = os.environ.get("AZURE_KEY_VAULT_URL")
if vault_url:
    conn = get_connection_from_keyvault(vault_url)

Zpracování speciálních znaků

Únikové středníky a rovnátka

Musíte uniknout hodnotám připojovací řetězec, které obsahují speciální znaky. Omotejte hodnotu do závorek {} a zdvojnásobte všechny vnitřní uzavírací výztuhy }:

def escape_value(value: str) -> str:
    """Escape special characters in connection string values."""
    if ";" in value or "{" in value or "}" in value:
        # Wrap in braces and escape internal braces
        value = value.replace("}", "}}")
        return "{" + value + "}"
    return value

# Password with semicolon
password = "my;complex;password"
escaped_password = escape_value(password)  # {my;complex;password}

conn_str = f"Server=<server>;Database=<database>;UID=<login>;PWD={escaped_password};"

Stavitel s automatickým únikem

Tato třída buildera automaticky zabalí každou hodnotu, takže volající nemusí pamatovat pravidla úniku. Použijte ho, když parametry spojení pocházejí z externích vstupů, jako jsou uživatelské formuláře, konfigurační API nebo tajná úložiště, kde hodnoty mohou obsahovat středníky nebo závorky:

class SafeConnectionStringBuilder:
    """Connection string builder with automatic escaping."""

    SPECIAL_CHARS = {";", "{", "}"}

    def __init__(self):
        self._params = {}

    def _escape(self, value: str) -> str:
        if any(c in value for c in self.SPECIAL_CHARS):
            value = value.replace("}", "}}")
            return "{" + value + "}"
        return value

    def set(self, key: str, value: str) -> "SafeConnectionStringBuilder":
        self._params[key] = self._escape(value)
        return self

    def build(self) -> str:
        return ";".join(f"{k}={v}" for k, v in self._params.items())

# Safely handles special characters
builder = SafeConnectionStringBuilder()
builder.set("Server", "<server>.database.windows.net")
builder.set("Database", "<database>")
builder.set("PWD", "pass;word{with}special")  # Automatically escaped

conn_str = builder.build()

Validation

Než použijete dynamicky vytvářený připojovací řetězec ve své aplikaci, ověřte, že se skutečně připojuje. Tato pomocná funkce se pokusí o lehký dotaz a vrátí booleovský výsledek:

import mssql_python

def validate_connection_string(conn_str: str) -> bool:
    """Validate a connection string by attempting to connect."""
    try:
        conn = mssql_python.connect(conn_str)
        cursor = conn.cursor()
        cursor.execute("SELECT 1")
        cursor.fetchone()
        conn.close()
        return True
    except mssql_python.Error as e:
        print(f"Connection failed: {e}")
        return False

# Test before using
conn_str = "Server=<server>.database.windows.net;Database=<database>;Authentication=ActiveDirectoryDefault;Encrypt=yes;"
if validate_connection_string(conn_str):
    print("Connection string is valid")

Související obsah

• Připojovací řetězce
• Ověřování Microsoft Entra
• Správa připojení