/usr/include/dballe/db/v6/db.h is in libdballe-dev 7.21-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | #ifndef DBA_DB_V6_H
#define DBA_DB_V6_H
#include <dballe/db/db.h>
#include <dballe/db/trace.h>
#include <wreport/varinfo.h>
#include <string>
#include <vector>
#include <memory>
namespace dballe {
struct Station;
struct StationValues;
struct DataValues;
namespace sql {
struct Connection;
struct Statement;
struct Sequence;
}
namespace db {
namespace v6 {
struct Driver;
struct Repinfo;
struct Station;
struct LevTr;
struct LevTrCache;
struct DataV6;
struct AttrV6;
}
namespace v6 {
/**
* DB-ALLe database connection, database format V6
*/
class DB : public dballe::DB
{
public:
/// Database connection
dballe::sql::Connection* conn;
/// Database query tracing
Trace trace;
/// True if we print an EXPLAIN trace of all queries to stderr
bool explain_queries = false;
protected:
/// SQL driver backend
v6::Driver* m_driver;
/**
* Accessors for the various parts of the database.
*
* @warning Before using these 5 pointers, ensure they are initialised
* using one of the dba_db_need_* functions
* @{
*/
/** Report information */
struct v6::Repinfo* m_repinfo;
/** Station information */
struct v6::Station* m_station;
/** Level/timerange information */
struct v6::LevTr* m_lev_tr;
/// Level/timerange cache
struct v6::LevTrCache* m_lev_tr_cache;
/** Variable data */
struct v6::DataV6* m_data;
/** Variable attributes */
struct v6::AttrV6* m_attr;
/** @} */
void init_after_connect();
DB(std::unique_ptr<dballe::sql::Connection> conn);
/*
* Lookup, insert or replace data in station taking the values from
* rec.
*
* If rec did not contain ana_id, it will be set by this function.
*
* @param rec
* The record with the station information
* @param can_add
* If true we can insert new stations in the database, if false we
* only look up existing records and raise an exception if missing
* @returns
* The station ID
*/
int obtain_station(const dballe::Station& st, bool can_add=true);
public:
virtual ~DB();
db::Format format() const { return V6; }
/// Access the backend DB driver
v6::Driver& driver();
/// Access the repinfo table
v6::Repinfo& repinfo();
/// Access the station table
v6::Station& station();
/// Access the lev_tr table
v6::LevTr& lev_tr();
/// Access the lev_tr cache
v6::LevTrCache& lev_tr_cache();
/// Access the data table
v6::DataV6& data();
/// Access the data table
v6::AttrV6& attr();
std::unique_ptr<dballe::Transaction> transaction() override;
void disappear();
/**
* Reset the database, removing all existing DBALLE tables and re-creating them
* empty.
*
* @param repinfo_file
* The name of the CSV file with the report type information data to load.
* The file is in CSV format with 6 columns: report code, mnemonic id,
* description, priority, descriptor, table A category.
* If repinfo_file is NULL, then the default of /etc/dballe/repinfo.csv is
* used.
*/
void reset(const char* repinfo_file = 0);
/**
* Delete all the DB-ALLe tables from the database.
*/
void delete_tables();
/**
* Update the repinfo table in the database, with the data found in the given
* file.
*
* @param repinfo_file
* The name of the CSV file with the report type information data to load.
* The file is in CSV format with 6 columns: report code, mnemonic id,
* description, priority, descriptor, table A category.
* If repinfo_file is NULL, then the default of /etc/dballe/repinfo.csv is
* used.
* @retval added
* The number of repinfo entryes that have been added
* @retval deleted
* The number of repinfo entryes that have been deleted
* @retval updated
* The number of repinfo entryes that have been updated
*/
void update_repinfo(const char* repinfo_file, int* added, int* deleted, int* updated);
std::map<std::string, int> get_repinfo_priorities();
/**
* Get the report code from a report mnemonic
*/
int rep_cod_from_memo(const char* memo);
void insert_station_data(dballe::Transaction& transaction, StationValues& vals, bool can_replace, bool station_can_add) override;
void insert_data(dballe::Transaction& transaction, DataValues& vals, bool can_replace, bool station_can_add) override;
void remove_station_data(dballe::Transaction& transaction, const Query& query) override;
void remove(dballe::Transaction& transaction, const Query& query);
void remove_all(dballe::Transaction& transaction);
/**
* Remove orphan values from the database.
*
* Orphan values are currently:
* \li lev_tr values for which no data exists
* \li station values for which no lev_tr exists
*
* Depending on database size, this routine can take a few minutes to execute.
*/
void vacuum();
std::unique_ptr<db::CursorStation> query_stations(const Query& query);
std::unique_ptr<db::CursorStationData> query_station_data(const Query& query) override;
std::unique_ptr<db::CursorData> query_data(const Query& query);
std::unique_ptr<db::CursorSummary> query_summary(const Query& query);
void attr_query_station(int data_id, std::function<void(std::unique_ptr<wreport::Var>)>&& dest) override;
void attr_query_data(int data_id, std::function<void(std::unique_ptr<wreport::Var>)>&& dest) override;
void attr_insert_station(dballe::Transaction& transaction, int data_id, const Values& attrs) override;
void attr_insert_data(dballe::Transaction& transaction, int data_id, const Values& attrs) override;
void attr_remove_station(dballe::Transaction& transaction, int data_id, const db::AttrList& qcs) override;
void attr_remove_data(dballe::Transaction& transaction, int data_id, const db::AttrList& qcs) override;
bool is_station_variable(int data_id, wreport::Varcode varcode) override;
void import_msg(dballe::Transaction& transaction, const Message& msg, const char* repmemo, int flags) override;
bool export_msgs(dballe::Transaction& transaction, const Query& query, std::function<bool(std::unique_ptr<Message>&&)> dest) override;
/**
* Dump the entire contents of the database to an output stream
*/
void dump(FILE* out);
friend class dballe::DB;
};
}
}
}
#endif
|