/usr/include/dballe/db/mem/db.h is in libdballe-dev 6.8-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 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | /*
* dballe/mem/db - Archive for point-based meteorological data, in-memory db
*
* Copyright (C) 2013 ARPA-SIM <urpsim@smr.arpa.emr.it>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* Author: Enrico Zini <enrico@enricozini.com>
*/
#ifndef DBA_DB_MEM_H
#define DBA_DB_MEM_H
#include <dballe/db/db.h>
#include <dballe/db/mem/repinfo.h>
#include <dballe/memdb/memdb.h>
#include <wreport/varinfo.h>
#include <string>
#include <vector>
#include <memory>
/** @file
* @ingroup db
*
* Functions used to connect to DB-All.e and insert, query and delete data.
*/
namespace dballe {
struct Record;
struct Msg;
struct Msgs;
struct MsgConsumer;
namespace db {
namespace mem {
/**
* DB-ALLe database connection
*/
class DB : public dballe::DB
{
public:
/// In-memory database backend
Memdb memdb;
Repinfo repinfo;
protected:
std::string serialization_dir;
size_t m_last_station_id;
/// Store information about the database ID of a variable
struct VarID
{
wreport::Varcode code;
// True if it is a station value
bool station;
size_t id;
VarID(wreport::Varcode code, bool station, size_t id) : code(code), station(station), id(id) {}
};
/// Store database variable IDs for all last inserted variables
std::vector<VarID> last_insert_varids;
/// Query stations, returning a list of station IDs
void raw_query_stations(const Record& rec, memdb::Results<memdb::Station>& res);
/// Query station data, returning a list of Value IDs
void raw_query_station_data(const Record& rec, memdb::Results<memdb::StationValue>& res);
/// Query data, returning a list of Value IDs
void raw_query_data(const Record& rec, memdb::Results<memdb::Value>& res);
public:
DB();
DB(const std::string& arg);
virtual ~DB();
db::Format format() const { return MEM; }
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);
/**
* 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();
/**
* Insert a record into the database
*
* In a record with the same phisical situation already exists, the function
* fails.
*
* @param rec
* The record to insert.
* @param can_replace
* If true, then existing data can be rewritten, else data can only be added.
* @param station_can_add
* If true, then it is allowed to add new station records to the database.
* Otherwise, data can be added only by reusing existing ones.
*/
void insert(const Record& rec, bool can_replace, bool station_can_add);
int last_station_id() const;
/**
* Remove data from the database
*
* @param rec
* The record with the query data (see technical specifications, par. 1.6.4
* "parameter output/input") to select the items to be deleted
*/
void remove(const Record& rec);
void remove_all();
/**
* 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();
/**
* Start a query on the station archive
*
* @param query
* The record with the query data (see @ref dba_record_keywords)
* @return
* The cursor to use to iterate over the results
*/
std::auto_ptr<db::Cursor> query_stations(const Record& query);
/**
* Query the database.
*
* When multiple values per variable are present, the results will be presented
* in increasing order of priority.
*
* @param query
* The record with the query data (see technical specifications, par. 1.6.4
* "parameter output/input")
* @return
* The cursor to use to iterate over the results
*/
std::auto_ptr<db::Cursor> query_data(const Record& rec);
std::auto_ptr<db::Cursor> query_summary(const Record& rec);
/**
* Query attributes
*
* @param id_data
* The database id of the data related to the attributes to retrieve
* @param id_var
* The varcode of the variable related to the attributes to retrieve. See @ref vartable.h (ignored)
* @param qcs
* The WMO codes of the QC values requested. If it is empty, then all values
* are returned.
* @param attrs
* The Record that will hold the resulting attributes
* @return
* Number of attributes returned in attrs
*/
unsigned query_attrs(int id_data, wreport::Varcode id_var, const db::AttrList& qcs, Record& attrs);
void attr_insert(wreport::Varcode id_var, const Record& attrs);
void attr_insert(int id_data, wreport::Varcode id_var, const Record& attrs);
/**
* Delete QC data for the variable `var' in record `rec' (coming from a previous
* dba_query)
*
* @param id_data
* The database id of the lev_tr related to the attributes to remove
* @param id_var
* The varcode of the variable related to the attributes to remove. See @ref vartable.h (ignored)
* @param qcs
* Array of WMO codes of the attributes to delete. If empty, all attributes
* associated to id_data will be deleted.
*/
void attr_remove(int id_data, wreport::Varcode id_var, const db::AttrList& qcs);
/**
* Import a Msg message into the DB-All.e database
*
* @param db
* The DB-All.e database to write the data into
* @param msg
* The Msg containing the data to import
* @param repmemo
* Report mnemonic to which imported data belong. If NULL is passed, then it
* will be chosen automatically based on the message type.
* @param flags
* Customise different aspects of the import process. It is a bitmask of the
* various DBA_IMPORT_* macros.
*/
void import_msg(const Msg& msg, const char* repmemo, int flags);
/**
* Perform the query in `query', and return the results as a NULL-terminated
* array of dba_msg.
*
* @param query
* The query to perform
* @param cons
* The MsgsConsumer that will handle the resulting messages
*/
void export_msgs(const Record& query, MsgConsumer& cons);
/**
* Dump the entire contents of the database to an output stream
*/
void dump(FILE* out);
friend class dballe::DB;
};
} // namespace v6
} // namespace db
} // namespace dballe
/* vim:set ts=4 sw=4: */
#endif
|