Curso de MariaDB / Conectar Python y usar consultas parametrizadas con PyMySQL

Para conectar Python a MariaDB, transmita el texto SQL y los valores introducidos por el usuario como argumentos separados de la API del controlador. Las consultas parametrizadas evitan construir SQL con esos valores; una cuenta de permisos limitados y una decisión explícita entre commit y rollback controlan después los cambios.

Preparar el entorno y la cuenta de la aplicación

El ejemplo utiliza Python 3, PyMySQL 1.1.2 y una conexión TCP local a MariaDB. Su comportamiento central se comprobó con Python 3.12 y MariaDB 12.3.3. PyMySQL es el controlador que comunica Python con la base; los marcadores para valores de este ejemplo son %s. No los sustituya por los signos de interrogación de otro controlador.

Ejecute la preparación mediante una conexión de administrador. Sustituya el marcador público Replace_With_Your_Own_Lab_Password por su contraseña de prácticas. CREATE USER corresponde a la primera creación: si ya existe la cuenta o la tabla, inspecciónela antes de repetir el bloque. Confirme que un esquema appops_lab existente pertenece a estas prácticas. El tutorial sobre cuentas y permisos de MariaDB distingue estas responsabilidades.

CREATE DATABASE IF NOT EXISTS appops_lab
  CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
