#include <postgresql_database.h>
Classes | |
| class | PGresultAutoPtr |
Public Member Functions | |
| template<typename T > | |
| bool | countList (int &count, const FilterClause clause=FilterClause()) const |
| templated implementation of count list that works on filter clauses. | |
| bool | countList (const DBClass *example, int &count, std::string where_clause) const |
| Counts the number of instances of a certain type in the database. | |
| bool | deleteFromDatabase (DBClass *instance) |
| Deletes an instance of a DBClass from the database. | |
| template<class T > | |
| bool | getList (std::vector< boost::shared_ptr< T > > &vec, const T &example, const FilterClause clause) const |
| template<class T > | |
| bool | getList (std::vector< boost::shared_ptr< T > > &vec, const T &example) const |
| template<class T > | |
| bool | getList (std::vector< boost::shared_ptr< T > > &vec, std::string where_clause) const |
| template<class T > | |
| bool | getList (std::vector< boost::shared_ptr< T > > &vec, const FilterClause clause) const |
| template<class T > | |
| bool | getList (std::vector< boost::shared_ptr< T > > &vec) const |
| bool | insertIntoDatabase (DBClass *instance) |
| Inserts a new instance of a DBClass into the database. | |
| bool | isConnected () const |
| Returns true if the interface is connected to the database and ready to go. | |
| bool | loadFromDatabase (DBFieldBase *field) const |
| Reads the value of one particular fields of a DBClass from the database. | |
| PostgresqlDatabase (const PostgresqlDatabaseConfig &config) | |
| Attempts to connect to the specified database. | |
| PostgresqlDatabase (std::string host, std::string port, std::string user, std::string password, std::string dbname) | |
| Attempts to connect to the specified database. | |
| bool | saveToDatabase (const DBFieldBase *field) |
| Writes the value of one particular field of a DBClass to the database. | |
| ~PostgresqlDatabase () | |
| Closes the connection to the database. | |
Protected Member Functions | |
| bool | begin () |
| Isses the "begin" command to the database. | |
| bool | commit () |
| Issues the "commit" command to the database. | |
| bool | deleteFromTable (std::string table_name, const DBFieldBase *key_field) |
| Helper function that deletes a row from a table based on the value of the specified field. | |
| template<class T > | |
| bool | getList (std::vector< boost::shared_ptr< T > > &vec, const T &example, std::string where_clause) const |
| Retreives the list of objects of a certain type from the database. | |
| bool | getListRawResult (const DBClass *example, std::vector< const DBFieldBase * > &fields, std::vector< int > &column_ids, std::string where_clause, boost::shared_ptr< PGresultAutoPtr > &result, int &num_tuples) const |
| Helper function for getList, separates SQL from (templated) instantiation. | |
| bool | getSequence (std::string name, std::string &value) |
| Returns the 'currval' for the database sequence identified by name. | |
| bool | getVariable (std::string name, std::string &value) const |
| Gets the text value of a given variable. | |
| bool | insertIntoTable (std::string table_name, const std::vector< const DBFieldBase * > &fields) |
| Helper function for inserting an instance into the database. | |
| void | pgMDBconstruct (std::string host, std::string port, std::string user, std::string password, std::string dbname) |
| bool | populateListEntry (DBClass *entry, boost::shared_ptr< PGresultAutoPtr > result, int row_num, const std::vector< const DBFieldBase * > &fields, const std::vector< int > &column_ids) const |
| Helper function for getList, separates SQL from (templated) instantiation. | |
| bool | rollback () |
| Issues the "rollback" command to the database. | |
Protected Attributes | |
| PGconn * | connection_ |
| The PostgreSQL database connection we are using. | |
| bool | in_transaction_ |
Definition at line 90 of file postgresql_database.h.
| database_interface::PostgresqlDatabase::PostgresqlDatabase | ( | std::string | host, | |
| std::string | port, | |||
| std::string | user, | |||
| std::string | password, | |||
| std::string | dbname | |||
| ) |
Attempts to connect to the specified database.
Definition at line 75 of file postgresql_database.cpp.
| database_interface::PostgresqlDatabase::PostgresqlDatabase | ( | const PostgresqlDatabaseConfig & | config | ) |
Attempts to connect to the specified database.
Definition at line 68 of file postgresql_database.cpp.
| database_interface::PostgresqlDatabase::~PostgresqlDatabase | ( | ) |
Closes the connection to the database.
Definition at line 82 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::begin | ( | ) | [protected] |
Isses the "begin" command to the database.
Returns true if the begin query itself succeeds, false if it does not
Definition at line 107 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::commit | ( | ) | [protected] |
Issues the "commit" command to the database.
Returns true if the commit query itself succeeds, false if it does not
Definition at line 122 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::countList | ( | int & | count, | |
| const FilterClause | clause = FilterClause() | |||
| ) | const [inline] |
templated implementation of count list that works on filter clauses.
Definition at line 194 of file postgresql_database.h.
| bool database_interface::PostgresqlDatabase::countList | ( | const DBClass * | example, | |
| int & | count, | |||
| std::string | where_clause | |||
| ) | const |
Counts the number of instances of a certain type in the database.
The example is used *only* to indicate instances of what class we are counting. To perform additional pruning, the where_clause is used. In the future, we might use the example to do actual decisions on counting based on the contents of the fields.
The counting is performed only on the primary key of the given class.
Definition at line 321 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::deleteFromDatabase | ( | DBClass * | instance | ) |
Deletes an instance of a DBClass from the database.
It removes the entry from the table that holds our primary key, but also from other tables that might hold our fields. Those tables have to be removed first.
Definition at line 787 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::deleteFromTable | ( | std::string | table_name, | |
| const DBFieldBase * | key_field | |||
| ) | [protected] |
Helper function that deletes a row from a table based on the value of the specified field.
Deletes a row from a table based on the value of the specified field
Definition at line 765 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::getList | ( | std::vector< boost::shared_ptr< T > > & | vec, | |
| const T & | example, | |||
| const FilterClause | clause | |||
| ) | const [inline] |
Definition at line 184 of file postgresql_database.h.
| bool database_interface::PostgresqlDatabase::getList | ( | std::vector< boost::shared_ptr< T > > & | vec, | |
| const T & | example | |||
| ) | const [inline] |
Definition at line 179 of file postgresql_database.h.
| bool database_interface::PostgresqlDatabase::getList | ( | std::vector< boost::shared_ptr< T > > & | vec, | |
| std::string | where_clause | |||
| ) | const [inline] |
Definition at line 171 of file postgresql_database.h.
| bool database_interface::PostgresqlDatabase::getList | ( | std::vector< boost::shared_ptr< T > > & | vec, | |
| const FilterClause | clause | |||
| ) | const [inline] |
Definition at line 165 of file postgresql_database.h.
| bool database_interface::PostgresqlDatabase::getList | ( | std::vector< boost::shared_ptr< T > > & | vec | ) | const [inline] |
Definition at line 159 of file postgresql_database.h.
| bool database_interface::PostgresqlDatabase::getList | ( | std::vector< boost::shared_ptr< T > > & | vec, | |
| const T & | example, | |||
| std::string | where_clause | |||
| ) | const [inline, protected] |
Retreives the list of objects of a certain type from the database.
The datatype T is expected to be derived from DBClass.
The example is used only to decide which fields should be retrieved from the database. Note that the primary key field is ALWAYS retrieved; you can expect the returned list to have the primary key set. Any other fields are retrieved ONLY if they are marked with syncFromDatabase in the example.
Note that the example is not used to decide which instanced to retrieve (but only which fields* of the instances). To retrieve only certain fields, you must use the where_clause. This is not ideal, as much functionality is hidden from the user who is not exposed to SQL syntax. For those functions where the external user needs the where_clause (even if he does not know it) we are currently providing public wrappers, but that might change in the future.
The significant difference between this function and the version that reads a certain field is that this function creates new instances of the DBClass and gives them the right values of the primary key. The function that reads a certain field expects the instance of DBClass to already exist, and its primary key field to be set correctly already.
Definition at line 235 of file postgresql_database.h.
| bool database_interface::PostgresqlDatabase::getListRawResult | ( | const DBClass * | example, | |
| std::vector< const DBFieldBase * > & | fields, | |||
| std::vector< int > & | column_ids, | |||
| std::string | where_clause, | |||
| boost::shared_ptr< PGresultAutoPtr > & | result, | |||
| int & | num_tuples | |||
| ) | const [protected] |
Helper function for getList, separates SQL from (templated) instantiation.
Creates and runs the SQL query for retrieveing the list. Has been separated from the rest of the getList function so that we can have only the part that instantiates the entries separated from the parts that speak SQL, so that we don't have to have SQL in the header of the PostgresqlDatabase class.
See the general getList(...) documentation for more details. This function will run the query, return its raw result, and populate the fields and columns_ids vectors with the fields that were retrieved and the columns in the result that they correspond to.
Definition at line 183 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::getSequence | ( | std::string | name, | |
| std::string & | value | |||
| ) | [protected] |
Returns the 'currval' for the database sequence identified by name.
The value is returned as a string; caller has to convert it. Returns false if the query fails or the sequence is not found.
Definition at line 155 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::getVariable | ( | std::string | name, | |
| std::string & | value | |||
| ) | const [protected] |
Gets the text value of a given variable.
Definition at line 134 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::insertIntoDatabase | ( | DBClass * | instance | ) |
Inserts a new instance of a DBClass into the database.
Inserts only the fields marked with writeToDatabase.
The primary key must either be inserted specifically (and thus marked with writeToDatabase) or have a default value associated with a sequence. In the latter case, the value is retrieved after insertion, and set to the primary key field of the instance.
Definition at line 640 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::insertIntoTable | ( | std::string | table_name, | |
| const std::vector< const DBFieldBase * > & | fields | |||
| ) | [protected] |
Helper function for inserting an instance into the database.
Inserts into the database the fields of an instance that go into a single table.
If that table is the table of the primary key, everything is inserted normally.
If not, the *first* entry in the vector of fields is expected to be the primary key, with the value already set correctly. The table that we are inserting in is expected to have a foreign key that references the primary key field of our class.
Definition at line 534 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::isConnected | ( | ) | const |
Returns true if the interface is connected to the database and ready to go.
Definition at line 87 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::loadFromDatabase | ( | DBFieldBase * | field | ) | const |
Reads the value of one particular fields of a DBClass from the database.
The instance of DBClass that this implicitly refers to is the *owner* of the field that is passed in. If the field that is passed in is not in the same table as the primary key, tables are joined based on the primary key which is assumed to be the foreign key in the changed field's table.
Definition at line 445 of file postgresql_database.cpp.
| void database_interface::PostgresqlDatabase::pgMDBconstruct | ( | std::string | host, | |
| std::string | port, | |||
| std::string | user, | |||
| std::string | password, | |||
| std::string | dbname | |||
| ) | [protected] |
Definition at line 56 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::populateListEntry | ( | DBClass * | entry, | |
| boost::shared_ptr< PGresultAutoPtr > | result, | |||
| int | row_num, | |||
| const std::vector< const DBFieldBase * > & | fields, | |||
| const std::vector< int > & | column_ids | |||
| ) | const [protected] |
Helper function for getList, separates SQL from (templated) instantiation.
Parses a single, already instantiated entry (an instance of DBClass) from a raw database result, given the list of fields that were retrieved and their respective column ids in the result. Helper function for getList(...)
Definition at line 291 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::rollback | ( | ) | [protected] |
Issues the "rollback" command to the database.
Returns true if the rollback query itself succeeds, false if it does not
Definition at line 94 of file postgresql_database.cpp.
| bool database_interface::PostgresqlDatabase::saveToDatabase | ( | const DBFieldBase * | field | ) |
Writes the value of one particular field of a DBClass to the database.
The instance of DBClass that this implicitly refers to is the *owner* of the field that is passed in. If the field that is passed in is not in the same table as the primary key, tables are joined based on the primary key.
TODO: fix this so that we don't always have to join on the primary key.
Definition at line 355 of file postgresql_database.cpp.
The PostgreSQL database connection we are using.
Definition at line 97 of file postgresql_database.h.
bool database_interface::PostgresqlDatabase::in_transaction_ [protected] |
Definition at line 100 of file postgresql_database.h.
