MySQL Shell 9.0  /  自定义 MySQL Shell  /  使用启动脚本

13.1 使用启动脚本

当 MySQL Shell 在 JavaScript 或 Python 模式下启动时,以及当您首次切换到 JavaScript 或 Python 模式时,MySQL Shell 会搜索要执行的启动脚本。启动脚本是特定于 JavaScript 或 Python 的脚本,其中包含 MySQL Shell 首次进入相应语言模式时要执行的指令。启动脚本允许您通过以下任何方式自定义 JavaScript 或 Python 代码执行环境

  • 为 Python 或 JavaScript 模块添加其他搜索路径。

  • 定义全局函数或变量。

  • 通过 JavaScript 或 Python 执行任何其他可能的初始化。

当您在 JavaScript 或 Python 模式下启动或重新启动 MySQL Shell 时,以及在 MySQL Shell 运行时首次切换到这两种模式中的另一种时,将加载相关的启动脚本。此后,MySQL Shell 不会再次搜索启动脚本,因此如果您已经进入相关模式,则实现对启动脚本的更新需要重新启动 MySQL Shell。当 MySQL Shell 在 SQL 模式下启动或您切换到该模式时,不会加载启动脚本。

启动脚本是可选的,如果您想使用它们进行自定义,您可以创建它们。启动脚本必须按如下方式命名

  • 对于 JavaScript 模式:mysqlshrc.js

  • 对于 Python 模式:mysqlshrc.py

您可以将启动脚本放在以下列出的任何位置。MySQL Shell 会按照列出的顺序搜索所有指定路径中文件名 mysqlshrc 且文件扩展名与正在初始化的脚本模式匹配的启动脚本(如果 MySQL Shell 在未指定语言模式的情况下启动,则默认为 .js)。请注意,MySQL Shell 会按照找到的顺序执行所有适用于该脚本模式的启动脚本。如果在两个不同的启动脚本中定义了相同的内容,则以后执行的脚本优先。

  1. 在平台的标准全局配置路径中。

    • 在 Windows 上:%PROGRAMDATA%\MySQL\mysqlsh\mysqlshrc.[js|py]

    • 在 Unix 上:/etc/mysql/mysqlsh/mysqlshrc.[js|py]

  2. 在 MySQL Shell 主文件夹的 share/mysqlsh 子目录中,该目录可以通过环境变量 MYSQLSH_HOME 定义,也可以由 MySQL Shell 识别。如果未定义 MYSQLSH_HOME,MySQL Shell 会将其自己的主文件夹标识为名为 bin 的文件夹的父文件夹,该文件夹包含 mysqlsh 二进制文件(如果存在此类文件夹)。(因此,对于许多标准安装,无需定义 MYSQLSH_HOME。)

    • 在 Windows 上:%MYSQLSH_HOME%\share\mysqlsh\mysqlshrc.[js|py]

    • 在 Unix 上:$MYSQLSH_HOME/share/mysqlsh/mysqlshrc.[js|py]

  3. 在包含 mysqlsh 二进制文件的文件夹中,但前提是选项 2 中描述的 MySQL Shell 主文件夹既未指定也未由 MySQL Shell 在预期的标准位置识别。

    • 在 Windows 上:<mysqlsh 二进制文件路径>\mysqlshrc.[js|py]

    • 在 Unix 上:<mysqlsh 二进制文件路径>/mysqlshrc.[js|py]

  4. 在 MySQL Shell 用户配置路径中,由环境变量 MYSQLSH_USER_CONFIG_HOME 定义。

    • 在 Windows 上:%MYSQLSH_USER_CONFIG_HOME%\mysqlshrc.[js|py]

    • 在 Unix 上:$MYSQLSH_USER_CONFIG_HOME/mysqlshrc.[js|py]

  5. 在平台的标准用户配置路径中,但前提是未指定选项 4 中描述的 MySQL Shell 用户配置路径。

    • 在 Windows 上:%APPDATA%\MySQL\mysqlsh\mysqlshrc.[js|py]

    • 在 Unix 上:$HOME/.mysqlsh/mysqlshrc.[js|py]