Skip to content

Latest commit

 

History

History
121 lines (92 loc) · 4.21 KB

README.md

File metadata and controls

121 lines (92 loc) · 4.21 KB
Raw

Codacy Badge

C++ Database Adapter

This repository defines a library-agnostic API for C++ to work with a database

Supported features

  • Table queries
  • Table record insert, update and delete
  • SQL queries
  • Transactions

Available implementations

Usage

Build a database connection (systelab::db::IDatabase) using the particular instructions described on the selected implementation. This connection is the starting point for all the operations that interact with the database.

Query table contents

std::unique_ptr<systelab::db::IDatabase> database = connectToDatabase();
systelab::db::ITable& table = database->getTable("Table");

// Create a record set with all the records of the table and loop through it 
std::unique_ptr<systelab::db::ITableRecordSet> recordset = table.getAllRecords();
while (recordset->isCurrentRecordValid())
{
    const systelab::db::ITableRecord& record = recordset->getCurrentRecord();

    // Extract data from the current record
    int intValue = record.getFieldValue("intFieldName").getIntValue();
    std::string stringValue = record.getFieldValue("stringFieldName").getStringValue();
    std::chrono::system_clock::time_point dateTimeValue = record.getFieldValue("dateTimeFieldName").getDateTimeValue();

    recordset->nextRecord();
}

Insert a new record

// Create an empty record for a table
systelab::db::ITable& table = database.getTable("Table");
std::unique_ptr<systelab::db::ITableRecord> record = table.createRecord();

// Fill record with data
record->getFieldValue("intFieldName").setIntValue(1234);
record->getFieldValue("stringFieldName").setStringValue("ABCDE");
record->getFieldValue("dateTimeFieldName").setDateTimeValue(std::chrono::sys_days{2020y/10/23});

// Perform the record insertion
table.insertRecord(*record);

Update records by condition

// Create a new record of the table and fill it with the values to update
std::unique_ptr<systelab::db::ITableRecord> record = table.createRecord();
record->getFieldValue("intField").setIntValue(5);
record->getFieldValue("stringField").setStringValue("NEW_VALUE");
record->getFieldValue("doubleField").setDoubleValue(777.888);
record->getFieldValue("booleanField").setBooleanValue(false);

// Add the IFieldValue's to update into a vector
std::vector<systelab::db::IFieldValue*> newValues;
newValues.push_back( &(record->getFieldValue("stringField")) );
newValues.push_back( &(record->getFieldValue("doubleField")) );
newValues.push_back( &(record->getFieldValue("booleanField")) );

// Add the IFieldValue's of condition into another vector
std::vector<systelab::db::IFieldValue*> conditionValues;
conditionValues.push_back( &(auxRecord->getFieldValue("intField")) );

// Perform the multiple records edition
systelab::db::RowsAffected nRows = table.updateRecordsByCondition(newValues, conditionValues);

Delete records by condition

systelab::db::IField& conditionField = table.getField("conditionField");
std::unique_ptr<systelab::db::IFieldValue> conditionFieldValue1 =
    table.createFieldValue(conditionField, std::string("VALUE"));
std::vector<systelab::db::IFieldValue*> conditionValues = { conditionFieldValue.get() };
systelab::db::RowsAffected nRows = table.deleteRecordsByCondition(conditionValues);

Ad-hoc SQL queries

std::string sqlQuery = "SELECT * FROM TestTable WHERE id > 50 AND id < 75";
std::unique_ptr<systelab::db::IRecordSet> recordSet = m_db->executeQuery(sqlQuery);
while (recordSet.isCurrentRecordValid())
{
    const systelab::db::IRecord& record = recordSet.getCurrentRecord();
    // Extract data from record
    recordSet.nextRecord();
}

Transactions

std::unique_ptr<systelab::db::ITransaction> transaction = database.startTransaction();
try
{
    // Perform HERE some operations that update DB
    transaction->commit();
}
catch(std::exception&)
{
    transaction->rollback();
}