Documentation Home
MySQL 9.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.0Mb
PDF (A4) - 40.1Mb
Man Pages (TGZ) - 259.0Kb
Man Pages (Zip) - 366.2Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


27.3.6.1 Session Object

TheSession object is always available as thesession property of the global object.Session has the methods listed here:

  • getOption(Stringname): Gets the value of statement optionname. Returns a string or a true-false value depending on the option type.

  • prepare(Stringsql, {passResultToClient: Bool,charsetName: String}): Enables the execution of a prepared statements; takes an SQL statement and returns aPreparedStatement object.

    Calling this method is equivalent to executing aPREPARE statement in themysql client.

  • quoteName(Stringname): Returnsname, after escaping it.

  • runSql(Stringquery[[, ArraystatementParameters], Optionsoptions]): Executes a query, with any options specified, and using an optional list of statement parameters; it returns anSqlResult.

  • setOptions(Objectoptions): Sets statement option defaults. Options not specified assume their default values.

  • sql(Stringsql, {passResultToClient: Bool,charsetName: String,integerType: IntegerType}): Executes a simple SQL statement. Can also be used to provide attributes overriding thepassResultlToClient andcharsetName values set in the session. Returns anSqlExecute object.

    IntegerType consists of a JSON key-value pair whose key isIntegerType, and whose possible values and their effects are listed here:

    • mysql.IntegerType.BIGINT: Convert all MySQL integer values to JavaScriptBigInt.

    • mysql.IntegerType.STRING: Convert all MySQL integer values to JavaScriptString

    • mysql.IntegerType.UNSAFE_BIGINT: If the MySQL value is safe, convert it to JavaScriptNumber; otherwise convert it to JavaScriptBigInt. If the value is safe, convert to JavaScriptNumber; otherwise convert to JavaScriptString. This is the default behavior if no rule is specified.

    • mysql.IntegerType.UNSAFE_STRING: If the MySQL value is safe, convert it to JavaScriptNumber; otherwise convert it to JavaScriptString. This is the default behavior if no rule is specified.

    The rule set by this value determines how MySQL integer values are converted to JavaScript by this SQL statement. Their names (less object references) correspond to those for the used with theinteger_type key used withmle_set_session_state(). The default behavior is equivalent to having setmysql.IntegerType.UNSAFE_STRING, or calledmle_set_session_state('{"integer_type":"STRING"}').

    This option can also be set for a given statement usingrunSQL() orprepare().