goldfinch / eagerloading
为 SilverStripe 4 实现预加载
v0.6.2
2024-03-18 10:32 UTC
Requires
- silverstripe/framework: ^4.9
Requires (Dev)
- phpunit/phpunit: ^9.5
- silverstripe/admin: ^1.6
- tractorcow/silverstripe-proxy-db: ^1.0
This package is auto-updated.
Last update: 2024-09-18 11:27:36 UTC
README
尝试解决 SilverStripe 4 中的 N+1 问题N+1 问题。
使用方法
MyModelClass::get()->with(['Relation1','Relation2'])->filter(...);
它不需要大量的配置 - 只需将一个函数添加到查询构建器链中::->with([..relations...])
。这将导致最终由EagerLoadedDataList
类呈现的数据列表,该类负责预加载。
模块利用DataList::getGenerator()
在需要时查询并附加相关记录。
安装
composer require goldfinch/eagerloading
每个希望预加载 has_one/many_many/belongs_many_many 的 DataObject 都必须包含 EagerLoaderMultiAccessor
(见下文)。
功能
- 与 $has_one / $belongs_to 一起使用
- 与 $has_many / $many_many / $belongs_many_many 一起使用
- 增强 GridField 输出
- 增强 CSV 导出
阅读文档以获取完整说明。
快速入门
1. 将以下特质添加到所有模型中以使用 $has_many
,$many_many
,$belongs_meny_many
class MyClass extends DataObject { use Gurucomkz\EagerLoading\EagerLoaderMultiAccessor; // ... }
如果您有自己的 __call()
,请参阅使用 $has_many/$many_many。
2. 声明 private static $eager_loading
以增强 ModelAdmin 的 GridField 输出。
class YourClass extends DataObject { private static $eager_loading = [ 'Relation1', 'Relation1.Relation4', 'Relation2', 'Relation3', ]; }
待办事项
- 对于
->with(['RelLevel1.RelLevel2'])
- 不要对RelLevel1
ID 进行两次查询。 - 对于
->with(['RelLevel1','RelLevel1.RelLevel2'])
- 不要对RelLevel1
ID 进行三次查询。
报告问题
请创建一个问题,以报告您找到的任何错误或缺少的功能。