abarorm is a lightweight and easy-to-use Object-Relational Mapping (ORM) library for SQLite and PostgreSQL databases in Python. It aims to provide a simple and intuitive interface for managing database models and interactions.
 | abarorm is a lightweight and easy-to-use Object-Relational Mapping (ORM) library for SQLite and PostgreSQL databases in Python. It provides a simple and intuitive interface for managing database models and interactions. |
|---|
create_table() calls.all() method.filter method now supports order_by functionality for result ordering.__gte and __lte functionality in the filter section.__repr__, count, and to_dict methods for easier data manipulation and debugging.first(), last(), exists(), and paginate() methods to the QuerySet class for more powerful querying capabilities.PostgreSQL Bugs and structure.
filter() and exclude() methods for more flexibility and ease of use.You can install abarorm from PyPI using pip:
pip install abarorm
For PostgreSQL support, you need to install psycopg2-binary:
pip install psycopg2-binary
For detailed documentation, examples, and advanced usage, please visit the official abarorm documentation website.
Before defining models, you need to set up your database configuration. This involves specifying connection parameters for the database you are using (SQLite and PostgreSQL). Here’s an example of how to configure the database:
# Database configuration
DATABASE_CONFIG = {
'sqlite': {
'db_name': 'example.db', # Name of the SQLite database file
},
'postgresql': {
'host': 'localhost',
'user': 'hoopad',
'password': 'db_password',
'database': 'example_db', # Ensure this matches everywhere
'port': 5432,
}
}
After setting up the database configuration, you can define your models. A model is a representation of a database table. Here’s how to create a model using abarorm:
from abarorm import SQLiteModel, PostgreSQLModel
from abarorm.fields.sqlite import CharField, DateTimeField, ForeignKey
from abarorm.fields import psql
# Define the Category model for SQLite
class Category(SQLiteModel):
class Meta:
db_config = DATABASE_CONFIG['sqlite']
table_name = 'categories' # Name of the table for storing the Category model data
title = CharField(max_length=200, null=False) # Title of the category, must be unique and not null
create_time = DateTimeField(auto_now=True, auto_now_add=True) # Automatically set to current datetime
update_time = DateTimeField(auto_now=True) # Automatically set to current datetime
# Define the Post model for Postgresql
class Post(PostgreSQLModel):
class Meta:
db_config = DATABASE_CONFIG['postgresql']
title = psql.CharField(max_length=100, null=False) # Title of the post, must be unique and not null
create_time = psql.DateTimeField(auto_now=True) # Automatically set to current datetime
category = psql.ForeignKey(to=Category) # Foreign key referring to the Category model
Now that you have defined your models, you can perform CRUD operations. Here’s a breakdown of each operation:
To create new records in the database, use the create() method. For example:
# Create a new category
Category.create(title='Movies')
# Create a new post
category = Category.get(id=1) # Fetch the category with ID 1
if category:
Post.create(title='Godfather', category=category.id) # Create a new post associated with the fetched category
To read records from the database, use the all() or get() methods:
# Retrieve all posts
all_posts = Post.all()
# Retrieve a specific post by ID
post_data = Post.get(id=1)
The filter() method allows you to retrieve records based on specified criteria. You can use keyword arguments to filter by field values and sort the results using order_by.
# Filter posts by category ID and order by creation time
filtered_posts = Post.filter(category=category.id, order_by='-create_time')
You can also use special lookup expressions like __gte (greater than or equal to) and __lte (less than or equal to) for more complex queries:
# Retrieve posts created after a specific date
filtered_posts = Post.filter(create_time__gte='2024-01-01 00:00:00')
To update existing records, fetch the record, modify its attributes, and then save it:
if post_data:
post_data.title = "The Godfather"
post_data.save() # Save the updated post data
Or:
Post.update(1, title='Updated Godfather') # Update the title of the post with ID 1 to 'Updated Godfather'
To delete a record from the database, use the delete() method:
Post.delete(1) # Delete the post with ID 1
After performing operations on the model, you can convert records to dictionaries using the to_dict() method and count the number of records using the count() method.
to_dict MethodThe to_dict() method converts a model instance into a dictionary, making it easier to manipulate and serialize the data.
Example:
# Retrieve a post by ID
post = Post.get(id=1)
# Convert the post to a dictionary
post_dict = post.all().to_dict()
print(post_dict)
# Output: [{'id': 1, 'title': 'Godfather', 'create_time': '2024-01-01 12:00:00', ...}]
count MethodThe count() method allows you to get the number of records in a model's table.
Example:
# Count the number of posts in the database
num_posts = Post.count()
print(num_posts) # Output: 10 (if there are 10 posts in the database)
first(), last(), exists(), order_by(), and paginate()first(): Returns the first result or None if no results are present.last(): Returns the last result or None if no results are present.exists(): Checks if any records exist in the QuerySet.paginate(): Handles pagination of results, allowing you to retrieve subsets of data based on page and page size.Example:
# Check if any posts exist
exists = Post.all().exists()
# Get the first post
first_post = Post.all().first()
# Get the last post
last_post = Post.all().last()
# Paginate the results
paginated_posts = Post.all().paginate(1, 5) # Page 1, 5 results per page
# Using multiple querysets in one query
posts = Post.filter(title='Godfather').order_by('create_time').paginate(1, 4).to_dict()
These methods are particularly useful for data manipulation and debugging, as they provide a simple way to view and interact with your database records.
first(): Added to return the first result in a QuerySet.last(): Added to return the last result in a QuerySet.exists(): Added to check if any records exist.paginate(): Added to handle pagination for large result sets.Important for Developers: When adding new fields to models, they will default to NULL. It’s recommended to recreate the database schema after development is complete to ensure fields have appropriate constraints and default values.
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on GitHub.
This project is licensed under the Apache-2.0 License - see the LICENSE file for details.
FAQs
abarorm is a lightweight and easy-to-use Object-Relational Mapping (ORM) library for SQLite and PostgreSQL databases in Python. It aims to provide a simple and intuitive interface for managing database models and interactions.
We found that abarorm demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.