Skip to content
Snippets Groups Projects
Commit 85a2a382 authored by Riccardo Maria Bianchi's avatar Riccardo Maria Bianchi ☀️
Browse files

Add new method to get records out of custom tables from client code

parent fdca5a1c
No related branches found
No related tags found
1 merge request!182GeoModelIO: New method to retrieve custom tables from the SQLite .db file
Expand all Hide whitespace changes
Inline Side-by-side
GeoModelIO/GeoModelDBManager/GeoModelDBManager/GMDBManager.h
+ 286
− 236
View file @ 85a2a382
......@@ -3,25 +3,25 @@
*/
/*
* author: 2017, Riccardo Maria Bianchi, <riccardo.maria.bianchi@cern.ch>
* major updates:
* - Aug 2020, R.M.Bianchi,
* Added support to publish lists of FullPhysVol and AlignableTransform nodes
* - Jun 2022 - Riccardo Maria Bianchi, <riccardo.maria.bianchi@cern.ch>,
* Added support for "Verbose" output
*/
* author: 2017, Riccardo Maria Bianchi, <riccardo.maria.bianchi@cern.ch>
* major updates:
* - Aug 2020, R.M.Bianchi,
* Added support to publish lists of FullPhysVol and
* AlignableTransform nodes
* - Jun 2022 - Riccardo Maria Bianchi, <riccardo.maria.bianchi@cern.ch>,
* Added support for "Verbose" output
*/
#ifndef GMDBManager_H
#define GMDBManager_H
// include C++
#include <iostream>
#include <unordered_map>
#include <vector>
#include <string>
#include <typeindex> // std::type_index, needs C++11
#include <unordered_map>
#include <variant>
#include <typeindex> // std::type_index, needs C++11
#include <vector>
/**
* \class GMDBManager
......@@ -32,280 +32,330 @@
* and performs some basics queries.
*/
class GMDBManager
{
public:
/**
* @brief Constructor
*
* Constructor sets up connection with db and opens it
* @param path - absolute path to db file
*/
GMDBManager(const std::string &path);
// GMDBManagerStd(const std::string &path);
/**
* @brief Destructor
*
* Close the db connection
*/
~GMDBManager();
void DestructorGMDBManagerStd();
bool initDB();
int loadGeoNodeTypesAndBuildCache();
/**
* @brief Returns true if the DB is correctly open
*/
// bool isOpen() const;
bool checkIsDBOpen() const;
/**
* @brief Print names of all GeoPhysVol objects in db
*/
void printAllPhysVols() const;
/**
* @brief Print names of all GeoFullPhysVol objects in db
*/
void printAllFullPhysVols() const;
/**
* @brief Print names of all GeoLogVol objects in db
*/
void printAllLogVols() const;
/**
* @brief Print names of all GeoMaterial objects in db
*/
void printAllMaterials() const;
/**
* @brief Print names of all GeoElement objects in db
*/
void printAllElements() const;
/**
* @brief Print names of all GeoShape objects in db
*/
void printAllShapes() const;
/**
* @brief Print names of all GeoSerialDenominator objects in db
*/
void printAllSerialDenominators() const;
/**
* @brief Print names of all GeoSeriaIdentifier objects in db
*/
void printAllSerialIdentifiers() const;
/**
* @brief Print names of all GeoIdentifierTag objects in db
*/
void printAllIdentifierTags() const;
/**
* @brief Print names of all GeoSerialDenominators objects in db
*/
void printAllSerialTransformers() const;
/**
* @brief Print names of all Function objects in db
*/
void printAllFunctions() const;
/**
* @brief Print names of all GeoTransform objects in db
*/
void printAllTransforms() const;
/**
* @brief Print names of all GeoAlignableTransform objects in db
*/
void printAllAlignableTransforms() const;
/**
* @brief Print names of all GeoNameTag objects in db
*/
void printAllNameTags() const;
/**
* @brief Print the db table storing all the children positions per parent
*/
void printAllChildrenPositions() const;
/**
* @brief Print the db table storing all the 'published' GeoVFullPhysVol nodes.
* @details By default, the method prints out the table 'PublishedGeoFullPhysVols'.
* @param suffix If 'suffix' is provided, then the table 'PublishedGeoFullPhysVols-suffix' will be printed.
* @param suffix Optional parameter. If 'suffix' is provided, then the table 'PublishedGeoFullPhysVols-suffix' will be printed. Of course, developers must be first checked the related DB table has been created (e.g., through the tools offered by GeoModelKernel::GeoVStore and its implementation).
* @note The 'suffix' parameter is optional. If not provided, the default table will be printed.
*/
void printAllPublishedFullPhysVols(const std::string suffix = "") const;
/**
* @brief Print the db table storing all the 'published' GeoAlignableTransform nodes
* @details By default, the method prints out the table 'GeoAlignableTransforms'.
* @param suffix Optional parameter. If 'suffix' is provided, then the table 'GeoAlignableTransforms-suffix' will be printed. Of course, developers must be first checked the related DB table has been created (e.g., through the tools offered by GeoModelKernel::GeoVStore and its implementation).
* @note The 'suffix' parameter is optional. If not provided, the default table will be printed.
*/
void printAllPublishedAlignableTransforms(const std::string suffix = "") const;
class GMDBManager {
public:
/**
* @brief Print the db table storing all the children positions per parent
*/
void printAllNodeTypes() const;
* @brief Constructor
*
* Constructor sets up connection with db and opens it
* @param path - absolute path to db file
*/
GMDBManager(const std::string &path);
// GMDBManagerStd(const std::string &path);
/**
* @brief Print the DB table storing the ID of the PhysVol that is the Root volume
*/
void printRootVolumeId() const;
/**
* @brief Destructor
*
* Close the db connection
*/
~GMDBManager();
void DestructorGMDBManagerStd();
/**
* @brief Print the current version number of the DB schema
*/
void printDBVersion() const;
bool initDB();
void printAllRecords(const std::string &tableName) const;
int loadGeoNodeTypesAndBuildCache();
void printAllDBTables();
/**
* @brief Returns true if the DB is correctly open
*/
// bool isOpen() const;
bool checkIsDBOpen() const;
void createTableDataCaches();
void getAllDBTables();
void getAllDBTableColumns();
/**
* @brief Print names of all GeoPhysVol objects in db
*/
void printAllPhysVols() const;
int execQuery(std::string queryStr);
/**
* @brief Print names of all GeoFullPhysVol objects in db
*/
void printAllFullPhysVols() const;
/**
* @brief Print names of all GeoLogVol objects in db
*/
void printAllLogVols() const;
bool addListOfRecords(const std::string geoType, const std::vector<std::vector<std::string>> records);
/**
* @brief Print names of all GeoMaterial objects in db
*/
void printAllMaterials() const;
/**
* @brief Print names of all GeoElement objects in db
*/
void printAllElements() const;
bool addListOfChildrenPositions(const std::vector<std::vector<std::string>> &records);
/**
* @brief Save the list of 'published' GeoAlignableTransform nodes to the DB.
* @details The method gets a list of records and stores them in the default table 'PublishedAlignableTransforms".
* @parameter suffix Optional parameter. If provided, the list of records will be saved in a new table named 'PublishedAlignableTransforms-suffix'.
* @note The 'suffix' parameter is optional. If not provided, the records will be saved in the default table.
*/
bool addListOfPublishedAlignableTransforms(const std::vector<std::vector<std::string>> &records, std::string suffix = "");
/**
* @brief Save the list of 'published' GeoVFullPhysVol nodes to the DB.
* @details The method gets a list of records and stores them in the default table 'PublishedFullPhysVols".
* @parameter suffix Optional parameter. If provided, the list of records will be saved in a new table named 'PublishedFullPhysVols-suffix'.
* @note The 'suffix' parameter is optional. If not provided, the records will be saved in the default table.
*/
bool addListOfPublishedFullPhysVols(const std::vector<std::vector<std::string>> &records, std::string suffix = "");
/**
* @brief Print names of all GeoShape objects in db
*/
void printAllShapes() const;
bool addRootVolume(const std::vector<std::string> &values);
/**
* @brief Print names of all GeoSerialDenominator objects in db
*/
void printAllSerialDenominators() const;
// GET methods
/**
* @brief Print names of all GeoSeriaIdentifier objects in db
*/
void printAllSerialIdentifiers() const;
std::string getDBFilePath();
/**
* @brief Print names of all GeoIdentifierTag objects in db
*/
void printAllIdentifierTags() const;
std::vector<std::string> getRootPhysVol();
/**
* @brief Print names of all GeoSerialDenominators objects in db
*/
void printAllSerialTransformers() const;
/**
* @brief Print names of all Function objects in db
*/
void printAllFunctions() const;
std::vector<std::string> getItemFromTableName(std::string tableName, unsigned int id);
/**
* @brief Print names of all GeoTransform objects in db
*/
void printAllTransforms() const;
std::vector<std::string> getItemAndType(unsigned int tableId, unsigned int id);
/**
* @brief Print names of all GeoAlignableTransform objects in db
*/
void printAllAlignableTransforms() const;
std::string getNodeTypeFromTableId(unsigned int id);
/**
* @brief Print names of all GeoNameTag objects in db
*/
void printAllNameTags() const;
/**
* @brief Print the db table storing all the children positions per parent
*/
void printAllChildrenPositions() const;
/// methods to dump the DB
std::vector<std::vector<std::string>> getChildrenTable();
std::vector<std::vector<std::string>> getPublishedFPVTable( std::string suffix = "" );
std::vector<std::vector<std::string>> getPublishedAXFTable( std::string suffix = "" );
/**
* @brief Print the db table storing all the 'published' GeoVFullPhysVol
* nodes.
* @details By default, the method prints out the table
* 'PublishedGeoFullPhysVols'.
* @param suffix If 'suffix' is provided, then the table
* 'PublishedGeoFullPhysVols-suffix' will be printed.
* @param suffix Optional parameter. If 'suffix' is provided, then the table
* 'PublishedGeoFullPhysVols-suffix' will be printed. Of course, developers
* must be first checked the related DB table has been created (e.g.,
* through the tools offered by GeoModelKernel::GeoVStore and its
* implementation).
* @note The 'suffix' parameter is optional. If not provided, the default
* table will be printed.
*/
void printAllPublishedFullPhysVols(const std::string suffix = "") const;
std::vector<std::vector<std::string>> getTableFromNodeType(std::string nodeType);
/**
* @brief Print the db table storing all the 'published'
* GeoAlignableTransform nodes
* @details By default, the method prints out the table
* 'GeoAlignableTransforms'.
* @param suffix Optional parameter. If 'suffix' is provided, then the table
* 'GeoAlignableTransforms-suffix' will be printed. Of course, developers
* must be first checked the related DB table has been created (e.g.,
* through the tools offered by GeoModelKernel::GeoVStore and its
* implementation).
* @note The 'suffix' parameter is optional. If not provided, the default
* table will be printed.
*/
void printAllPublishedAlignableTransforms(
const std::string suffix = "") const;
/**
* @brief Print the db table storing all the children positions per parent
*/
void printAllNodeTypes() const;
std::unordered_map<unsigned int, std::string> getAll_TableIDsNodeTypes();
std::unordered_map<std::string, unsigned int> getAll_NodeTypesTableIDs();
/**
* @brief Print the DB table storing the ID of the PhysVol that is the Root
* volume
*/
void printRootVolumeId() const;
/**
* @brief Print the current version number of the DB schema
*/
void printDBVersion() const;
std::vector<std::vector<std::string>> getTableRecords(std::string tableName) const; // TODO: should be private?
void printAllRecords(const std::string &tableName) const;
/**
* @brief Create a custom DB table to store auxiliary data.
* @param tableName The name of the custom table
* @param tableColNames A vector of strings defining the names of the table's columns
* @param tableColTypes A vector of strings defining the types of the table's columns
* @param records A vector of std:variant<int,long,float,double,std::string> storing the table's rows' data
*/
bool createCustomTable(const std::string tableName, const std::vector<std::string> tableColNames, const std::vector<std::string> tableColTypes, const std::vector<std::vector<std::variant<int,long,float,double,std::string>>> &records );
//bool createCustomTable(const std::string tableName, const std::vector<std::string> tableColNames, const std::vector<std::string> tableColTypes, const std::vector<std::vector<std::string>> &records ); // not used anymore!!
void printAllDBTables();
void createTableDataCaches();
void getAllDBTables();
void getAllDBTableColumns();
int execQuery(std::string queryStr);
private:
bool addListOfRecords(const std::string geoType,
const std::vector<std::vector<std::string>> records);
/**
* @brief Create all the default DB tables.
*/
bool createTables();
bool addListOfChildrenPositions(
const std::vector<std::vector<std::string>> &records);
/**
* @brief Create a custom DB table to store a list of published nodes.
* @param tableName The table's name.
* @param keyType The type of the 'key' that identifies the linked node.
*/
bool createTableCustomPublishedNodes(const std::string tableName, const std::string nodeType, const std::type_info* keyType);
bool addListOfRecordsToTable(const std::string tableName, const std::vector<std::vector<std::string>> records);
bool addListOfRecordsToTable(const std::string tableName, const std::vector<std::vector<std::variant<int,long,float,double,std::string>>> records);
// bool addListOfRecordsToTableOld(const QString tableName, const std::vector<QStringList> records); // for the old SQlite only
/**
* @brief Save the list of 'published' GeoAlignableTransform nodes to the
* DB.
* @details The method gets a list of records and stores them in the default
* table 'PublishedAlignableTransforms".
* @parameter suffix Optional parameter. If provided, the list of records
* will be saved in a new table named 'PublishedAlignableTransforms-suffix'.
* @note The 'suffix' parameter is optional. If not provided, the records
* will be saved in the default table.
*/
bool addListOfPublishedAlignableTransforms(
const std::vector<std::vector<std::string>> &records,
std::string suffix = "");
void addDBversion(std::string version);
/**
* @brief Save the list of 'published' GeoVFullPhysVol nodes to the DB.
* @details The method gets a list of records and stores them in the default
* table 'PublishedFullPhysVols".
* @parameter suffix Optional parameter. If provided, the list of records
* will be saved in a new table named 'PublishedFullPhysVols-suffix'.
* @note The 'suffix' parameter is optional. If not provided, the records
* will be saved in the default table.
*/
bool addListOfPublishedFullPhysVols(
const std::vector<std::vector<std::string>> &records,
std::string suffix = "");
bool addRootVolume(const std::vector<std::string> &values);
// GET methods
// void loadTestData(); // for debug only
std::string getDBFilePath();
std::string getTableNameFromTableId(unsigned int tabId);
std::vector<std::string> getRootPhysVol();
unsigned int getTableIdFromNodeType(const std::string &nodeType);
void storeNodeType(std::string nodeType, std::string tableName);
std::vector<std::string> getItemFromTableName(std::string tableName,
unsigned int id);
std::string getTableNameFromNodeType(const std::string &nodeType);
std::vector<std::string> getItemAndType(unsigned int tableId,
unsigned int id);
void storeTableColumnNames(std::vector<std::string> input);
std::string getNodeTypeFromTableId(unsigned int id);
std::vector<std::string> getTableColumnNames(const std::string &tableName);
/// methods to dump the DB
std::vector<std::vector<std::string>> getChildrenTable();
std::vector<std::vector<std::string>> getPublishedFPVTable(
std::string suffix = "");
std::vector<std::vector<std::string>> getPublishedAXFTable(
std::string suffix = "");
int getTableColIndex(const std::string &tableName, const std::string &colName);
std::vector<std::vector<std::string>> getTableFromNodeType(
std::string nodeType);
bool storeRootVolume(const unsigned int &id, const std::string &nodeType);
std::unordered_map<unsigned int, std::string> getAll_TableIDsNodeTypes();
std::unordered_map<std::string, unsigned int> getAll_NodeTypesTableIDs();
std::string m_dbpath;
std::vector<std::vector<std::string>> getTableRecords(
std::string tableName) const; // TODO: should be private?
bool m_dbIsOK;
/**
* @brief Create a custom DB table to store auxiliary data.
* @param tableName The name of the custom table
* @param tableColNames A vector of strings defining the names of the
* table's columns
* @param tableColTypes A vector of strings defining the types of the
* table's columns
* @param records A vector of std:variant<int,long,float,double,std::string>
* storing the table's rows' data
*/
bool createCustomTable(
const std::string tableName,
const std::vector<std::string> tableColNames,
const std::vector<std::string> tableColTypes,
const std::vector<
std::vector<std::variant<int, long, float, double, std::string>>>
&records);
// bool createCustomTable(const std::string tableName, const
// std::vector<std::string> tableColNames, const std::vector<std::string>
// tableColTypes, const std::vector<std::vector<std::string>> &records ); //
// not used anymore!!
private:
/**
* @brief Create all the default DB tables.
*/
bool createTables();
bool m_debug;
/**
* @brief Create a custom DB table to store a list of published nodes.
* @param tableName The table's name.
* @param keyType The type of the 'key' that identifies the linked node.
*/
bool createTableCustomPublishedNodes(const std::string tableName,
const std::string nodeType,
const std::type_info *keyType);
// verbosity level
int m_verbose;
bool addListOfRecordsToTable(
const std::string tableName,
const std::vector<std::vector<std::string>> records);
bool addListOfRecordsToTable(
const std::string tableName,
const std::vector<
std::vector<std::variant<int, long, float, double, std::string>>>
records);
// bool addListOfRecordsToTableOld(const QString tableName, const
// std::vector<QStringList> records); // for the old SQlite only
std::unordered_map<std::string, std::vector<std::string>> m_tableNames; /// stores the column names for each table
std::unordered_map<std::string, std::string> m_childType_tableName;
void addDBversion(std::string version);
std::vector<std::string> m_cache_tables; /// cache for the list of tables in the DB
std::unordered_map<unsigned int, std::string> m_cache_tableId_tableName; /// cache for tableID-->tableName
std::unordered_map<unsigned int, std::string> m_cache_tableId_nodeType; /// cache for tableID-->nodeType
std::unordered_map<std::string, std::string> m_cache_nodeType_tableName; /// cache for nodeType-->tableName
std::unordered_map<std::string, unsigned int> m_cache_nodeType_tableID; /// cache for nodeType-->tableID
// void loadTestData(); // for debug only
protected:
class Imp;
Imp * m_d;
std::string getTableNameFromTableId(unsigned int tabId);
};
unsigned int getTableIdFromNodeType(const std::string &nodeType);
void storeNodeType(std::string nodeType, std::string tableName);
std::string getTableNameFromNodeType(const std::string &nodeType);
void storeTableColumnNames(std::vector<std::string> input);
std::vector<std::string> getTableColumnNames(const std::string &tableName);
int getTableColIndex(const std::string &tableName,
const std::string &colName);
bool storeRootVolume(const unsigned int &id, const std::string &nodeType);
std::string m_dbpath;
bool m_dbIsOK;
bool m_debug;
// verbosity level
int m_verbose;
std::unordered_map<std::string, std::vector<std::string>>
m_tableNames; /// stores the column names for each table
std::unordered_map<std::string, std::string> m_childType_tableName;
std::vector<std::string>
m_cache_tables; /// cache for the list of tables in the DB
std::unordered_map<unsigned int, std::string>
m_cache_tableId_tableName; /// cache for tableID-->tableName
std::unordered_map<unsigned int, std::string>
m_cache_tableId_nodeType; /// cache for tableID-->nodeType
std::unordered_map<std::string, std::string>
m_cache_nodeType_tableName; /// cache for nodeType-->tableName
std::unordered_map<std::string, unsigned int>
m_cache_nodeType_tableID; /// cache for nodeType-->tableID
protected:
class Imp;
Imp *m_d;
};
#endif // GMDBManager_H
#endif // GMDBManager_H
GeoModelIO/GeoModelDBManager/src/GMDBManager.cpp
+ 1391
− 1261
View file @ 85a2a382
This diff is collapsed.
GeoModelIO/GeoModelRead/GeoModelRead/ReadGeoModel.h
+ 241
− 213
View file @ 85a2a382
This diff is collapsed.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment