Bug 40964

Summary: koha-elasticsearch is missing --where option
Product: Koha Reporter: Thomas Klausner <domm>
Component: Command-line UtilitiesAssignee: Thomas Klausner <domm>
Status: Pushed to main --- QA Contact: Jonathan Druart <jonathan.druart>
Severity: enhancement    
Priority: P5 - low CC: anke.bruns, clemens.tubach, i.tortorella, jonathan.druart, lucas, lukasz.koszyk, michaela.sieber, robin
Version: Main   
Hardware: All   
OS: All   
GIT URL: Initiative type: ---
Sponsorship status: Sponsored Comma delimited list of Sponsors:
Crowdfunding goal: 0 Patch complexity: Trivial patch
Documentation contact: Documentation submission:
Text to go in the release notes:
Version(s) released in:
25.11.00
Circulation function:
Bug Depends on: 35345    
Bug Blocks:    
Attachments: Bug 40964: add --where to koha-elasticsearch wrapper scripts and document it
Bug 40964: add --where to koha-elasticsearch wrapper scripts and document it
Bug 40964: add --where to koha-elasticsearch wrapper scripts and document it
bug 40964: Add long version of options to man
Bug 40964: Add long version of options to man

Description Thomas Klausner 2025-10-07 13:55:09 UTC
misc/search_tools/rebuild_elasticsearch.pl has an option --where to pass arbitrary SQL to select which records to index.

The koha-elasticsearch wrapper script is missing this option.

Add it!
Comment 1 Thomas Klausner 2025-10-07 14:47:02 UTC
Created attachment 187530 [details] [review]
Bug 40964: add --where to koha-elasticsearch wrapper scripts and document it

Test Plan:

* Start and enter ktd
* run koha-elasticsearch with --where, which has no effect:
  debian/scripts/koha-elasticsearch --rebuild -b -v --where 'biblionumber > 427'  kohadev
* But you will see some warnings like:
  Unknown instance --where
  Unknown instance biblionumber > 427
* Final output is: Total 435 records indexed

Apply the patch

* run the same command again:
  debian/scripts/koha-elasticsearch --rebuild -b -v --where 'biblionumber > 427'  kohadev
* output should be
 Checking state of biblios index
 Indexing biblios
 Committing final records...
 Total 11 records indexed

* Run `debian/scripts/koha-elasticsearch --help`
* "-w|--where" should show up in the docs

Sponsored-by: HKS3
Sponsored-by: Koha DACH Hackfest
Comment 2 Anke Bruns 2025-10-08 11:05:02 UTC
Created attachment 187555 [details] [review]
Bug 40964: add --where to koha-elasticsearch wrapper scripts and document it

Test Plan:

* Start and enter ktd
* run koha-elasticsearch with --where, which has no effect:
  debian/scripts/koha-elasticsearch --rebuild -b -v --where 'biblionumber > 427'  kohadev
* But you will see some warnings like:
  Unknown instance --where
  Unknown instance biblionumber > 427
* Final output is: Total 435 records indexed

Apply the patch

* run the same command again:
  debian/scripts/koha-elasticsearch --rebuild -b -v --where 'biblionumber > 427'  kohadev
* output should be
 Checking state of biblios index
 Indexing biblios
 Committing final records...
 Total 11 records indexed

* Run `debian/scripts/koha-elasticsearch --help`
* "-w|--where" should show up in the docs

Sponsored-by: HKS3
Sponsored-by: Koha DACH Hackfest
Signed-off-by: John Doe <you@example.com>
Signed-off-by: Anke Bruns <anke.bruns@gwdg.de>
Comment 3 Thomas Klausner 2025-10-13 12:48:49 UTC
see also #35345 (the actual implementation in rebuild_elasticsearch.pl)
Comment 4 Jonathan Druart 2025-10-23 13:58:38 UTC
Created attachment 188361 [details] [review]
Bug 40964: add --where to koha-elasticsearch wrapper scripts and document it

Test Plan:

* Start and enter ktd
* run koha-elasticsearch with --where, which has no effect:
  debian/scripts/koha-elasticsearch --rebuild -b -v --where 'biblionumber > 427'  kohadev
* But you will see some warnings like:
  Unknown instance --where
  Unknown instance biblionumber > 427
* Final output is: Total 435 records indexed

Apply the patch

* run the same command again:
  debian/scripts/koha-elasticsearch --rebuild -b -v --where 'biblionumber > 427'  kohadev
* output should be
 Checking state of biblios index
 Indexing biblios
 Committing final records...
 Total 11 records indexed

* Run `debian/scripts/koha-elasticsearch --help`
* "-w|--where" should show up in the docs

Sponsored-by: HKS3
Sponsored-by: Koha DACH Hackfest
Signed-off-by: Anke Bruns <anke.bruns@gwdg.de>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Comment 5 Jonathan Druart 2025-10-23 13:58:40 UTC
Created attachment 188362 [details] [review]
bug 40964: Add long version of options to man

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Comment 6 Jonathan Druart 2025-10-23 13:59:09 UTC
Removed John Doe's signed-off-by line.
Comment 7 Lucas Gass (lukeg) 2025-11-03 20:16:47 UTC
Please fix this commit message: 

bug 40964: Add long version of options to man


* Commit title does not start with 'Bug XXXXX: ' - 7031c83280b
Comment 8 Jonathan Druart 2025-11-04 08:06:54 UTC
Created attachment 189001 [details] [review]
Bug 40964: Add long version of options to man

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Comment 9 Lucas Gass (lukeg) 2025-11-07 17:56:10 UTC
Nice work everyone!

Pushed to main for 25.11