README

element119 | 索引器部署配置

一个允许开发者通过部署配置锁定索引器模式的 Magento 2 模块。

📝 功能

✔️ 通过 app/etc/config.php 文件选择性锁定索引器模式

✔️ 索引器配置在 app:config:import 过程中验证和导入

✔️ 支持自定义索引器

✔️ 为管理员提供消息，显示通过部署配置锁定的索引器

✔️ 当管理员尝试更改通过部署配置锁定的索引器模式时通知管理员

✔️ 支持 Magento 开源和 Adobe Commerce

✔️ 支持 Hyvä 和 Luma 主题

✔️ 与 Magento 无缝集成

✔️ 考虑到开发者和可扩展性，尽可能简化自定义

✔️ 可通过 Composer 安装

🔌 安装

运行以下命令来 安装 此模块

composer require element119/module-indexer-deploy-config
php bin/magento setup:upgrade

⏫ 更新

运行以下命令来 更新 此模块

composer update element119/module-indexer-deploy-config
php bin/magento setup:upgrade

❌ 卸载

运行以下命令来 卸载 此模块

composer remove element119/module-indexer-deploy-config
php bin/magento setup:upgrade

📚 用户指南

锁定索引器模式

1. 在 app/etc/config.php 文件中添加一个新的 indexers 数组
2. 根据需要将 realtime 或 schedule 数组添加到 indexers 数组中
3. 在相应的模式数组中指定您希望锁定到特定模式的索引器 ID

示例

'indexers' => [
    'realtime' => [
        'catalogrule_rule',
        'design_config_grid',
    ],
    'schedule' => [
        'catalog_category_product',
        'catalog_product_category',
        'catalog_product_attribute',
        'catalog_product_price',
    ],
],

注意

在不希望将任何索引器锁定到该模式的情况下，可以省略空索引器模式数组。

索引器模式锁定 Cron 备用

一个新的系统配置选项允许您启用一个 cron 作业，以确保索引器处于部署配置中应处的模式。此选项可在 商店 -> 配置 -> 高级 -> 系统 -> 索引器模式锁定 中找到。

indexer:lock-all 命令

模块添加了一个新的 indexer:lock-all 命令，您可以使用它通过命令行锁定索引器模式。

Description:
  Lock all indexers

Usage:
  indexer:lock-all [options]

Options:
  -m, --mode=MODE       Passing one of two modes (schedule, realtime) will lock all indexers to that mode.
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

注意

在部署配置中设置、取消设置或更改索引器模式后，您需要运行 app:config:import。

由于这个新命令会写入部署配置文件，并且此模块会对 部署配置池添加，任何自动化部署管道都需要通过传递 -n 或 --no-interaction 作为命令选项来运行 app:config:import，以避免 通常的提示。

不传递任何参数将锁定索引器模式到当前状态。

传递 -m realtime 作为参数将所有索引器设置为 保存时更新。

传递 -m schedule 作为参数将所有索引器设置为 按计划更新。

受限制的管理员控制