-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Adds `es task` cli commands. * Adds `es index` `move` and `info` commands. Co-Authored-by: Peter Weber <peter.weber@rero.ch>
- Loading branch information
Showing
4 changed files
with
259 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # | ||
| # RERO Invenio Base | ||
| # Copyright (C) 2023 RERO. | ||
| # | ||
| # This program is free software: you can redistribute it and/or modify | ||
| # it under the terms of the GNU Affero General Public License as published by | ||
| # the Free Software Foundation, version 3 of the License. | ||
| # | ||
| # This program is distributed in the hope that it will be useful, | ||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| # GNU Affero General Public License for more details. | ||
| # | ||
| # You should have received a copy of the GNU Affero General Public License | ||
| # along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| """Click elasticsearch tasks command-line utilities.""" | ||
| import sys | ||
| from pprint import pformat | ||
| from time import sleep | ||
|
|
||
| import click | ||
| from invenio_search import current_search_client | ||
| from invenio_search.cli import es_version_check, with_appcontext | ||
|
|
||
|
|
||
| def abort_if_false(ctx, param, value): | ||
| """Abort command is value is False.""" | ||
| if not value: | ||
| ctx.abort() | ||
|
|
||
|
|
||
| @click.group() | ||
| def task(): | ||
| """Elasticsearch task commands. | ||
| See: https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html # noqa | ||
| """ | ||
|
|
||
|
|
||
| @task.command('get') | ||
| @with_appcontext | ||
| @es_version_check | ||
| @click.argument('task') | ||
| def task_get(task): | ||
| """Get task info. | ||
| :param task: task id. | ||
| """ | ||
| try: | ||
| res = current_search_client.tasks.get(task) | ||
| if info := res.get("response"): | ||
| click.secho(f'{pformat(info)}', fg='green') | ||
| elif info := res.get('task'): | ||
| click.secho(f'{info.get("description")}', fg='yellow') | ||
| click.secho(f'{pformat(info.get("status"))}', fg='yellow') | ||
| else: | ||
| click.secho(f'{pformat(res)}', fg='blue') | ||
| except Exception as err: | ||
| click.secho(f'Error: {err}', fg='red') | ||
| sys.exit(1) | ||
| sys.exit(0) | ||
|
|
||
|
|
||
| @task.command('list') | ||
| @with_appcontext | ||
| @es_version_check | ||
| def task_list(): | ||
| """Get task list.""" | ||
| res = current_search_client.tasks.list() | ||
| click.secho(f'{pformat(res)}', fg='green') | ||
|
|
||
|
|
||
| @task.command('cancel') | ||
| @with_appcontext | ||
| @click.option('--yes-i-know', is_flag=True, callback=abort_if_false, | ||
| expose_value=False, | ||
| prompt='Do you really want to cancel the task?') | ||
| @click.argument('task') | ||
| @es_version_check | ||
| def task_cancel(task): | ||
| """Cancel task. | ||
| :param task: task id. | ||
| """ | ||
| try: | ||
| res = current_search_client.tasks.cancel(task) | ||
| click.secho(f'{pformat(res)}', fg='yellow') | ||
| except Exception as err: | ||
| click.secho(f'Error: {err}', fg='red') | ||
| sys.exit(1) | ||
| sys.exit(0) | ||
|
|
||
|
|
||
| @task.command('watch') | ||
| @with_appcontext | ||
| @es_version_check | ||
| @click.argument('task') | ||
| @click.option('-n', '--interval', default=1, type=int, | ||
| help='seconds to wait between updates') | ||
| def task_watch(task, interval): | ||
| """Watch task info. | ||
| :param task: task id. | ||
| """ | ||
| click.secho(f'Watching task: {task}', fg='green') | ||
| try: | ||
| seconds = 0 | ||
| res = current_search_client.tasks.get(task) | ||
| while not res.get('completed'): | ||
| if info := res.get('task'): | ||
| click.secho( | ||
| f'Watching task: {task} {seconds} seconds ...', | ||
| fg='green' | ||
| ) | ||
| click.secho(f'{info.get("description")}', fg='yellow') | ||
| click.secho(f'{pformat(info.get("status"))}', fg='yellow') | ||
| sleep(interval) | ||
| seconds += interval | ||
| res = current_search_client.tasks.get(task) | ||
|
|
||
| click.secho(f'Finished task: {task} {seconds} seconds ...', fg='green') | ||
| click.secho(f'{pformat(res.get("response"))}', fg='green') | ||
| except Exception as err: | ||
| click.secho(f'Error: {err}', fg='red') | ||
| sys.exit(1) | ||
| sys.exit(0) |