wowsql 1.2.0
wowsql: ^1.2.0 copied to clipboard
Official Flutter/Dart SDK for WowSQL - MySQL Backend-as-a-Service with S3 Storage support, type-safe queries and fluent API
Changelog #
All notable changes to the WOWSQL Flutter SDK will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
1.3.0 - 2025-11-22 #
Added - Schema Management 🔧 #
- New
WOWSQLSchemaclass for programmatic database schema management - Full schema CRUD operations with service role key authentication
- Schema modification capabilities for production databases
Schema Features
- Create Tables: Define tables with columns, primary keys, and indexes
- Alter Tables: Add, modify, drop, or rename columns
- Drop Tables: Remove tables with optional CASCADE support
- Execute SQL: Run raw SQL for custom schema operations
Schema API Methods
createTable()- Create new tables with full column definitionsalterTable()- Modify existing table structuredropTable()- Drop tables safelyexecuteSQL()- Execute custom schema SQL statements
Security & Validation
- Service Role Key Required: Schema operations strictly require service role keys
- 403 Error Handling: Clear error messages when using anonymous keys
- Permission Validation: Automatic validation of API key permissions
Dart Classes
ColumnDefinition- Column specification with constraints- Complete type definitions for all schema operations
Examples & Documentation
- Backend migration script examples
- Schema management best practices
- Security guidelines for service key usage
- Comprehensive README section with code examples
Updated #
- README with comprehensive schema management documentation
- Exports to include schema classes
- Version bumped to 1.3.0
1.2.0 - 2025-11-11 #
Added - API Keys Documentation #
- Comprehensive API keys documentation section in README
- Clear separation between Database Operations keys and Authentication Operations keys
- Documentation for Service Role Key, Public API Key, and Anonymous Key
- Usage examples for each key type
- Security best practices guide
- Troubleshooting section for common key-related errors
Updated #
- Enhanced
WOWSQLClientclass documentation to clarify it's for DATABASE OPERATIONS - Enhanced
ProjectAuthClientclass documentation to clarify it's for AUTHENTICATION OPERATIONS - Version bumped to 1.2.0
Documentation #
- README now includes comprehensive API keys section with:
- Key types overview table
- Where to find keys in dashboard
- Database operations examples
- Authentication operations examples
- Environment variables best practices
- Security best practices
- Troubleshooting guide
1.0.0 - 2025-10-17 #
Added - Initial Release 🎉 #
Database Client
- Full CRUD operations - Create, Read, Update, Delete
- Fluent query builder - Chainable API for intuitive queries
- Advanced filtering - eq, neq, gt, gte, lt, lte, like, isNull
- Pagination - limit and offset support
- Sorting - orderBy with asc/desc directions
- Raw SQL queries - Execute custom SQL
- Table introspection - List tables and get schema information
- Health check - Check API status
- Type-safe - Strong typing throughout
- Async/await - Modern Dart async support
Storage Client
- S3-compatible storage - Full file management
- File upload - Upload files with automatic quota validation
- File download - Get presigned URLs for downloads
- File listing - List files with optional prefix filtering
- File deletion - Delete single or multiple files
- Quota management - Check storage usage and limits
- File info - Get detailed file metadata
- Multi-region - Support for different S3 regions
- Client-side validation - Prevent uploads exceeding quota
Error Handling
WOWSQLException- Base exception for database errorsAuthenticationException- Authentication errors (401/403)NotFoundException- Not found errors (404)RateLimitException- Rate limit errors (429)NetworkException- Network connectivity errorsStorageException- Base exception for storage errorsStorageLimitExceededException- Storage quota exceeded (413)
Models
QueryResponse<T>- Generic query response with data and countCreateResponse- Response from insert operationsUpdateResponse- Response from update operationsDeleteResponse- Response from delete operationsTableSchema- Table schema informationColumnInfo- Column metadataStorageQuota- Storage quota informationStorageFile- File metadataFileUploadResult- Upload operation result
Features
- 🚀 Zero configuration required
- 🔒 Secure API key authentication
- ⚡ Fast and efficient
- 📱 Flutter and Dart compatible
- 🛡️ Comprehensive error handling
- 📝 Full documentation and examples
- ✅ Production ready
Documentation #
- Complete README with usage examples
- API reference documentation
- Flutter integration examples
- Error handling guide
- Publishing guide for pub.dev
Future Roadmap #
Planned Features (v1.1.0) #
- ❌ Batch operations for database
- ❌ Transaction support
- ❌ Query caching
- ❌ Retry logic with exponential backoff
- ❌ Streaming uploads for large files
- ❌ File versioning support
- ❌ Aggregation functions (COUNT, SUM, AVG)
- ❌ Join queries support
Under Consideration #
- ❌ Real-time subscriptions (WebSocket)
- ❌ Offline support with sync
- ❌ Query builder UI widgets
- ❌ Code generation for models
- ❌ Migration tools
- ❌ GraphQL-like nested queries
Contributing #
We welcome contributions! Please see CONTRIBUTING.md for details.
Support #
- 📧 Email: support@wowsql.com
- 💬 Discord: Join our community
- 📚 Documentation: https://wowsql.com/docs
- 🐛 Issues: GitHub Issues
For more information, visit https://wowsql.com