Praca z danymi binarnymi

Sterownik mssql-python obsługuje binary, varbinary, oraz image typy danych dla Microsoft SQL.

Microsoft SQL przechowuje dane binarne w następujących typach kolumn:

Typ	Opis	Maksymalny rozmiar
binary(n)	Dane binarne o stałej długości.	8 000 bajtów
varbinary(n)	Dane binarne o zmiennej długości.	8 000 bajtów
varbinary(max)	Duże dane binarne.	2 GB
image	Starsze duże dane binarne (wycofane).	2 GB

Sterownik mssql-python zwraca dane binarne jako obiekty Pythonbytes.

Kiedy przechowywać plik binarny w bazie danych, a kiedy w systemie plików:

• Przechowuj w bazie danych, gdy pliki są małe (poniżej 1 MB), ważna jest spójność transakcyjna z innymi danymi lub gdy trzeba tworzyć wspólne kopie zapasowe danych i plików.
• Przechowuj pliki w systemie plików (lub w usłudze Azure Blob Storage), gdy pliki są duże (powyżej 1 MB), potrzebujesz dostarczania za pośrednictwem sieci CDN lub musisz udostępniać pliki bezpośrednio klientom bez odwoływania się do bazy danych.
• Jako rozwiązanie pośrednie funkcja FILESTREAM w programie Microsoft SQL Server przechowuje dane w systemie plików przy zachowaniu spójności transakcyjnej.

Wstaw dane binarne

Przekazuj obiekty Python bytes jako parametry; sterownik mapuje je na kolumny varbinarne.

Wstawiaj bajty bezpośrednio

Stwórz obiekt Python bytes i przekaż go jako parametr zapytania:

import mssql_python

conn = mssql_python.connect(connection_string)
cursor = conn.cursor()

# Create a table to hold binary documents
cursor.execute("""
    CREATE TABLE #Documents (
        ID INT IDENTITY PRIMARY KEY,
        Name NVARCHAR(255),
        Content VARBINARY(MAX),
        Size INT NULL,
        ContentHash VARBINARY(32) NULL
    )
""")

# Binary data as bytes
binary_data = b'\x00\x01\x02\x03\x04\x05'

cursor.execute(
    "INSERT INTO #Documents (Name, Content) VALUES (%(name)s, %(content)s)",
    {"name": "sample.bin", "content": binary_data}
)
conn.commit()

Wstaw z pliku

Przeczytaj plik w trybie binarnym i wstaw jego treść:

def insert_file(cursor, file_path: str, name: str):
    """Insert a file as binary data."""
    with open(file_path, "rb") as f:
        content = f.read()
    
    cursor.execute(
        "INSERT INTO #Documents (Name, Content, Size) VALUES (%(name)s, %(content)s, %(size)s)",
        {"name": name, "content": content, "size": len(content)}
    )

insert_file(cursor, "image.png", "profile_picture.png")
conn.commit()

Wstaw plik obrazowy

Przechowuj pliki obrazów z metadanymi, wykrywając typy MIME z rozszerzenia plików:

# Create a table to hold images
cursor.execute("""
    CREATE TABLE #Images (
        ID INT IDENTITY PRIMARY KEY,
        FileName NVARCHAR(255),
        FileSize INT NULL,
        ContentType NVARCHAR(100) NULL,
        Width INT NULL,
        Height INT NULL,
        ImageData VARBINARY(MAX),
        Description NVARCHAR(MAX) NULL
    )
""")

def insert_image(cursor, image_path: str, description: str):
    """Insert an image into the database."""
    import os
    
    with open(image_path, "rb") as f:
        image_data = f.read()
    
    cursor.execute("""
        INSERT INTO #Images (FileName, FileSize, ContentType, ImageData, Description)
        VALUES (%(filename)s, %(filesize)s, %(content_type)s, %(data)s, %(desc)s)
    """, {
        "filename": os.path.basename(image_path),
        "filesize": len(image_data),
        "content_type": get_content_type(image_path),
        "data": image_data,
        "desc": description
    })

def get_content_type(path: str) -> str:
    """Determine MIME type from file extension."""
    ext = path.lower().split(".")[-1]
    types = {
        "png": "image/png",
        "jpg": "image/jpeg",
        "jpeg": "image/jpeg",
        "gif": "image/gif",
        "pdf": "application/pdf",
    }
    return types.get(ext, "application/octet-stream")

Pobieranie danych binarnych

Sterownik zwraca wartości kolumnowe warbinarne i binarne jako obiekty Pythonbytes.

Pobierz kolumnę binarną

Wykonaj zapytanie dotyczące kolumn binarnych i sprawdź zwrócony obiekt bytes:

