Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 3.29 KB

README.md

File metadata and controls

96 lines (61 loc) · 3.29 KB
Raw

SQLiteX33

📋 Overview

SQLiteX33 is a lightweight and streamlined context manager for SQLite databases in Python.
It simplifies the process of running SQL queries and ensures best practices such as committing transactions and closing connections.

🌟 Features

  • Seamless SQLite Connection Management: Easily manage SQLite database connections without the hassle.
  • External Execute Function: Provides a handy external function to execute SQL commands, making it easier to integrate into other modules.
  • Foreign Key Support: Automatically enables FOREIGN KEYS for SQLite 3 out of the box.

⚙️ Installation

🛠️ Prerequisites

  1. 🐍 Python: SQLiteX33 is a Python context manager. Ensure you have Python installed on your system. You can download it from Python's official website.

  2. 🖋️ IDE: For code editing, VS Code (Visual Studio Code) is recommended. Enhance your Python experience by adding the Python extension.

  3. 🔍 SQLite Extension (Optional): For easier overview and editing of SQLite databases, it's good to have an SQLite extension. @yy0931's SQLite3 Editor for VSCode is highly recommended.

⬇️ Steps

To set up SQLiteX33 in your project:

  1. Download: Download the sqlite_x33.py file from this repository.

  2. Place in Project Directory: Move the sqlite_x33.py file to the root directory of your Python project, or where you plan on using SQLiteX33.

  3. Import and Use: Follow the usage instructions below to get started with SQLiteX33.


🚀 Usage

1. Import the Python Module

To use SQLiteX33, first import the module in your Python script:

import sqlite_x33 as sql

2. Using the Context Manager

Fetching Data

result = sql.execute("path_to_db.db", "SELECT * FROM table_name")

Inserting Data

sql.execute("path_to_db.db", "INSERT INTO table_name (column1, column2) VALUES ('value1', 'value2')")

Updating Data

sql.execute("path_to_db.db", "UPDATE table_name SET column1 = 'new_value' WHERE column2 = 'value2'")

Deleting Data

sql.execute("path_to_db.db", "DELETE FROM table_name WHERE column1 = 'value1'")

⚠️ Important Notes

  • The sql.execute() function returns the result of a SELECT query. If the SQL command was an INSERT/UPDATE/DELETE, it returns None.
  • This context manager allows only one SQL query to be executed at a time. To run multiple queries, call sql.execute() separately for each query.
  • Ensure the SQLite database file path provided is correct.

💡 Credits

Developed by hodel33 & dyaland. Enjoy and have fun! 💫


💬 Feedback & Contact

I'd love to network, discuss tech, or swap music recommendations. Feel free to connect with me on:

🌐 LinkedIn: Björn Hödel
🐦 Twitter: @hodel33
📸 Instagram: @hodel33
📧 Email: [email protected]