Fork me on GitHub

Sections

  • classes

    This section contains module classes API description.

  • exports

    This section contains module exports, available when you call require('mysql-libmysqlclient').

section

Classes section

View source

Description

This section contains module classes API description.

Classes

class

MysqlConnection

View source

Description

MySQL connection class, base version

Subclasses

Constructor

Instance methods

Instance properties

Aliased as:
constructor

MysqlConnection.new

View source
    • new MysqlConnection()

Creates new MysqlConnection object

instance method

MysqlConnection#affectedRowsSync

View source
    • MysqlConnection#affectedRowsSync()
      • Integer

Gets number of affected rows in previous operation

instance method

MysqlConnection#autoCommitSync

View source
    • MysqlConnection#autoCommitSync(mode)
      • Boolean
    • mode
      • Boolean

    • Mode flag

Sets autocommit mode

instance method

MysqlConnection#changeUserSync

View source
    • MysqlConnection#changeUserSync(user[, password][, database])
      • Boolean
    • user
      • String

    • Username

    • password
      • String

    • Password

    • database
      • String

    • Database to use

Changes the user and causes the database to become the default

instance method

MysqlConnection#closeSync

View source
    • MysqlConnection#closeSync()

Closes database connection

instance method

MysqlConnection#commitSync

View source
    • MysqlConnection#commitSync()
      • Boolean

Commits the current transaction

instance method

MysqlConnection#connect

View source
    • MysqlConnection#connect([hostname][, user][, password][, database][, port][, socket], callback)
    • hostname
      • String

    • Hostname

    • user
      • String

    • Username

    • password
      • String

    • Password

    • database
      • String

    • Database to use

    • port
      • Integer

    • Connection port

    • socket
      • String

    • Connection socket

    • callback
      • Function

    • Callback function, gets (error)

Connects to the MySQL server

instance method

MysqlConnection#connectedSync

View source
    • MysqlConnection#connectedSync()
      • Boolean

Returns current connected status

instance method

MysqlConnection#connectSync

View source
    • MysqlConnection#connectSync([hostname][, user][, password][, database][, port][, socket])
      • Boolean
    • hostname
      • String

    • Hostname

    • user
      • String

    • Username

    • password
      • String

    • Password

    • database
      • String

    • Database to use

    • port
      • Integer

    • Connection port

    • socket
      • String

    • Connection socket

Connects to the MySQL server

instance method

MysqlConnection#debugSync

View source
    • MysqlConnection#debugSync(message)
    • message
      • String

    • Debug message

Performs debug logging

instance method

MysqlConnection#dumpDebugInfoSync

View source
    • MysqlConnection#dumpDebugInfoSync()
      • Boolean

Dump debugging information into the log

instance method

MysqlConnection#errnoSync

View source
    • MysqlConnection#errnoSync()
      • Integer

Returns the last error code

instance method

MysqlConnection#errorSync

View source
    • MysqlConnection#errorSync()
      • String

Returns the last error message

instance method

MysqlConnection#escapeSync

View source
    • MysqlConnection#escapeSync(string)
      • String
    • string
      • String

    • String to escape

Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection

instance method

MysqlConnection#fieldCountSync

View source
    • MysqlConnection#fieldCountSync()
      • Integer

Returns the number of columns for the most recent query

instance method

MysqlConnection#getCharsetNameSync

View source
    • MysqlConnection#getCharsetNameSync()
      • String

Returns a character set name

instance method

MysqlConnection#getCharsetSync

View source
    • MysqlConnection#getCharsetSync()
      • Object

Returns a character set object

instance method

MysqlConnection#getClientInfoSync

View source
    • MysqlConnection#getClientInfoSync()
      • Object

Returns the MySQL client version and information

instance method

MysqlConnection#getInfoStringSync

View source
    • MysqlConnection#getInfoStringSync()
      • String

Retrieves information about the most recently executed query

instance method

MysqlConnection#getInfoSync

View source
    • MysqlConnection#getInfoSync()
      • Object

Returns the MySQL client, server, host and protocol version and information

instance method

MysqlConnection#getWarningsSync

View source
    • MysqlConnection#getWarningsSync()
      • Array

Gets result of SHOW WARNINGS

instance method

MysqlConnection#initStatementSync

View source

Initializes a statement and returns it

instance method

MysqlConnection#initSync

View source
    • MysqlConnection#initSync()
      • Boolean

Initializes MysqlConnection

instance method

MysqlConnection#lastInsertIdSync

View source
    • MysqlConnection#lastInsertIdSync()
      • Integer