cursor.execute(
    "SELECT LargePhotoFileName, LargePhoto FROM Production.ProductPhoto WHERE ProductPhotoID = %(id)s",
    {"id": 70}
)
row = cursor.fetchone()

# LargePhoto is bytes
print(type(row.LargePhoto))  # <class 'bytes'>
print(len(row.LargePhoto))   # Number of bytes

Zapisz do pliku

Pobierz dane binarne i zapisz je na dysku:

def save_photo(cursor, photo_id: int, output_path: str):
    """Retrieve binary data and save to file."""
    cursor.execute(
        "SELECT LargePhoto FROM Production.ProductPhoto WHERE ProductPhotoID = %(id)s",
        {"id": photo_id}
    )
    row = cursor.fetchone()
    
    if row and row.LargePhoto:
        with open(output_path, "wb") as f:
            f.write(row.LargePhoto)
        print(f"Saved {len(row.LargePhoto)} bytes to {output_path}")
    else:
        print("Photo not found or empty")

save_photo(cursor, 70, "output.gif")

Eksport wierszy binarnych do plików

Eksport wielu wierszy binarnych do plików lokalnych:

import os

def export_photos(cursor, output_dir: str):
    """Export product photos to a directory."""
    os.makedirs(output_dir, exist_ok=True)
    
    cursor.execute("""
        SELECT ProductPhotoID, LargePhotoFileName, LargePhoto
        FROM Production.ProductPhoto
        WHERE ProductPhotoID > 1
    """)
    
    count = 0
    for row in cursor:
        output_path = os.path.join(output_dir, f"{row.ProductPhotoID}_{row.LargePhotoFileName}")
        with open(output_path, "wb") as f:
            f.write(row.LargePhoto)
        count += 1
    
    print(f"Exported {count} photos to {output_dir}")

export_photos(cursor, "./photos")

Wstaw wartości binarne NULL

Przekaż None, aby wstawić wartość SQL NULL do kolumny binarnej. Ponieważ #Documents jest tabelą tymczasową, zadeklaruj najpierw typy parametrów za pomocą setinputsizes(), aby sterownik powiązał Content jako varbinary:

cursor.setinputsizes([(mssql_python.SQL_WVARCHAR, 255, 0), (mssql_python.SQL_VARBINARY, 0, 0)])
cursor.execute(
    "INSERT INTO #Documents (Name, Content) VALUES (%(name)s, %(content)s)",
    {"name": "empty", "content": None}
)

Note

Sterownik zwykle wnioskuje typy parametrów przez SQLDescribeParam, ale nie jest w stanie rozwiązać metadanych typów dla tymczasowej tabeli lub zmiennej tabelowej. Wstawienie None do kolumny binary lub varbinary obiektu tymczasowego bez setinputsizes() podnoszenia ProgrammingError: Implicit conversion from data type varchar to varbinary(max) is not allowed. Przekaż po jednym wpisie dla każdego parametru, we właściwej kolejności, i użyj stałej typu SQL, na przykład mssql_python.SQL_VARBINARY dla kolumny binarnej. W przypadku zwykłej (trwałej) tabeli sterownik automatycznie określa typ i można bezpośrednio przekazać None.

Duże dane binarne

W przypadku plików o rozmiarze powyżej kilku megabajtów wstaw całą zawartość w ramach jednej operacji zapisu do varbinary(max), zamiast odczytywać plik małymi fragmentami.

Strumieniowanie dużych plików

Dla dużych plików przetwarzaj w kawałkach:

def insert_large_file(conn, table: str, file_path: str, chunk_size: int = 8192):
    """Insert large file in chunks using updatetext-style approach."""
    # Validate table name to prevent SQL injection
    import re
    if not re.match(r'^#{0,2}[A-Za-z_][A-Za-z0-9_.]*$', table):
        raise ValueError(f"Invalid table name: {table}")

    cursor = conn.cursor()
    
    # Get file size
    import os
    file_size = os.path.getsize(file_path)
    
    # Insert initial row with empty binary
    cursor.execute(f"""
        INSERT INTO {table} (Name, Content, Size)
        VALUES (%(name)s, 0x, %(size)s);
        SELECT SCOPE_IDENTITY();
    """, {"name": os.path.basename(file_path), "size": file_size})
    
    row_id = cursor.fetchval()
    
    # For modern Microsoft SQL, better to use varbinary(max) and single insert
    # This example shows streaming approach
    with open(file_path, "rb") as f:
        content = f.read()
    
    cursor.execute(f"""
        UPDATE {table} SET Content = %(content)s WHERE ID = %(id)s
    """, {"content": content, "id": row_id})
    
    conn.commit()
    return row_id

Użyj kopii masowej dla danych binarnych

