SqlDatabaseInterface Class Reference

#include <sqldatabase.h>

Inheritance diagram for SqlDatabaseInterface:

Detailed Description

This class provides SQL database functionality. With it it's possible to query sql databases. E.g. Result<SqlDatabaseRef> mySql = SqlDatabaseClasses::MySql().Create(); provides access to mysql databases.

Public Member Functions

MAXON_METHOD Result< void > Init (const String &sqlServer, Int sqlServerPort, const String &sqlUserName, const String &sqlPasswd, const String &sqlDatabase)
 
MAXON_METHOD Bool IsConnected () const
 
MAXON_METHOD Result< void > QuerySQL (const String &query, Int64 *insertId=nullptr, BaseArray< BaseArray< String >> *result=nullptr)
 
MAXON_METHOD Result< StringQuotedString (const String &text) const
 
MAXON_METHOD Result< StringReplaceString (const String &text) const
 

Private Member Functions

 MAXON_INTERFACE (SqlDatabaseInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.sqldatabase")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( SqlDatabaseInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.interface.sqldatabase"   
)
private

◆ Init()

MAXON_METHOD Result<void> Init ( const String sqlServer,
Int  sqlServerPort,
const String sqlUserName,
const String sqlPasswd,
const String sqlDatabase 
)

Opens the connection to a.

Parameters
[in]sqlServerIP address of the sql server.
[in]sqlServerPortPort of the sql server.
[in]sqlUserNameUser name at the given sql server.
[in]sqlPasswdPassword of the user.
[in]sqlDatabaseOpens this database within the sql database on the server. This parameter is optional.
Returns
Returns true if opening the database was successful. {returnsThis}

◆ IsConnected()

MAXON_METHOD Bool IsConnected ( ) const

Determines if the connection to the database has been established.

Returns
Returns true if the connection is open, otherwise false.

◆ QuerySQL()

MAXON_METHOD Result<void> QuerySQL ( const String query,
Int64 insertId = nullptr,
BaseArray< BaseArray< String >> *  result = nullptr 
)

Sends a query to the database.

Parameters
[in]queryThe sql request string. E.g. "SELECT * from mydatabase".
[out]insertIdIf the query inserted data into the database, this pointer returns the insert id in the database. This parameter is optional.
[out]resultIf the query returns data it will be filled into this array. This parameter is optional. The outer array contains the number of lines returned by this query. The first line contains the field header names. The inner array the fields per line returned by this query.
Returns
Returns true if the query was successful, otherwise false.

◆ QuotedString()

MAXON_METHOD Result<String> QuotedString ( const String text) const

This functions returns a quoted string usable for sql queries. This function calls internally ReplaceString() to make the given text sql conform.

Parameters
[in]textThe given text the has to be converted.
Returns
The converted string.

◆ ReplaceString()

MAXON_METHOD Result<String> ReplaceString ( const String text) const

This functions converts a string into usable style for sql queries.

Parameters
[in]textThe given text the has to be converted.
Returns
The converted string.