spatie/laravel-query-builder
Laravel Query Builder
本项目是一个用于 Laravel 应用程序的 Eloquent 查询构建器封装器和 REST API 查询解析器。它将 HTTP 请求参数转换为数据库查询，为 API 端点提供动态过滤、排序和关系加载。
该系统通过基于别名的模式抽象将外部 API 接口与存储层解耦，允许公共字段名映射到私有数据库列。它支持嵌套关系的动态包含和聚合计数，以及通过可调用类和闭包为过滤器和排序执行自定义程序逻辑。
功能覆盖面包括通过字段选择进行数据投影，以及基于请求参数的结果排序。它进一步提供了使用点符号进行基于关系的过滤的机制，与本地模型作用域的集成，以及对软删除记录可见性的控制。
Features
- Eloquent Query Wrappers - Translates HTTP request parameters into complex database queries using the Eloquent ORM for Laravel applications.
- Query Parameter Filters - Translates URL query parameters into database filters supporting partial matches, exact matches, and logical groupings.
- Query Parameter Filters - Translates request parameters into complex database filters using AND/OR logical conjunctions.
- Dataset Filtering and Search - Provides mechanisms for end users to refine and search through large datasets using dynamic filters and logical groupings.
- Dynamic Relationship Loading - Loads specified relationships and nested relations based on parameters passed in the request.
- Dot-Notation Join Paths - Parses nested relationship identifiers using dot-notation to generate database JOIN clauses and filters.
- Field Selection - Limits the columns returned by a database query based on parameters specified in the request URL.
- Model Scope Integration - Maps URL filter parameters directly to local Eloquent model scopes.
- Association-Based Filters - Provides mechanisms to filter records based on attributes of their associated relationships using dot-notation.
- Eager Loading - Dynamically injects eager loading constraints into the query builder based on requested relation identifiers.
- Query Sorting - Orders query results based on request parameters, supporting multiple columns, directions, and fallbacks.
- Dynamic Relation Loaders - Dynamically includes nested database relationships and aggregate counts based on API request parameters.
- Dynamic Relationship Loading - Allows API clients to specify which nested relationships and aggregate counts should be included in the response.
- Query Builders - Translates HTTP request parameters into Eloquent database queries for API filtering, sorting, and including.
- Model Scoping - Triggers local Eloquent model scopes by mapping request parameters to predefined model-level query methods.
- Request-to-Query Predicate Mapping - Translates HTTP request parameters directly into database query predicates for dynamic filtering.
- Schema Abstraction Layers - Maps public API field names to private database column names to decouple the external interface from storage.
- API Query Filtering - Maps URL query strings to database constraints to provide dynamic data filtering for API endpoints.
- REST API Query Parsers - Builds API endpoints that allow clients to filter, sort, and include related data directly via URL query parameters.
- Field Aliasing - Hides internal database column names from API consumers by mapping request parameters to specific table fields.
- Custom Relationship Loaders - Supports executing custom closures or classes to modify the query builder when specific relationships are requested.
- Sort Field Aliasing - Maps request parameters to internal database columns to hide the underlying schema from API consumers.
- Relationship Count Aggregators - Attaches relationship counts and aggregate values from associated models to the primary result set.
- Soft-Delete Query Overrides - Allows API requests to override default soft-delete filters to include or exclude trashed records.
- Invokable Sorting Classes - Delegates complex ordering requirements to dedicated classes that manually modify the query builder's order clauses.
- Custom Sorting Logic - Implements arbitrary sorting logic via invokable classes for requirements like string length or raw SQL expressions.
- Closure-Based Query Constraints - Applies custom database constraints by executing registered closures when specific filter keys are detected.
- Complex Query Filtering Logic - Enables the execution of custom programmatic logic to apply complex constraints to the database query builder.
- Query Filtering Integrations - Implements advanced search and sorting logic within Laravel applications using declarative request-based rules.
