ASqlDatabase Class Reference

Member Function Documentation

> All members, including inherited

connect()

static _< ASqlDatabase > ASqlDatabase::connect ( const AString & driverName, const AString & address, uint16_t port = 0, const AString & databaseName = {}, const AString & username = {}, const AString & password = {} )

static

Parameters

driverName	name of the database driver. If the driver is not loaded, an attempt will be made to load the driver based on the template aui.DRIVERNAME (aui.DRIVERNAME.dll for Windows, libaui.DRIVERNAME.so for Linux, etc...). If the driver failed to load SQLException will be thrown.
address	server host (IP address or domain)
port	server port
databaseName	name of the database
username	user name; optional in some DBMS
password	user password; optional in some DBMS

Returns

object for communicating with the database; in some DBMS - optional

Exceptions

SQLException

when any error occurs

execute()

int ASqlDatabase::execute	(	const AString &	query,
		const AVector< AVariant > &	params = {} )

Parameters

query	the SQL query
params	query arguments

Returns

number of affected rows

Exceptions

SQLException

if any error occurs

getDriverType()

SqlDriverType ASqlDatabase::getDriverType

(

)

Returns

type of driver

query()

_< ASqlQueryResult > ASqlDatabase::query	(	const AString &	query,
		const AVector< AVariant > &	params = {} )

Parameters

query	the SQL query
params	query arguments

Returns

query result

Exceptions

SQLException

when any error occurs

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.

Contents

View Page SourceEdit Page Source