c

io.scalajs.npm.mysql

ConnectionOptions

class ConnectionOptions extends Object

Connection Options

Annotations
@RawJSType() @ScalaJSDefined()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConnectionOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConnectionOptions(host: UndefOr[String] = js.undefined, port: UndefOr[Int] = js.undefined, localAddress: UndefOr[String] = js.undefined, socketPath: UndefOr[String] = js.undefined, user: UndefOr[String] = js.undefined, password: UndefOr[String] = js.undefined, database: UndefOr[String] = js.undefined, charset: UndefOr[String] = js.undefined, timezone: UndefOr[String] = js.undefined, connectTimeout: UndefOr[Boolean] = js.undefined, stringifyObjects: UndefOr[Boolean] = js.undefined, insecureAuth: UndefOr[Boolean] = js.undefined, typeCast: UndefOr[Boolean] = js.undefined, queryFormat: UndefOr[String] = js.undefined, supportBigNumbers: UndefOr[Boolean] = js.undefined, bigNumberStrings: UndefOr[Boolean] = js.undefined, dateStrings: UndefOr[String] = js.undefined, debug: UndefOr[Boolean] = js.undefined, trace: UndefOr[Boolean] = js.undefined, multipleStatements: UndefOr[Boolean] = js.undefined, flags: UndefOr[String] = js.undefined, ssl: UndefOr[SSLOptions] = js.undefined)

    host

    The hostname of the database you are connecting to. (Default: localhost)

    port

    The port number to connect to. (Default: 3306)

    localAddress

    The source IP address to use for TCP connection. (Optional)

    socketPath

    The path to a unix domain socket to connect to. When used host and port are ignored.

    user

    The MySQL user to authenticate as.

    password

    The password of that MySQL user.

    database

    Name of the database to use for this connection (Optional).

    charset

    The charset for the connection. This is called "collation" in the SQL-level of MySQL (like utf8_general_ci). If a SQL-level charset is specified (like utf8mb4) then the default collation for that charset is used. (Default: 'UTF8_GENERAL_CI')

    timezone

    The timezone used to store local dates. (Default: 'local')

    connectTimeout

    The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)

    stringifyObjects

    Stringify objects instead of converting to values. See issue #501. (Default: 'false')

    insecureAuth

    Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false)

    typeCast

    Determines if column values should be converted to native JavaScript types. (Default: true)

    queryFormat

    A custom query format function. See Custom format.

    supportBigNumbers

    When dealing with big numbers (BIGINT and DECIMAL columns) in the database, you should enable this option (Default: false).

    bigNumberStrings

    Enabling both supportBigNumbers and bigNumberStrings forces big numbers (BIGINT and DECIMAL columns) to be always returned as JavaScript String objects (Default: false). Enabling supportBigNumbers but leaving bigNumberStrings disabled will return big numbers as String objects only when they cannot be accurately represented with [JavaScript Number objects] (http://ecma262-5.com/ELS5_HTML.htm#Section_8.5) (which happens when they exceed the [-253, +253] range), otherwise they will be returned as Number objects. This option is ignored if supportBigNumbers is disabled.

    dateStrings

    Force date types (TIMESTAMP, DATETIME, DATE) to be returned as strings rather then inflated into JavaScript Date objects. (Default: false)

    debug

    Prints protocol details to stdout. (Default: false)

    trace

    Generates stack traces on Error to include call site of library entrance ("long stack traces"). Slight performance penalty for most calls. (Default: true)

    multipleStatements

    Allow multiple mysql statements per query. Be careful with this, it could increase the scope of SQL injection attacks. (Default: false)

    flags

    List of connection flags to use other than the default ones. It is also possible to blacklist default ones. For more information, check Connection Flags.

    ssl

    object with ssl parameters or a string containing name of ssl profile. See SSL options.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. var bigNumberStrings: UndefOr[Boolean]
  6. var charset: UndefOr[String]
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. var connectTimeout: UndefOr[Boolean]
  9. var database: UndefOr[String]
  10. var dateStrings: UndefOr[String]
  11. var debug: UndefOr[Boolean]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. var flags: UndefOr[String]
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. var host: UndefOr[String]
  20. var insecureAuth: UndefOr[Boolean]
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  23. var localAddress: UndefOr[String]
  24. var multipleStatements: UndefOr[Boolean]
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  28. var password: UndefOr[String]
  29. var port: UndefOr[Int]
  30. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  31. var queryFormat: UndefOr[String]
  32. var socketPath: UndefOr[String]
  33. var ssl: UndefOr[SSLOptions]
  34. var stringifyObjects: UndefOr[Boolean]
  35. var supportBigNumbers: UndefOr[Boolean]
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. var timezone: UndefOr[String]
  38. def toLocaleString(): String
    Definition Classes
    Object
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. var trace: UndefOr[Boolean]
  41. var typeCast: UndefOr[Boolean]
  42. var user: UndefOr[String]
  43. def valueOf(): Any
    Definition Classes
    Object
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped