Skip to content

[WIP] Suggest enhancements for project documentation #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 11, 2025
Merged

[WIP] Suggest enhancements for project documentation #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
af9b37c
Initial plan
Copilot Oct 11, 2025
783e672
Add advanced filtering, field selection, and input validation
Copilot Oct 11, 2025
c06596b
Add bulk operations and Response helper class
Copilot Oct 11, 2025
d649a00
Add count endpoint for analytics and record counting
Copilot Oct 11, 2025
b560331
Add comprehensive ENHANCEMENTS.md documentation
Copilot Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
# Changelog

## 1.1.0 - Enhanced Query Capabilities and Bulk Operations

### New Features
- **Advanced Filter Operators**: Support for comparison operators (eq, neq, gt, gte, lt, lte, like, in, notin, null, notnull)
- **Field Selection**: Select specific fields in list queries using the `fields` parameter
- **Count Endpoint**: New `count` action to get record counts with optional filtering (no pagination overhead)
- **Bulk Operations**:
- `bulk_create` - Create multiple records in a single transaction
- `bulk_delete` - Delete multiple records by IDs in a single query
- **Input Validation**: Added comprehensive input validation for table names, column names, IDs, and query parameters
- **Response Helper**: Added Response class for standardized API responses (for future use)
- **Backward Compatibility**: Old filter format (`col:value`) still works alongside new format (`col:op:value`)

### Improvements
- Fixed SQL injection vulnerability in filter parameter by using parameterized queries with unique parameter names
- Added Validator class for centralized input validation and sanitization
- Improved error messages with proper HTTP status codes
- Enhanced documentation with detailed examples of new features
- Transaction support for bulk create operations

### Filter Operators
- `eq` - Equals
- `neq`/`ne` - Not equals
- `gt` - Greater than
- `gte`/`ge` - Greater than or equal
- `lt` - Less than
- `lte`/`le` - Less than or equal
- `like` - Pattern matching
- `in` - In list (pipe-separated values)
- `notin`/`nin` - Not in list
- `null` - Is NULL
- `notnull` - Is NOT NULL

### Examples
- Field selection: `/index.php?action=list&table=users&fields=id,name,email`
- Advanced filtering: `/index.php?action=list&table=users&filter=age:gt:18,status:eq:active`
- IN operator: `/index.php?action=list&table=orders&filter=status:in:pending|processing|shipped`
- Count records: `/index.php?action=count&table=users&filter=status:eq:active`
- Bulk create: `POST /index.php?action=bulk_create&table=users` with JSON array
- Bulk delete: `POST /index.php?action=bulk_delete&table=users` with `{"ids":[1,2,3]}`

## 1.0.0

- Initial release: automatic CRUD API generator for MySQL/MariaDB.
Expand Down
Loading