Class Connection

A class representing a database connection.

If you are using Vibe.d, consider using mysql.pool.MySQLPool instead of creating a new Connection directly. That will provide certain benefits, such as reusing old connections and automatic cleanup (no need to close the connection when done). 

// Suggested usage:

{
	auto con = new Connection("host=localhost;port=3306;user=joe;pwd=pass123;db=myappsdb");
	scope(exit) con.close();

	// Use the connection
	...
}

Inherits from

  • Object (base class)

Constructors

Name Description
this Construct opened connection.

Properties

Name Type Description
charSet [get] ubyte Current character set
closed [get] bool Check whether this Connection is still connected to the server, or if the connection has been closed.
currentDB [get] string Current database
hasPending [get] bool Gets whether anything (rows, headers or binary) is pending.
lastCommandID [get] ulong This gets incremented every time a command is issued or results are purged,
lastInsertID [get] ulong After a command that inserted a row into a table with an auto-increment
protocol [get] ubyte Return the in-force protocol number
resultFieldDescriptions [get] FieldDescription[] Gets the result header's field descriptions.
rowsPending [get] bool Gets whether rows are pending
serverCapabilities [get] uint Server capability flags
serverStatus [get] ushort Server status
serverVersion [get] string Server version
socketType [get] MySQLSocketType Socket type being used

Methods

Name Description
acquire Used by Vibe.d's ConnectionPool, ignore this.
amOwner Used by Vibe.d's ConnectionPool, ignore this.
close Explicitly close the connection.
enableMultiStatements Enable multiple statement commands
getNextRow Get the next Row of a pending result set.
isOwner Used by Vibe.d's ConnectionPool, ignore this.
parseConnectionString Parses a connection string of the form "host=localhost;port=3306;user=joe;pwd=pass123;db=myappsdb"
pingServer Check the server status
purgeResult Flush any outstanding result set elements.
reconnect Reconnects to the server using the same connection settings originally used to create the Connection.
refreshServer Refresh some feature(s) of the server.
release Used by Vibe.d's ConnectionPool, ignore this.
selectDB Select a current database.
serverStats Get a textual report on the server status.

Authors

Copyright

License