From 1bb13a5eca544c6050644bc6603de6160c71dac8 Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Mon, 12 Feb 2024 10:31:22 -0500 Subject: [PATCH 1/2] Document new sync:reindex CLI command --- docs/cli/built-in-commands/sync-reindex.md | 22 ++++++++++++++++++++++ docs/cli/intro.md | 3 ++- 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/cli/built-in-commands/sync-reindex.md diff --git a/docs/cli/built-in-commands/sync-reindex.md b/docs/cli/built-in-commands/sync-reindex.md new file mode 100644 index 00000000..2ba67fa2 --- /dev/null +++ b/docs/cli/built-in-commands/sync-reindex.md @@ -0,0 +1,22 @@ +# `sync:reindex` + +The searchable content in your site may become stale after changing properties of some fields. Running the `sync:reindex` command will ensure fresh data is used by complex fields in the Entry Manager and search contexts. + +## Options list: + +``` + --site_id= + -s + Site ID. Skip this parameter to re-index content on all sites +``` + +## Examples: + +### Re-index content for all sites + +`php eecli.php sync:reindex` + +### Re-index content for Site ID 1 only + +`php eecli.php sync:reindex --site_id=1` +`php eecli.php sync:reindex -s 1` \ No newline at end of file diff --git a/docs/cli/intro.md b/docs/cli/intro.md index 0360580a..1e601dca 100644 --- a/docs/cli/intro.md +++ b/docs/cli/intro.md @@ -2,7 +2,7 @@ The Command Line Interface (CLI) allows a user to run system and user-generated commands in the terminal. The CLI has access to all of the ExpressionEngine resources, and can be used to update the system, clear caches, and much more. -By default the CLI is located `system/ee/eecli.php` . +By default the CLI is located `system/ee/eecli.php` . ![EE CLI](_images/6-1_cli.png) @@ -29,6 +29,7 @@ By default the CLI is located `system/ee/eecli.php` . - [migrate:rollback - Rolls back most recent migration group](cli/built-in-commands/migrate.md) - Sync - [sync:conditional-fields - Sync channel entry conditional logic](cli/built-in-commands/sync-conditional-fields.md) + - [sync:reindex](cli/built-in-commands/sync-reindex.md) - [Update ExpressionEngine](cli/built-in-commands/update.md) - [Creating a Command](cli/creating-a-command.md) - [Defining Input](cli/defining-input.md) From 3f85b9692072b7bc92519014766b58d22b593510 Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Mon, 12 Feb 2024 10:47:21 -0500 Subject: [PATCH 2/2] Add intro description --- docs/cli/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli/intro.md b/docs/cli/intro.md index 1e601dca..bc520e5e 100644 --- a/docs/cli/intro.md +++ b/docs/cli/intro.md @@ -29,7 +29,7 @@ By default the CLI is located `system/ee/eecli.php` . - [migrate:rollback - Rolls back most recent migration group](cli/built-in-commands/migrate.md) - Sync - [sync:conditional-fields - Sync channel entry conditional logic](cli/built-in-commands/sync-conditional-fields.md) - - [sync:reindex](cli/built-in-commands/sync-reindex.md) + - [sync:reindex - Sync content used in search indexes](cli/built-in-commands/sync-reindex.md) - [Update ExpressionEngine](cli/built-in-commands/update.md) - [Creating a Command](cli/creating-a-command.md) - [Defining Input](cli/defining-input.md)