https://github.com/timothydodd/robododd.ormlite
https://github.com/timothydodd/robododd.ormlite
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/timothydodd/robododd.ormlite
- Owner: timothydodd
- License: mit
- Created: 2025-09-04T21:26:03.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2025-09-13T20:02:15.000Z (9 months ago)
- Last Synced: 2025-09-13T20:42:24.839Z (9 months ago)
- Language: C#
- Size: 47.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RoboDodd.OrmLite
A lightweight, high-performance ORM library for .NET 9+ that provides ServiceStack OrmLite-compatible API using Dapper underneath. Offers the simplicity of Dapper with the convenience of a full-featured ORM.
## Features
- 🚀 **High Performance** - Built on Dapper for maximum speed
- 🔄 **ServiceStack OrmLite Compatible** - Drop-in replacement API
- 🗄️ **Multi-Database** - SQLite and MySQL support with automatic dialect detection
- 🧪 **Fully Tested** - 92 comprehensive tests with both SQLite and MySQL
- 💾 **Rich CRUD Operations** - Complete set of Create, Read, Update, Delete operations
- 🔍 **LINQ Support** - Expression-based queries with proper SQL generation
- 📦 **Bulk Operations** - Efficient bulk insert, update, and delete
- 🔢 **Pagination** - Built-in skip/take support for large datasets
- 🆔 **Smart Save** - Automatic insert vs update detection
- 🏷️ **Attributes** - Custom attributes for indexes, constraints, and field types
## Quick Start
### Installation
```bash
# Add the project reference
dotnet add reference path/to/RoboDodd.OrmLite/RoboDodd.OrmLite.csproj
```
### Basic Usage
```csharp
using RoboDodd.OrmLite;
using System.ComponentModel.DataAnnotations;
// Define your model
[Table("users")]
public class User
{
[Key]
public int Id { get; set; }
[Required]
public string Name { get; set; }
[Index("IX_User_Email", IsUnique = true)]
public string Email { get; set; }
public DateTime Created { get; set; }
}
// Setup connection factory
var connectionFactory = new DbConnectionFactory(connectionString);
// Use the extensions
using var connection = connectionFactory.CreateDbConnection();
await connection.OpenAsync();
// Create table
await connection.CreateTableIfNotExistsAsync();
// Basic CRUD
var user = new User { Name = "John", Email = "john@example.com", Created = DateTime.UtcNow };
// Insert
var id = await connection.InsertAsync(user, selectIdentity: true);
// Select
var users = await connection.SelectAsync();
var userById = await connection.SingleByIdAsync(id);
var userByEmail = await connection.SingleAsync(u => u.Email == "john@example.com");
// Update
user.Name = "John Doe";
await connection.UpdateAsync(user);
// Delete
await connection.DeleteAsync(user);
```
## Advanced Features
### Bulk Operations
```csharp
// Bulk insert
var users = new[] {
new User { Name = "User1", Email = "user1@example.com" },
new User { Name = "User2", Email = "user2@example.com" }
};
await connection.InsertAllAsync(users);
// Bulk update
await connection.UpdateAllAsync(users);
// Bulk delete
await connection.DeleteAllAsync(users);
```
### Count and Exists Operations
```csharp
// Count records
var totalUsers = await connection.CountAsync();
var activeUsers = await connection.CountAsync(u => u.IsActive);
// Check existence
var exists = await connection.ExistsAsync(u => u.Email == "john@example.com");
var existsById = await connection.ExistsAsync(123);
```
### Pagination
```csharp
// Get page 2 with 10 users per page
var page2 = await connection.SelectAsync(10, 10); // skip 10, take 10
// Filtered pagination
var activePage = await connection.SelectAsync(
u => u.IsActive,
skip: 20,
take: 10
);
```
### Smart Save (Upsert)
```csharp
var user = new User { Name = "John", Email = "john@example.com" };
// Will insert if new, update if exists
await connection.SaveAsync(user); // Inserts and sets the ID
user.Name = "John Updated";
await connection.SaveAsync(user); // Updates the existing record
```
### LINQ Expression Support
```csharp
// Supported string methods
var users = await connection.SelectAsync(u => u.Name.StartsWith("John"));
var users2 = await connection.SelectAsync(u => u.Email.Contains("@gmail"));
var users3 = await connection.SelectAsync(u => u.Name.EndsWith("Doe"));
// Comparison operators
var adults = await connection.SelectAsync(u => u.Age >= 18);
var recent = await connection.SelectAsync(u => u.Created > DateTime.Today);
```
## Database Support
### SQLite
```csharp
var connectionFactory = new DbConnectionFactory("Data Source=app.db;");
```
### MySQL
```csharp
var connectionFactory = new DbConnectionFactory(
"Server=localhost;Database=mydb;User=user;Password=pass;"
);
```
## Custom Attributes
### Field Customization
```csharp
public class Product
{
[CustomField("DECIMAL(10,2)")]
public decimal Price { get; set; }
[Default(typeof(DateTime), "CURRENT_TIMESTAMP")]
public DateTime Created { get; set; }
}
```
### Indexes
```csharp
[CompositeIndex("IX_User_Email_Status", nameof(Email), nameof(Status))]
public class User
{
[Index("IX_User_Email", IsUnique = true)]
public string Email { get; set; }
public UserStatus Status { get; set; }
}
```
## API Reference
### Core Operations
- `SelectAsync()` - Get all records
- `SelectAsync(predicate)` - Get filtered records
- `SingleByIdAsync(id)` - Get single record by ID
- `SingleAsync(predicate)` - Get single record by condition
- `FirstOrDefaultAsync()` - Get first record or null
- `InsertAsync(entity)` - Insert record
- `UpdateAsync(entity)` - Update record
- `DeleteAsync(entity)` - Delete record
- `SaveAsync(entity)` - Insert or update intelligently
### Bulk Operations
- `InsertAllAsync(entities)` - Bulk insert
- `UpdateAllAsync(entities)` - Bulk update
- `DeleteAllAsync(entities)` - Bulk delete
### Query Operations
- `CountAsync()` - Count all records
- `CountAsync(predicate)` - Count filtered records
- `ExistsAsync(predicate)` - Check if records exist
- `ExistsAsync(id)` - Check if record exists by ID
### Schema Operations
- `CreateTableIfNotExistsAsync()` - Create table with indexes
- `TableExistsAsync()` - Check if table exists
## Requirements
- **.NET 9.0+**
- **Dapper 2.1.66+**
- **Microsoft.Data.Sqlite 9.0.8+** (for SQLite)
- **MySql.Data 9.4.0+** (for MySQL)
## Contributing
1. Fork the repository
2. Create a feature branch
3. Add tests for new functionality
4. Ensure all tests pass
5. Submit a pull request
## License
MIT License - see LICENSE file for details.
## Changelog
### v1.0.0
- Initial release with complete CRUD operations
- SQLite and MySQL support
- LINQ expression support
- Comprehensive test suite with 92+ tests
- ServiceStack OrmLite compatible API