USE appops_lab;
CREATE TABLE app_notes (
  note_id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
  note_name VARCHAR(80) NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
CREATE USER 'appops_app'@'127.0.0.1'
  IDENTIFIED BY 'Replace_With_Your_Own_Lab_Password';
GRANT SELECT, INSERT ON appops_lab.app_notes TO 'appops_app'@'127.0.0.1';

El host de la cuenta, 127.0.0.1, supone acceso TCP a un servidor local nativo. Un contenedor o un servidor remoto puede ver otro origen de conexión. Revise la correspondencia entre hosts de cuenta y rutas de conexión en lugar de permitir acceso de administrador desde cualquier host para evitar un error.

Crear un proyecto aislado y guardar el programa completo

Cree una carpeta nueva y abra PowerShell en ella. Con Python instalado y disponible mediante python, cree el entorno e instale la versión del controlador usada en el ejemplo:

python -m venv .venv
.venv\Scripts\python.exe -m pip install PyMySQL==1.1.2

Invocar directamente el Python del entorno evita cambiar la política de ejecución de scripts de activación. En Linux o macOS, cree el entorno con python3 -m venv .venv y ejecute .venv/bin/python -m pip install PyMySQL==1.1.2. Guarde el programa completo siguiente en UTF-8 como notes_app.py, en la raíz del proyecto:

import argparse
import getpass
import os
import pymysql

def save_and_find(conn, name, sort_key="id"):
    if not name or len(name) > 80:
        raise ValueError("Name must contain 1 to 80 characters")
    columns = {"id": "note_id", "name": "note_name, note_id"}
    if sort_key not in columns:
        raise ValueError("Unknown sort key")
    with conn.cursor() as cur:
        cur.execute("INSERT INTO app_notes (note_name) VALUES (%s)", (name,))
        cur.execute(
            "SELECT note_id, note_name FROM app_notes "
            "WHERE note_name = %s ORDER BY " + columns[sort_key],
            (name,),
        )
        return cur.fetchall()

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument("--name", default="O'Reilly")
    parser.add_argument("--sort", choices=("id", "name"), default="id")
    args = parser.parse_args()
    password = getpass.getpass("Database password: ")
    conn = pymysql.connect(
        host=os.getenv("DB_HOST", "127.0.0.1"),
        port=int(os.getenv("DB_PORT", "3306")),
        user=os.getenv("DB_USER", "appops_app"),
        password=password,
        database="appops_lab",
        charset="utf8mb4", autocommit=False,
        connect_timeout=5, read_timeout=10, write_timeout=10,
    )
    try:
        rows = save_and_find(conn, args.name, args.sort)
        conn.commit()
        for note_id, note_name in rows:
            print(note_id, note_name)
    except Exception:
        conn.rollback()
        raise
    finally:
        conn.close()

if __name__ == "__main__":
    main()

El programa solicita la contraseña al iniciarse con getpass, en vez de guardarla en el código fuente o el SQL. También fija tiempos máximos de conexión, lectura y escritura y utiliza utf8mb4 para Unicode. El mensaje Database password: pide la contraseña de la base.

La configuración corresponde a prácticas locales en el PC. Una conexión que atraviese otra red necesita además TLS con verificación del certificado del servidor: proporcionar una contraseña no protege por sí solo el transporte.

Probar un nombre corriente y otro con apóstrofo

Desde la carpeta que contiene notes_app.py, ejecute por separado los dos comandos:

.venv\Scripts\python.exe notes_app.py --name "Notebook"
.venv\Scripts\python.exe notes_app.py --name "O'Reilly" --sort name

Introduzca la contraseña en cada inicio. El primero guarda Notebook y el segundo O'Reilly, incluido su apóstrofo; después buscan las filas del mismo nombre. En una tabla nueva y tras una ejecución de cada comando, cada resultado contiene su fila correspondiente. No exija un identificador AUTO_INCREMENT concreto: los datos previos y las inserciones revertidas pueden alterar la numeración.

Repetir un nombre inserta otra fila y devuelve todas las filas coincidentes. El ejemplo no declara nombres únicos. Si su proceso requiere evitar duplicados, defina qué identifica una nota y la restricción apropiada, en lugar de suponer que este programa ya lo resuelve.

Separar los valores de la sintaxis SQL

La llamada central es cur.execute(sql, (name,)): el SQL y la tupla de valores son argumentos separados. La coma crea una tupla de un solo elemento. No añada comillas SQL manuales alrededor de %s ni interpole entradas del usuario con el operador % de Python, una f-string o concatenación. Los ejemplos oficiales de PyMySQL muestran esta separación.

Un nombre como x' OR 1=1 -- debe permanecer como un único valor almacenado y buscado literalmente. No debe convertirse en una condición que seleccione todas las filas. «Consulta parametrizada» describe aquí la API empleada; no significa que todo controlador utilice necesariamente el protocolo de sentencias preparadas del servidor.

Los identificadores y palabras clave SQL, como nombres de columnas, ASC y DESC, no se sustituyen mediante parámetros ordinarios de valores. El fragmento ORDER BY procede exclusivamente del diccionario columns definido por el desarrollador. argparse y la propia función comprueban la selección, por lo que otro llamador tampoco puede saltarse la lista permitida. Consulte la referencia de argumentos de Cursor.execute.

Comprobar las transacciones y los permisos juntos

Con autocommit=False, que save_and_find termine correctamente no hace persistente la inserción por sí solo. main confirma después de que INSERT y SELECT tengan éxito, revierte ante una excepción y cierra la conexión en finally. Distinga esa confirmación de lo que puede observar otra conexión; el tutorial de transacciones InnoDB y COMMIT y ROLLBACK explica sus límites.

La función rechaza un nombre vacío, más de 80 caracteres o una clave de ordenación desconocida antes de insertar. Estos controles complementan los parámetros y las restricciones de la tabla. Los mensajes Name must contain 1 to 80 characters y Unknown sort key indican esos fallos de validación. Si una excepción aparece tras INSERT y antes del commit, el rollback de ese intento debe impedir que la fila se conserve.

La cuenta solo dispone de SELECT e INSERT sobre app_notes. Como no crea ni elimina tablas, no necesita CREATE ni DROP. Limitar permisos complementa la transmisión correcta de valores y reduce las operaciones disponibles ante otro defecto del programa. La referencia de conexión de PyMySQL detalla autocommit y los tiempos máximos.

Diagnosticar errores y retirar las prácticas

Síntoma Qué comprobar
ModuleNotFoundError Ejecute con el mismo Python de .venv utilizado para instalar PyMySQL.
Access denied Revise usuario, contraseña, host permitido y dirección del cliente vista por el servidor.
Conexión rechazada o tiempo agotado Compruebe servidor, DB_HOST, DB_PORT, cortafuegos y ruta real de red.
No aparece una fila tras el proceso Revise si una excepción provocó rollback y si consulta la base correcta después de confirmar.
Solo falla con apóstrofos Busque interpolación manual de entradas en lugar de pasarlas como valores a execute.

Para ajustes no secretos, PowerShell permite una sobreescritura como $env:DB_PORT = "3307". Mantenga la solicitud interactiva de contraseña. Quite una sobreescritura innecesaria con Remove-Item Env:DB_PORT o restaure su valor previo si ya estaba configurado antes del ejercicio.

Al finalizar, detenga el programa y confirme con el administrador que la cuenta y la tabla siguientes son las de prácticas que desea retirar:

DROP USER 'appops_app'@'127.0.0.1';
DROP TABLE appops_lab.app_notes;

No sustituya esos nombres por cuentas o tablas de negocio. Su eliminación no se recupera mediante un ROLLBACK ordinario; conserve antes los datos que necesite.