sqlite3-api

2.0.4 · maintenance · verified Tue Apr 14

The `sqlite3-api` library (PyPI package version 2.0.4) provides a thin Pythonic wrapper for interacting with SQLite databases. It simplifies some interactions but appears to be minimally maintained, with its last release in November 2021. Most Python users typically interact with SQLite using the `sqlite3` module from Python's standard library, which offers a comprehensive DB-API 2.0 compliant interface.

Warnings

gotcha The `sqlite3-api` PyPI package is a separate, third-party wrapper, not the built-in `sqlite3` module that ships with Python. Most Python users interacting with SQLite should use the standard library's `sqlite3` module, which is actively maintained and fully DB-API 2.0 compliant.
Fix: For direct SQLite access without external dependencies, use `import sqlite3`. If a higher-level ORM or wrapper is desired, consider more widely adopted and actively maintained alternatives.
deprecated The `sqlite3-api` package appears to be minimally maintained, with its last release in November 2021. Users seeking active development, community support, or robust features should consider Python's built-in `sqlite3` module or other actively maintained database access layers.
Fix: Evaluate whether the built-in `sqlite3` module or another maintained library (e.g., SQLAlchemy for ORM, or a more recent, community-supported wrapper) better suits your project's needs.
gotcha While the `sqlite3-api` wrapper might abstract some cursor management, explicit transaction control (e.g., `conn.commit()` and `conn.rollback()`) is still crucial for ensuring data integrity, especially after write operations. Forgetting to commit will result in changes not being saved.
Fix: Always call `conn.commit()` after any operations that modify the database (INSERT, UPDATE, DELETE). Use `conn.rollback()` if an error occurs and changes should not be persisted. Consider using a `try...except...finally` block for robust error handling and resource management.

Install

pip install sqlite3-api Install from PyPI

Imports

SQL
```
from sqlite3_api import SQL
```
The primary class for database interaction in this wrapper library.

Quickstart

This quickstart demonstrates how to establish a connection, create a table, insert, query, and update data using the `sqlite3-api` wrapper. It emphasizes explicit commit/rollback for transaction management and closing the connection.

import os
from sqlite3_api import SQL

# Create an in-memory database (for a file-based DB, use 'my_database.db')
db_path = ':memory:' 
conn = SQL(db_path)

try:
    # Create a table
    conn.execute("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)")

    # Insert data
    conn.execute("INSERT INTO users (name) VALUES (?)", ("Alice",))
    conn.execute("INSERT INTO users (name) VALUES (?)", ("Bob",))
    conn.commit() # Explicitly commit changes

    # Query data
    print("--- All Users ---")
    results = conn.query("SELECT * FROM users")
    for row in results:
        print(row)

    # Update data
    conn.execute("UPDATE users SET name = ? WHERE id = ?", ("Charlie", 1))
    conn.commit() # Explicitly commit changes

    # Verify update
    print("\n--- Updated User 1 ---")
    updated_user = conn.query("SELECT name FROM users WHERE id = 1")
    for row in updated_user:
        print(row)

except Exception as e:
    print(f"An error occurred: {e}")
    conn.rollback() # Rollback on error
finally:
    conn.close() # Always close the connection

view raw JSON →