Returns the auto generated id used in the last query

instance method

MysqlConnection#multiMoreResultsSync

View source
    • MysqlConnection#multiMoreResultsSync()
      • Boolean

Checks if there are any more query results from a multi query

instance method

MysqlConnection#multiNextResultSync

View source
    • MysqlConnection#multiNextResultSync()
      • Boolean

Prepare next result from multi query

instance method

MysqlConnection#multiRealQuerySync

View source
    • MysqlConnection#multiRealQuerySync(query)
      • Boolean
    • query
      • String

    • Query

Performs a multi query on the database

instance method

MysqlConnection#pingSync

View source
    • MysqlConnection#pingSync()
      • Boolean

Pings a server connection, or tries to reconnect if the connection has gone down

instance method

MysqlConnection#query

View source
    • MysqlConnection#query(query, callback)
    • query
      • String

    • Query

    • callback
      • Function

    • Callback function, gets (error, result)

Performs a query on the database. Uses mysql_real_query.

instance method

MysqlConnection#querySend

View source
    • MysqlConnection#querySend(query, callback)
    • query
      • String

    • Query

    • callback
      • Function

    • Callback function, gets (errro, result)

Performs a query on the database. Uses mysql_send_query.

instance method

MysqlConnection#querySync

View source
    • query
      • String

    • Query

Performs a query on the database.

instance method

MysqlConnection#realConnectSync

View source
    • MysqlConnection#realConnectSync([hostname][, user][, password][, database][, port][, socket])
      • Boolean
    • hostname
      • String

    • Hostname

    • user
      • String

    • Username

    • password
      • String

    • Password

    • database
      • String

    • Database to use

    • port
      • Integer

    • Connection port

    • socket
      • String

    • Connection socket

Open a new connection to the MySQL server

instance method

MysqlConnection#realQuerySync

View source
    • MysqlConnection#realQuerySync()
      • Boolean
    • query
      • String

    • Query

Executes an SQL query

instance method

MysqlConnection#rollbackSync

View source
    • MysqlConnection#rollbackSync()
      • Boolean

Rolls back current transaction

instance method

MysqlConnection#selectDbSync

View source
    • MysqlConnection#selectDbSync(database)
      • Boolean
    • database
      • String

    • Database to use

Selects the default database for database queries

instance method

MysqlConnection#setCharsetSync

View source
    • MysqlConnection#setCharsetSync()
      • Boolean
    • charset
      • String

    • Charset

Sets the default client character set

instance method

MysqlConnection#setOptionSync

View source
    • MysqlConnection#setOptionSync(key, value)
      • Boolean
    • key
      • Integer

    • Option key

    • value
      • Integer
      • String

    • Option value

Sets connection options

instance method

MysqlConnection#setSslSync

View source
    • MysqlConnection#setSslSync()

Sets SSL options Used for establishing secure connections

  • key (String): Key file
  • cert (String): Certificate file
  • ca (String): Certificate authority file
  • capath(String): CA certificates in PEM directory
  • cipher (String): Allowable ciphers
instance method

MysqlConnection#sqlStateSync

View source
    • MysqlConnection#sqlStateSync()
      • String

Returns the SQLSTATE error from previous MySQL operation

instance method

MysqlConnection#statSync

View source
    • MysqlConnection#statSync()
      • String

Gets the current system status

instance method

MysqlConnection#storeResultSync

View source

Transfers a result set from the last query

instance method

MysqlConnection#threadIdSync

View source
    • MysqlConnection#threadIdSync()
      • Integer

Returns the thread ID for the current connection

instance method

MysqlConnection#threadSafeSync

View source
    • MysqlConnection#threadSafeSync()
      • Boolean

Returns whether thread safety is given or not

instance method

MysqlConnection#useResultSync

View source

Initiates a result set retrieval for the last query

instance method

MysqlConnection#warningCountSync

View source
    • MysqlConnection#warningCountSync()
      • Integer

Returns the number of warnings from the last query for the given link

instance property

MysqlConnection#connectErrno

View source
read-only
    • MysqlConnection#connectErrno
      • Integer

Gets last connect error number

instance property

MysqlConnection#connectError

View source
read-only
    • MysqlConnection#connectError
      • String

Gets last connect error string

class

MysqlConnectionHighlevel

View source

Description

MySQL connection with only high-level methods

Superclass

MysqlConnectionQueued

Instance methods

instance method

MysqlConnectionHighlevel#query

View source
    • MysqlConnectionHighlevel#query(query[, callback])

