Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MySQLAuthOptions

Authentication options for MySQL authentication which can be used for CHANGE_USER command.

Hierarchy

  • MySQLAuthOptions

Index

Constructors

Methods

Constructors

constructor

Methods

getCharset

  • getCharset(): string

  • Set the charset for the connection.

    Returns string

getCollation

  • getCollation(): string

  • Set the collation for the connection.

    Returns string

getDatabase

  • getDatabase(): string

  • Specify the default database for the re-authentication.

    Returns string

getPassword

  • getPassword(): string

  • Specify the user password to be used for the authentication.

    Returns string

getProperties

  • getProperties(): {}

  • Set connection attributes which will be sent to server at the re-authentication.

    Returns {}

    • [key: string]: string

getServerRsaPublicKeyPath

  • getServerRsaPublicKeyPath(): string

  • Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

    Returns string

getServerRsaPublicKeyValue

  • getServerRsaPublicKeyValue(): Buffer

  • Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

    Returns Buffer

getUser

  • getUser(): string

  • Specify the user account to be used for the authentication.

    Returns string

setCharset

  • Set the charset for the connection.

    Parameters

    • charset: string

    Returns MySQLAuthOptions

setCollation

  • Set the collation for the connection.

    Parameters

    • collation: string

    Returns MySQLAuthOptions

setDatabase

  • Specify the default database for the re-authentication.

    Parameters

    • database: string

    Returns MySQLAuthOptions

setPassword

  • Specify the user password to be used for the authentication.

    Parameters

    • password: string

    Returns MySQLAuthOptions

setProperties

  • Set connection attributes which will be sent to server at the re-authentication.

    Parameters

    • properties: {}
      • [key: string]: string

    Returns MySQLAuthOptions

setServerRsaPublicKeyPath

  • Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

    Parameters

    • serverRsaPublicKeyPath: string

    Returns MySQLAuthOptions

setServerRsaPublicKeyValue

  • Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

    Parameters

    • serverRsaPublicKeyValue: Buffer

    Returns MySQLAuthOptions

setUser

  • Specify the user account to be used for the authentication.

    Parameters

    • user: string

    Returns MySQLAuthOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc