MySQL Shell API 8.0.38
Unified development interface for MySQL Products
Properties | List of all members
Sys Class Reference

Gives access to system specific parameters. More...

Properties

Array path
 Lists the search paths to load the JavaScript modules. More...
 
Array argv
 Contains the list of arguments available during a script processing. More...
 

Detailed Description

Gives access to system specific parameters.

Member Data Documentation

◆ path

Array path

Lists the search paths to load the JavaScript modules.

When the shell is launched, this variable is initialized to

  • the home folder of shell + "share/mysqlsh/modules/js",
  • the folder specified in the MYSQLSH_JS_MODULE_PATH environment variable (multiple folders are allowed, separated with semicolon).

Users may change the sys.path variable at run-time.

If sys.path contains a relative path, its absolute path is resolved as a relative to the current working directory.

◆ argv

Array argv

Contains the list of arguments available during a script processing.

When the shell is used to execute a script, the arguments passed to the shell after the script name will be considered script arguments and will be available during the script execution at sys.argv which will contain:

  • The first element is the path to the script being executed.
  • Each script argument will be added as an element of the array.

For example, given the following call:

$ mysqlsh root@localhost/sakila -f test.js first second 3

The sys.argv array will contain:

  • sys.argv[0]: "test.js"
  • sys.argv[1]: "first"
  • sys.argv[2]: "second"
  • sys.argv[3]: "3"