Spec-Zone.ru › MySQL Shell 9.2

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

Для использования раздела 11.3, «Плагины MySQL Shell» с интеграцией в командную строку, функции должны быть явно определены для поддержки CLI. Когда объект, определенный в плагине MySQL Shell, включён для интеграции в командную строку, только те конкретные функции, которые были включены, доступны для вызовов CLI. Когда вы добавляете члены функции в объект, они поддерживают опцию cli boolean. Когда 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-9.2-en/cli-support-for-shell-plugins.html

Spec-Zone.ru

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