Performs a query on the database

Uses mysql_real_query() or mysql_send_query() depends on this._queryType

instance method

MysqlConnectionHighlevel#setQueryTypeSync

View source
    • MysqlConnectionHighlevel#setQueryTypeSync(queryType)

Sets this._queryType

class

MysqlConnectionQueued

View source

Description

MySQL connection with queries queue

Superclass

MysqlConnection

Subclasses

Instance methods

instance method

MysqlConnectionQueued#connect

View source
    • MysqlConnectionQueued#connect
    • MysqlConnectionQueued#connect
    • MysqlConnectionQueued#connect
    • MysqlConnectionQueued#connect
    • MysqlConnectionQueued#connect
    • MysqlConnectionQueued#connect
    • MysqlConnectionQueued#connect(hostname, user, password, database, port, socket, flags[, callback])

Connects to the MySQL server

instance method

MysqlConnectionQueued#query

View source
    • MysqlConnectionQueued#query(query[, callback])

Performs a query on the database

Uses mysql_real_query()

instance method

MysqlConnectionQueued#querySend

View source
    • MysqlConnectionQueued#querySend(query[, callback])

Performs a query on the database

Uses mysql_send_query()

class

MysqlResult

View source

Description

MySQL results class

Constructor

Instance methods

Instance properties

Aliased as:
constructor

MysqlResult.new

View source
internal
    • new MysqlResult()

Creates new MysqlResult object

instance method

MysqlResult#dataSeekSync

View source
    • MysqlResult#dataSeekSync(offset)
    • offset
      • Integer

    • The field offset

Adjusts the result pointer to an arbitrary row in the result

instance method

MysqlResult#fetchAll

View source
    • MysqlResult#fetchAll
    • MysqlResult#fetchAll(options, callback)
    • options
      • Boolean
      • Object

    • Fetch style options (optional)

    • callback
      • Function

    • Callback function, gets (error, rows)

Fetches all result rows as an array

instance method

MysqlResult#fetchAllSync

View source
    • MysqlResult#fetchAllSync([options])
      • Array
    • options
      • Object

    • Fetch style options (optional)

Fetches all result rows as an array

instance method

MysqlResult#fetchFieldDirectSync

View source
    • MysqlResult#fetchFieldDirectSync(fieldNum)
      • Object
    • fieldNum
      • Integer

    • Field number (starts from 0)

Returns metadata of the arbitrary field in the result set

instance method

MysqlResult#fetchFieldsSync

View source
    • MysqlResult#fetchFieldsSync()
      • Array

Returns an array of objects representing the fields in a result set

instance method

MysqlResult#fetchFieldSync

View source
    • MysqlResult#fetchFieldSync()
      • Object

Returns metadata of the next field in the result set

instance method

MysqlResult#fetchLengthsSync

View source
    • MysqlResult#fetchLengthsSync()
      • Array

Returns the lengths of the columns of the current row in the result set

instance method

MysqlResult#fetchRowSync

View source
    • MysqlResult#fetchRowSync([options])
      • Array
      • Object
    • options
      • Object

    • Fetch style options (optional)

Fetch one row from result

instance method

MysqlResult#fieldSeekSync

View source
    • MysqlResult#fieldSeekSync(fieldNumber)
    • fieldNumber
      • Integer

    • Field number (starts from 0)

Set result pointer to a specified field offset

instance method

MysqlResult#fieldTellSync

View source
    • MysqlResult#fieldTellSync()
      • Integer

Returns the position of the field cursor

instance method

MysqlResult#freeSync

View source
    • MysqlResult#freeSync()

Frees the memory associated with a result

instance method

MysqlResult#numRowsSync

View source
    • MysqlResult#numRowsSync()
      • Integer

Gets the number of rows in a result

instance property

MysqlResult#fieldCount

View source
read-only
    • MysqlResult#fieldCount
      • Integer
      • Undefined

Get the number of fields in a result

class

MysqlStatement

View source

Description

MySQL prepared statement class

Constructor

Instance methods

Instance properties

Aliased as:
constructor

MysqlStatement.new

View source
    • new MysqlStatement()

Creates new MysqlStatement object

instance method

MysqlStatement#affectedRowsSync

View source
    • MysqlStatement#affectedRowsSync()
      • Integer

Gets number of affected rows in previous operation

instance method

MysqlStatement#attrGetSync

View source
    • MysqlStatement#attrGetSync(attr)
      • Integer
      • Boolean

Used to get the current value of a statement attribute

instance method

