Spec-Zone.ru › MySQL Shell 8.4

5.8.2.5 Поддержка плагинов MySQL Shell в командной строке

Для использования Раздела 10.3, «Плагины MySQL Shell» с интеграцией в командной строке, функции должны быть явно определены для поддержки CLI. Когда объект, определенный в плагине MySQL Shell, активирован для интеграции в командной строке, только конкретные функции, которые были активированы, доступны для вызовов CLI. При добавлении членов-функций к объекту, они поддерживают опцию cli булевого типа. Когда cli установлено в значение true, функция доступна из интеграции командной строки. Опция cli по умолчанию равна false, поэтому функции недоступны из интеграции командной строки, если не активированы явно. Любой объект с функцией, у которой активирована опция cli, также делает доступными его родительские объекты в интеграции командной строки.

Чтобы сделать функцию доступной через интеграцию командной строки, установите опцию cli в значение true при добавлении члена-объекта расширения. Например:

shell.addExtensionObjectMember(object, "exampleFunction", exampleFunction,
                      {
                        brief:"Retrieves brief information",
                        details: ["Retrieves detailed information"],
                        cli: true,
                        parameters:
                        [
                          {
                            name: "param_a",
                            type: "string",
                            brief: "param_a brief"
                          }
                        ]
                      });

Тогда вы могли бы использовать функцию exampleFunction() из интеграции командной строки следующим образом:

mysqlsh -- customObj exampleFunction 1

Если вы добавили член-объект расширения, используя версию MySQL Shell, более раннюю чем 8.0.24, и хотите использовать его с интеграцией командной строки, вы должны активировать опцию cli. Используйте метод addExtensionObjectMember, как показано здесь, чтобы повторно добавить член объекта, на этот раз активировав опцию cli.

© 2025 Oracle
Licensed under the GPLv2 License.
https://docs.oracle.com/cd/E17952_01/mysql-shell-8.4-en/cli-support-for-shell-plugins.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API