Skip to main content

A simple MySQL database helper for easy interactions

Project description

Database Library

A Python-based database management library that supports both MySQL and SQLite. It provides an easy-to-use interface for defining tables, inserting data, searching records, updating, deleting, and more.

Features

  • Supports MySQL (via PyMySQL) and SQLite.
  • Table creation, modification, and deletion.
  • Data insertion, updating, and querying.
  • Bulk insert operations.
  • Pagination support.
  • Schema introspection.
  • Data replication between SQLite and MySQL.

Installation

pip install pymysqlhelper

Usage

Initialize Database

from database import Database, LocalDatabase

# MySQL Database Connection
mysql_db = Database(username='root', password='password', host='localhost', port=3306, database='testdb')

# SQLite Local Database
sqlite_db = LocalDatabase(db_path='local.db')

Define a Table

table = mysql_db.define_table("users", id=Integer, name=Text, age=Integer)

Insert Data

mysql_db.insert("users", id=1, name="Alice", age=25)

Bulk Insert

data = [
    {"id": 2, "name": "Bob", "age": 30},
    {"id": 3, "name": "Charlie", "age": 22}
]
mysql_db.bulk_insert("users", data)

Search Data

users = mysql_db.search("users")
print(users)  # List of all users

Search with filters:

alice = mysql_db.search("users", id=1)
print(alice)

Get a Single Record

user = mysql_db.get("users", id=1)
print(user)

Update Data

mysql_db.update("users", {"id": 1}, {"age": 26})

Delete Data

mysql_db.delete("users", id=3)

List All Tables

tables = mysql_db.list_tables()
print(tables)

Count Rows

user_count = mysql_db.count_rows("users")
print(user_count)

Get Distinct Column Values

distinct_ages = mysql_db.distinct_values("users", "age")
print(distinct_ages)

Search with Pagination

users_page1 = mysql_db.search_paginated("users", page=1, page_size=2)
print(users_page1)

Get Table Schema

schema = mysql_db.get_table_schema("users")
print(schema)

Rename Table

mysql_db.rename_table("users", "members")

Add a Column

mysql_db.add_column("members", "email", "TEXT")

Drop a Column

mysql_db.drop_column("members", "email")

Delete Table

mysql_db.delete_table("members")

Replicate SQLite to MySQL

mysql_db.replicate_local_to_online(sqlite_db)

Replicate MySQL to SQLite

sqlite_db.replicate_online_to_local(mysql_db)

Get column type

print(sqlite_db.get_column_type("users", "age"))
print(my_sql.get_column_type("users", "age"))

Edit column type

sqlite_db.edit_column_type("users", "age", "VARCHAR(10)")
mysql_db.edit_column_type("users", "age", "TEXT")

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymysqlhelper-1.8.4.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymysqlhelper-1.8.4-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file pymysqlhelper-1.8.4.tar.gz.

File metadata

  • Download URL: pymysqlhelper-1.8.4.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pymysqlhelper-1.8.4.tar.gz
Algorithm Hash digest
SHA256 84f1b1fc937330b76fcbdc5db6de3f966f28d54b46dc1f7ce85a717df4e3d3dc
MD5 845aa9d03444a2ad1a7f0fd2a7f4a873
BLAKE2b-256 25bfa6d2dc7c52b16c1a4cce90db9cdab987e9c2f4bf181cf45b53c4e682ef38

See more details on using hashes here.

File details

Details for the file pymysqlhelper-1.8.4-py3-none-any.whl.

File metadata

  • Download URL: pymysqlhelper-1.8.4-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pymysqlhelper-1.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3807b8b8b0ae288c88ce21cd220a416573483cce94aa92498eb688636a7336b4
MD5 776d047cf2734792ee9ae5e0e9cd9fcb
BLAKE2b-256 bda8d6835c156f67c12a8b7bd1132eefdc3cca66587c7a8b435b628fdbc906cc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page