MysqlStatement#attrSetSync

View source
    • MysqlStatement#attrSetSync(attr, value)
      • Boolean
    • attr
      • Integer
    • value
      • Integer
      • Boolean

Used to modify the behavior of a prepared statement

instance method

MysqlStatement#bindParamsSync

View source
    • MysqlStatement#bindParamsSync(params)
      • Boolean
    • params
      • Array

Binds variables to a prepared statement as parameters

instance method

MysqlStatement#bindResultSync

View source
    • MysqlStatement#bindResultSync()
      • Boolean

Bind result set buffers

instance property

MysqlStatement#paramCount

View source
read-only
    • MysqlStatement#paramCount
      • Integer

Gets the number of parameter for the given statement

section

Exports section

View source

Description

This section contains module exports, available when you call require('mysql-libmysqlclient').

Namespaces

namespace

MysqlLibmysqlclient

View source

Description

Asynchronous MySQL bindings for Node.js

Namespaces

Class methods

namespace

MysqlLibmysqlclient.bindings

View source

Description

mysql-libmysqlclient module bindings

Classes

class

MysqlLibmysqlclient.bindings.MysqlConnection

View source
Alias of:
class

MysqlLibmysqlclient.bindings.MysqlResult

View source
Alias of:
class

MysqlLibmysqlclient.bindings.MysqlStatement

View source
Alias of:
class method

MysqlLibmysqlclient.createConnectionHighlevel

View source
    • MysqlLibmysqlclient.createConnectionHighlevel
    • MysqlLibmysqlclient.createConnectionHighlevel
    • MysqlLibmysqlclient.createConnectionHighlevel
    • MysqlLibmysqlclient.createConnectionHighlevel
    • MysqlLibmysqlclient.createConnectionHighlevel
    • MysqlLibmysqlclient.createConnectionHighlevel
    • MysqlLibmysqlclient.createConnectionHighlevel(hostname, user, password, database, port, socket, flags[, callback])

Creates high-level connection to database

Asynchronous version

class method

MysqlLibmysqlclient.createConnectionHighlevelSync

View source
    • MysqlLibmysqlclient.createConnectionHighlevelSync
    • MysqlLibmysqlclient.createConnectionHighlevelSync
    • MysqlLibmysqlclient.createConnectionHighlevelSync
    • MysqlLibmysqlclient.createConnectionHighlevelSync
    • MysqlLibmysqlclient.createConnectionHighlevelSync
    • MysqlLibmysqlclient.createConnectionHighlevelSync
    • MysqlLibmysqlclient.createConnectionHighlevelSync(hostname, user, password, database, port, socket, flags)

Creates high-level connection to database

Synchronous version

class method

MysqlLibmysqlclient.createConnectionQueued

View source
    • MysqlLibmysqlclient.createConnectionQueued
    • MysqlLibmysqlclient.createConnectionQueued
    • MysqlLibmysqlclient.createConnectionQueued
    • MysqlLibmysqlclient.createConnectionQueued
    • MysqlLibmysqlclient.createConnectionQueued
    • MysqlLibmysqlclient.createConnectionQueued
    • MysqlLibmysqlclient.createConnectionQueued(hostname, user, password, database, port, socket, flags[, callback])

Creates queued connection to database

Asynchronous version

class method

MysqlLibmysqlclient.createConnectionQueuedSync

View source
    • MysqlLibmysqlclient.createConnectionQueuedSync
    • MysqlLibmysqlclient.createConnectionQueuedSync
    • MysqlLibmysqlclient.createConnectionQueuedSync
    • MysqlLibmysqlclient.createConnectionQueuedSync
    • MysqlLibmysqlclient.createConnectionQueuedSync
    • MysqlLibmysqlclient.createConnectionQueuedSync
    • MysqlLibmysqlclient.createConnectionQueuedSync(hostname, user, password, database, port, socket, flags)

Creates queued connection to database

Synchronous version

class method

MysqlLibmysqlclient.createConnectionSync

View source
    • MysqlLibmysqlclient.createConnectionSync
    • MysqlLibmysqlclient.createConnectionSync
    • MysqlLibmysqlclient.createConnectionSync
    • MysqlLibmysqlclient.createConnectionSync
    • MysqlLibmysqlclient.createConnectionSync
    • MysqlLibmysqlclient.createConnectionSync
    • MysqlLibmysqlclient.createConnectionSync
    • MysqlLibmysqlclient.createConnectionSync(hostname, user, password, database, port, socket, flags, callback)

Creates connection to database

Asynchronous version