Użyj bulkcopy() tej metody do efektywnego wstawiania wielu plików binarnych w jednej operacji.

Important

bulkcopy() ładuje dane przez osobne połączenie z serwerem, więc tabela docelowa musi już istnieć, być zatwierdzona i widoczna dla innych sesji. Jeśli tworzysz tabelę w tym samym skrypcie z wyłączonym autocommit, wywołaj conn.commit() przed bulkcopy(). Lokalne tabele tymczasowe (#name) nie są obsługiwane, ponieważ są prywatne dla sesji, która je utworzyła. Niepotwierdzone lub nieosiągalne miejsce docelowe powoduje, że bulkcopy() kończy się niepowodzeniem z powodu limitu czasu Failed to retrieve destination metadata.

Domyślnie bulkcopy() przypisuje każdą wartość w wierszu do kolumny tabeli według jej pozycji, więc dla każdej kolumny po kolei musi istnieć odpowiadająca jej wartość. Gdy tabela ma kolumnę identity lub wypełniasz tylko niektóre kolumny, przekaż column_mappings, aby jawnie określić kolumny docelowe. W przeciwnym razie wartości przesuwają się na złe kolumny i bulkcopy() zawodzi.

def bulk_insert_files(conn, table: str, file_paths: list[str]):
    """Bulk insert multiple binary files."""
    import os

    data = []
    for path in file_paths:
        with open(path, "rb") as f:
            content = f.read()
        data.append((os.path.basename(path), content, len(content)))

    cursor = conn.cursor()
    result = cursor.bulkcopy(table, data, column_mappings=["Name", "Content", "Size"])
    conn.commit()
    return result["rows_copied"]

Operacje binarne

Użyj funkcji Microsoft SQL HASHBYTES do porównywania treści binarnych bez pobierania pełnych wartości.

Porównaj dane binarne

Znajdź wiersze binarne, które dzielą identyczną zawartość, obliczając i porównując hashe treści w Microsoft SQL Server:

# Find rows with identical binary content by hash
cursor.execute("""
    SELECT LargePhotoFileName, HASHBYTES('SHA2_256', LargePhoto) AS PhotoHash
    FROM Production.ProductPhoto
    WHERE ProductPhotoID > 1
""")

hashes = {}
for row in cursor:
    hash_value = row.PhotoHash  # bytes
    if hash_value in hashes:
        print(f"Duplicate: {row.LargePhotoFileName} matches {hashes[hash_value]}")
    else:
        hashes[hash_value] = row.LargePhotoFileName

Oblicz hash w Pythonie

Oblicz skróty SHA-256 w Python i przechowuj je obok danych binarnych:

import hashlib

def insert_with_hash(cursor, name: str, content: bytes):
    """Insert binary data with computed hash."""
    content_hash = hashlib.sha256(content).digest()
    
    cursor.execute("""
        INSERT INTO #Documents (Name, Content, ContentHash)
        VALUES (%(name)s, %(content)s, %(hash)s)
    """, {"name": name, "content": content, "hash": content_hash})

Kodowanie i dekodowanie danych binarnych

Przekonwertowanie danych binarnych na i z łańcuchów kodowanych w base64:

import base64

# Store base64-encoded string
def insert_base64(cursor, name: str, base64_data: str):
    """Insert base64-encoded data as binary."""
    binary_data = base64.b64decode(base64_data)
    cursor.execute(
        "INSERT INTO #Documents (Name, Content) VALUES (%(name)s, %(content)s)",
        {"name": name, "content": binary_data}
    )

# Retrieve as base64
def get_as_base64(cursor, doc_id: int) -> str:
    """Retrieve binary data as base64 string."""
    cursor.execute("SELECT Content FROM #Documents WHERE ID = %(id)s", {"id": doc_id})
    row = cursor.fetchone()
    return base64.b64encode(row.Content).decode("utf-8")

Praca z konkretnymi formatami binarnymi

Te przykłady pokazują, jak zweryfikować i wstawić popularne formaty plików przed ich zapisem.

Dokumenty PDF

Sprawdź podpisy plików PDF przed ich wstawieniem:

def insert_pdf(cursor, pdf_path: str, title: str):
    """Insert a PDF document."""
    with open(pdf_path, "rb") as f:
        pdf_data = f.read()
    
    # Verify it's a PDF (magic bytes)
    if not pdf_data.startswith(b'%PDF'):
        raise ValueError("Not a valid PDF file")
    
    cursor.execute(
        "INSERT INTO #Documents (Name, Content) VALUES (%(title)s, %(data)s)",
        {"title": title, "data": pdf_data}
    )

Zdjęcia z PIL/Pillow

Zmień rozmiar obrazów za pomocą Pillow (PIL) przed ich przechowywaniem, aby zaoszczędzić miejsce:

from PIL import Image
import io
import os

def insert_resized_image(cursor, image_path: str, max_size: tuple = (800, 600)):
    """Insert a resized image."""
    # Open and resize
    img = Image.open(image_path)
    img.thumbnail(max_size, Image.LANCZOS)
    
    # Convert to bytes
    buffer = io.BytesIO()
    img.save(buffer, format=img.format or "PNG")
    image_bytes = buffer.getvalue()
    
    cursor.execute("""
        INSERT INTO #Images (FileName, Width, Height, ImageData)
        VALUES (%(name)s, %(width)s, %(height)s, %(data)s)
    """, {
        "name": os.path.basename(image_path),
        "width": img.width,
        "height": img.height,
        "data": image_bytes
    })

def get_image_as_pil(cursor, image_id: int) -> Image.Image:
    """Retrieve image as PIL Image object."""
    cursor.execute("SELECT ImageData FROM #Images WHERE ID = %(id)s", {"id": image_id})
    row = cursor.fetchone()
    return Image.open(io.BytesIO(row.ImageData))

Skompresowane dane

Ogranicz pamięć, kompresując dane binarne za pomocą gzip przed wstawieniem:

import gzip

def insert_compressed(cursor, name: str, data: bytes):
    """Insert data with gzip compression."""
    compressed = gzip.compress(data)
    
    cursor.execute(
        "INSERT INTO #Documents (Name, Content, Size) VALUES (%(name)s, %(content)s, %(size)s)",
        {"name": name, "content": compressed, "size": len(data)}
    )

def get_decompressed(cursor, data_id: int) -> bytes:
    """Retrieve and decompress data."""
    cursor.execute(
        "SELECT Content FROM #Documents WHERE ID = %(id)s",
        {"id": data_id}
    )
    row = cursor.fetchone()
    return gzip.decompress(row.Content)

Najlepsze rozwiązania

Zastosuj te wytyczne, aby wybrać odpowiedni typ kolumny i strategię przechowywania danych binarnych.

Używaj odpowiednich typów kolumn

Wybierz typ kolumny na podstawie cech swoich danych:

Dla różnych przypadków użycia binarnego wybierz odpowiedni typ danych Microsoft SQL:

-- For small fixed-size binary (for example, hashes, UUIDs)
binary(32)      -- SHA-256 hash

-- For variable-size binary up to 8KB (for example, thumbnails, small icons)
varbinary(8000)

-- For large binary data (for example, documents, images)
varbinary(max)  -- Up to 2GB

Rozważ FILESTREAM dla dużych plików

Dla dużych plików (powyżej 1 MB) rozważ funkcję Microsoft SQL FILESTREAM, która przechowuje dane w systemie plików. FILESTREAM wymaga konfiguracji po stronie serwera przed użyciem:

# FILESTREAM-enabled databases store large binaries more efficiently
# Access is still through normal queries but storage is file-based
large_binary_data = b"\x25\x50\x44\x46" + b"\x00" * 100  # sample data

cursor.execute("""
    CREATE TABLE ##FileStreamDemo (Name NVARCHAR(100), Document VARBINARY(MAX))
""")
cursor.execute("""
    INSERT INTO ##FileStreamDemo (Name, Document)
    VALUES (%(name)s, %(content)s)
""", {"name": "large_doc.pdf", "content": large_binary_data})

cursor.execute("SELECT Name, DATALENGTH(Document) AS DocSize FROM ##FileStreamDemo")
row = cursor.fetchone()
print(f"{row.Name}: {row.DocSize} bytes")

Walidacja danych binarnych

Weryfikuj typy plików, sprawdzając magiczne bajty (sygnatury plików) przed zapisaniem danych binarnych:

def insert_safe_image(cursor, name: str, data: bytes):
    """Insert image with validation."""
    # Check file signatures (magic bytes)
    signatures = {
        b'\x89PNG': 'image/png',
        b'\xff\xd8\xff': 'image/jpeg',
        b'GIF87a': 'image/gif',
        b'GIF89a': 'image/gif',
    }
    
    content_type = None
    for sig, mime in signatures.items():
        if data.startswith(sig):
            content_type = mime
            break
    
    if content_type is None:
        raise ValueError("Unknown or unsupported image format")
    
    cursor.execute("""
        INSERT INTO #Images (FileName, ContentType, ImageData)
        VALUES (%(name)s, %(type)s, %(data)s)
    """, {"name": name, "type": content_type, "data": data})

Treści powiązane

• Mapowania typów danych
• Kopiowanie masowe
• Obsługa wartości NULL