develop/ASqlDatabase_8h_source.html

/*

 * AUI Framework - Declarative UI toolkit for modern C++20

 * Copyright (C) 2020-2025 Alex2772 and Contributors

 *

 * SPDX-License-Identifier: MPL-2.0

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 */


#pragma once


#include <AUI/Data.h>

#include "AUI/Common/SharedPtrTypes.h"

#include "AUI/Common/AMap.h"

#include "ISqlDriver.h"

#include "AUI/Common/AVector.h"

#include "AUI/Common/AVariant.h"

#include "ASqlQueryResult.h"

#include "ASqlDriverType.h"


class AString;


class API_AUI_DATA ASqlDatabase

{

private:

    static AMap<AString, _<ISqlDriver>>& getDrivers();


    _<ISqlDatabase> mDriverInterface;


    explicit ASqlDatabase(const _<ISqlDatabase>& driver_interface, const AString& driverName)

        : mDriverInterface(driver_interface)

    {

    }


public:

    ~ASqlDatabase();


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


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


    static _<ASqlDatabase> connect(const AString& driverName, const AString& address, uint16_t port = 0,

                                   const AString& databaseName = {}, const AString& username = {},

                                   const AString& password = {});


    SqlDriverType getDriverType();


    static void registerDriver(_<ISqlDriver> driver);

};


AMap
A std::map with AUI extensions.
Definition AMap.h:218

ASqlDatabase::execute
int execute(const AString &query, const AVector< AVariant > &params={})
Execute a query with no result (UPDATE, INSERT, DELETE, etc.)

ASqlDatabase::connect
static _< ASqlDatabase > connect(const AString &driverName, const AString &address, uint16_t port=0, const AString &databaseName={}, const AString &username={}, const AString &password={})
Connect to the database using the specified details and driver.

ASqlDatabase::query
_< ASqlQueryResult > query(const AString &query, const AVector< AVariant > &params={})
Execute a query with the result (SELECT).

ASqlDatabase::getDriverType
SqlDriverType getDriverType()
the type of the driver. Required to correct queries in the database due to driver differences.

AString
Represents a Unicode character string.
Definition AString.h:38

AVector
A std::vector with AUI extensions.
Definition AVector.h:39

_
An std::weak_ptr with AUI extensions.
Definition SharedPtrTypes.h:179