A powerful and flexible SQL query builder for Dart, focusing on MySQL & SQLite3 support with a fluent interface design.
- Fluent Interface: Build SQL queries using method chaining for better readability
- Type-Safe: Construct queries with compile-time safety
- Comprehensive Support: SELECT, INSERT, UPDATE, DELETE operations
- Advanced Clauses: WHERE, JOIN, GROUP BY, HAVING, ORDER BY, LIMIT
- Parameterized Queries: Support for named parameters to prevent SQL injection
- Proper Escaping: Automatic field quoting and value escaping
- Complex Operations: Subqueries, CASE statements, aggregate functions
- MySQL Optimized: Specifically designed for MySQL syntax and features
- SQLite Optimized: Specifically designed for SQLite syntax and features
Add this to your package's pubspec.yaml file:
dependencies:
sqler: Or
dart pub add sqlerThen run:
dart pub getimport 'package:sqler/sqler.dart';
void main() {
// Create Table
var books = MTable(
name: 'books',
fields: [
MFieldInt(name: 'id', isPrimaryKey: true, isAutoIncrement: true),
MFieldVarchar(name: 'name', length: 255),
MFieldVarchar(name: 'author', length: 255),
MFieldInt(name: 'publication_year'),
MFieldDate(name: 'published_date'),
MFieldText(name: 'content'),
],
);
// Simple SELECT query
var query = Sqler()
.addSelect(QSelect('name'))
.addSelect(QSelect('published_date'))
.from(QField('books'))
.where(WhereOne(QField('publication_year'), QO.EQ, QVar(1980)))
.orderBy(QOrder('name'))
.limit(10);
print(query.toSQL());
/// Print for SQLite:
print(query.toSQL<Sqlite>());
}To generate a SQL query specifically in SQLite format, pass Sqlite as a type parameter to the toSQL function:
query.toSQL<Sqlite>()This ensures that the SQL syntax produced is compatible with SQLite.
The main query builder class that provides a fluent interface for constructing SQL queries.
Represents database fields with proper quoting:
QField('users.name') // users.`name`
QField('table_name') // `table_name`Represents values with proper escaping:
QVar('string value') // 'string value'
QVar(123) // 123
QVar(true) // true
QVar(null) // NULLRepresents SELECT fields with optional aliases:
QSelect('name') // `name`
QSelect('users.name', 'user_name') // users.`name` AS `user_name`var query = Sqler()
.addSelect(QSelect('id'))
.addSelect(QSelect('name'))
.addSelect(QSelect('email'))
.from(QField('users'));
print(query.toSQL());
// SELECT `id`, `name`, `email` FROM `users`var query = Sqler()
.addSelect(QSelect('*'))
.from(QField('users'))
.where(AndWhere([
WhereOne(QField('active'), QO.EQ, QVar(true)),
WhereOne(QField('age'), QO.GT, QVar(18))
]));
print(query.toSQL());
// SELECT * FROM `users` WHERE ( ( `active` = true ) ) AND ( ( `age` > 18 ) )var query = Sqler()
.addSelect(QSelect('users.name'))
.addSelect(QSelect('profiles.bio'))
.from(QField('users'))
.join(LeftJoin('profiles', On([
Condition(QField('users.id'), QO.EQ, QField('profiles.user_id'))
])))
.where(WhereOne(QField('users.active'), QO.EQ, QVar(true)));
print(query.toSQL());
// SELECT `users`.`name`, `profiles`.`bio` FROM `users`
// LEFT JOIN `profiles` ON ( ( `users`.`id` = `profiles`.`user_id` ) )
// WHERE ( `users`.`active` = true )// Single record insert
var query = Sqler()
.insert(QField('users'), [
{
'name': QVar('John Doe'),
'email': QVar('[email protected]'),
'active': QVar(true),
'age': QVar(30)
}
]);
print(query.toSQL());
// INSERT INTO `users` (`name`, `email`, `active`, `age`)
// VALUES ('John Doe', '[email protected]', true, 30)// Multiple records insert
var query = Sqler()
.insert(QField('users'), [
{
'name': QVar('John Doe'),
'email': QVar('[email protected]')
},
{
'name': QVar('Jane Smith'),
'email': QVar('[email protected]')
}
]);
print(query.toSQL());
// INSERT INTO `users` (`name`, `email`)
// VALUES ('John Doe', '[email protected]'), ('Jane Smith', '[email protected]')var query = Sqler()
.update(QField('users'), {
'name': QVar('Updated Name'),
'email': QVar('[email protected]')
})
.where(WhereOne(QField('id'), QO.EQ, QVar(1)));
print(query.toSQL());
// UPDATE `users` SET `name` = 'Updated Name', `email` = '[email protected]'
// WHERE ( `id` = 1 )var query = Sqler()
.delete()
.from(QField('users'))
.where(WhereOne(QField('active'), QO.EQ, QVar(false)));
print(query.toSQL());
// DELETE FROM `users` WHERE ( `active` = false )var query = Sqler()
.addSelect(QSelect('department'))
.addSelect(QSelectFunc('COUNT', [QField('id')], 'employee_count'))
.from(QField('employees'))
.where(WhereOne(QField('active'), QO.EQ, QVar(true)))
.groupBy(QField('department'))
.having(HavingOne(QSelectFunc('COUNT', [QField('id')]), QO.GT, QVar(5)))
.orderBy(QOrder('employee_count', OrderDirection.DESC));
print(query.toSQL());
// SELECT `department`, COUNT(`id`) AS `employee_count` FROM `employees`
// WHERE ( `active` = true ) GROUP BY `department`
// HAVING ( COUNT(`id`) > 5 ) ORDER BY `employee_count` DESCvar query = Sqler()
.addSelect(QSelect('*'))
.from(QField('users'))
.where(WhereOne(QField('name'), QO.EQ, QParam('user_name')))
.param('user_name', QVar('John Doe'));
print(query.toSQL());
// SELECT * FROM `users` WHERE ( `name` = :user_name )
var params = query.getParams();
// {'user_name': QVar('John Doe')}The QO class provides various comparison operators:
QO.EQ- Equal (=)QO.NE- Not Equal (!=)QO.GT- Greater Than (>)QO.GTE- Greater Than or Equal (>=)QO.LT- Less Than (<)QO.LTE- Less Than or Equal (<=)QO.LIKE- LIKE pattern matchingQO.NOT_LIKE- NOT LIKE pattern matchingQO.IN- IN listQO.NOT_IN- NOT IN listQO.IS_NULL- IS NULLQO.IS_NOT_NULL- IS NOT NULL
WhereOne(QField('status'), QO.EQ, QVar('active'))AndWhere([
WhereOne(QField('active'), QO.EQ, QVar(true)),
WhereOne(QField('age'), QO.GTE, QVar(18))
])
OrWhere([
WhereOne(QField('role'), QO.EQ, QVar('admin')),
WhereOne(QField('role'), QO.EQ, QVar('moderator'))
])InnerJoin- INNER JOINLeftJoin- LEFT JOINRightJoin- RIGHT JOIN
.join(InnerJoin('table2', On([
Condition(QField('table1.id'), QO.EQ, QField('table2.table1_id'))
])))Sqler is currently in beta! We're excited to share this powerful SQL query builder with the Dart community, and we'd love your help to make it even better.
This beta release means we're actively looking for feedback and contributions from developers like you! Here are some ways you can get involved:
- 🐛 Bug Reports: Found something that doesn't work as expected? Please open an issue!
- 📝 Documentation: Help us improve our documentation, examples, and guides
- 💡 Feature Requests: Have ideas for new features? We'd love to hear them!
- 🔧 Code Contributions: Submit pull requests to help improve the codebase
- 🧪 Testing: Use Sqler in your projects and share your experience
Since we use stars and ratings as our main metric to gauge community interest and guide our development priorities, we'd really appreciate it if you could:
- ⭐ Star us on GitHub: Help others discover Sqler!
- 👍 Like this package: Your support motivates us to keep improving
- 📢 Share with others: Tell your fellow developers about Sqler
Your feedback and contributions are invaluable in helping us build the best SQL query builder for Dart. Thank you for being part of our journey! 🙏
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
This project is licensed under the MIT License - see the LICENSE file for details.