libdballe  7.7
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes | Friends
dballe::db::v6::DB Class Reference

DB-ALLe database connection. More...

#include <db.h>

Inheritance diagram for dballe::db::v6::DB:
dballe::DB

Public Member Functions

db::Format format () const
 Return the format of this DB.
 
sql::Driverdriver ()
 Access the backend DB driver.
 
sql::Repinforepinfo ()
 Access the repinfo table.
 
sql::Stationstation ()
 Access the station table.
 
sql::LevTrlev_tr ()
 Access the lev_tr table.
 
sql::LevTrCachelev_tr_cache ()
 Access the lev_tr cache.
 
sql::DataV6data ()
 Access the data table.
 
sql::AttrV6attr ()
 Access the data table.
 
void disappear ()
 Remove all our traces from the database, if applicable. More...
 
void reset (const char *repinfo_file=0)
 Reset the database, removing all existing DBALLE tables and re-creating them empty. More...
 
void delete_tables ()
 Delete all the DB-ALLe tables from the database.
 
void update_repinfo (const char *repinfo_file, int *added, int *deleted, int *updated)
 Update the repinfo table in the database, with the data found in the given file. More...
 
std::map< std::string, int > get_repinfo_priorities ()
 Get a mapping between rep_memo and their priorities.
 
int rep_cod_from_memo (const char *memo)
 Get the report code from a report mnemonic.
 
void insert_station_data (StationValues &vals, bool can_replace, bool station_can_add) override
 Insert station values into the database. More...
 
void insert_data (DataValues &vals, bool can_replace, bool station_can_add) override
 Insert data values into the database. More...
 
void remove_station_data (const Query &query) override
 Remove data from the database. More...
 
void remove (const Query &query)
 Remove data from the database. More...
 
void remove_all ()
 Remove all data from the database. More...
 
void vacuum ()
 Remove orphan values from the database. More...
 
std::unique_ptr< db::CursorStationquery_stations (const Query &query)
 Start a query on the station variables archive. More...
 
std::unique_ptr< db::CursorStationDataquery_station_data (const Query &query) override
 Query the station variables in the database. More...
 
std::unique_ptr< db::CursorDataquery_data (const Query &query)
 Query the database. More...
 
std::unique_ptr< db::CursorSummaryquery_summary (const Query &query)
 Query a summary of what the result would be for a query. More...
 
void attr_query_station (int data_id, std::function< void(std::unique_ptr< wreport::Var >)> &&dest) override
 Query attributes on a station value. More...
 
void attr_query_data (int data_id, std::function< void(std::unique_ptr< wreport::Var >)> &&dest) override
 Query attributes on a data value. More...
 
void attr_insert_station (int data_id, const Values &attrs) override
 Insert new attributes on a station value. More...
 
void attr_insert_data (int data_id, const Values &attrs) override
 Insert new attributes on a data value. More...
 
void attr_remove_station (int data_id, const db::AttrList &qcs) override
 Delete attributes from a station value. More...
 
void attr_remove_data (int data_id, const db::AttrList &qcs) override
 Delete attributes from a data value. More...
 
bool is_station_variable (int data_id, wreport::Varcode varcode) override
 Check if this varcode and data_id correspond to a station variable. More...
 
void import_msg (const Message &msg, const char *repmemo, int flags) override
 Import a Message into the DB-All.e database. More...
 
bool export_msgs (const Query &query, std::function< bool(std::unique_ptr< Message > &&)> dest) override
 Perform the query in `query', and send the results to dest. More...
 
void dump (FILE *out)
 Dump the entire contents of the database to an output stream.
 
- Public Member Functions inherited from dballe::DB
virtual void import_msgs (const Messages &msgs, const char *repmemo, int flags)
 Import Messages into the DB-All.e database. More...
 

Data Fields

db::Connectionconn
 Database connection.
 
Trace trace
 Database query tracing.
 
bool explain_queries = false
 True if we print an EXPLAIN trace of all queries to stderr.
 

Protected Member Functions

void init_after_connect ()
 
 DB (std::unique_ptr< Connection > conn)
 
int obtain_station (const Station &st, bool can_add=true)
 

Protected Attributes

sql::Driverm_driver
 SQL driver backend.
 
struct sql::Repinfom_repinfo
 Accessors for the various parts of the database. More...
 
struct sql::Stationm_station
 Station information.
 
struct sql::LevTrm_lev_tr
 Level/timerange information.
 
struct sql::LevTrCachem_lev_tr_cache
 Level/timerange cache.
 
struct sql::DataV6m_data
 Variable data.
 
struct sql::AttrV6m_attr
 Variable attributes.
 

Friends

class dballe::DB
 

Additional Inherited Members

- Static Public Member Functions inherited from dballe::DB
static db::Format get_default_format ()
 
static void set_default_format (db::Format format)
 
static std::unique_ptr< DBconnect (const char *dsn, const char *user, const char *password)
 Start a session with DB-All.e. More...
 
static std::unique_ptr< DBconnect_from_file (const char *pathname)
 Create from a SQLite file pathname. More...
 
static std::unique_ptr< DBconnect_from_url (const char *url)
 Create from an url-like specification, that can be: More...
 
static std::unique_ptr< DBconnect_memory (const std::string &arg=std::string())
 Create an in-memory database.
 
static std::unique_ptr< DBconnect_test ()
 Start a test session with DB-All.e. More...
 
static std::unique_ptr< DBcreate (std::unique_ptr< db::Connection > conn)
 Create a database from an open Connection.
 
static bool is_url (const char *str)
 Return TRUE if the string looks like a DB URL. More...
 
static const char * default_repinfo_file ()
 Return the default repinfo file pathname.
 

Detailed Description

DB-ALLe database connection.

Member Function Documentation

void dballe::db::v6::DB::attr_insert_data ( int  data_id,
const Values attrs 
)
overridevirtual

Insert new attributes on a data value.

Parameters
data_idThe id (returned by Cursor::attr_reference_id()) used to refer to the value
attrsThe attributes to be added

Implements dballe::DB.

void dballe::db::v6::DB::attr_insert_station ( int  data_id,
const Values attrs 
)
overridevirtual

Insert new attributes on a station value.

Parameters
data_idThe id (returned by Cursor::attr_reference_id()) used to refer to the value
attrsThe attributes to be added

Implements dballe::DB.

void dballe::db::v6::DB::attr_query_data ( int  data_id,
std::function< void(std::unique_ptr< wreport::Var >)> &&  dest 
)
overridevirtual

Query attributes on a data value.

Parameters
data_idThe id (returned by Cursor::attr_reference_id()) used to refer to the value
destThe function that will be called on each resulting attribute

Implements dballe::DB.

void dballe::db::v6::DB::attr_query_station ( int  data_id,
std::function< void(std::unique_ptr< wreport::Var >)> &&  dest 
)
overridevirtual

Query attributes on a station value.

Parameters
data_idThe id (returned by Cursor::attr_reference_id()) used to refer to the value
destThe function that will be called on each resulting attribute

Implements dballe::DB.

void dballe::db::v6::DB::attr_remove_data ( int  data_id,
const db::AttrList qcs 
)
overridevirtual

Delete attributes from a data value.

Parameters
data_idThe id (returned by Cursor::attr_reference_id()) used to refer to the value
qcsArray of WMO codes of the attributes to delete. If empty, all attributes associated to the value will be deleted.

Implements dballe::DB.

void dballe::db::v6::DB::attr_remove_station ( int  data_id,
const db::AttrList qcs 
)
overridevirtual

Delete attributes from a station value.

Parameters
data_idThe id (returned by Cursor::attr_reference_id()) used to refer to the value
qcsArray of WMO codes of the attributes to delete. If empty, all attributes associated to the value will be deleted.

Implements dballe::DB.

void dballe::db::v6::DB::disappear ( )
virtual

Remove all our traces from the database, if applicable.

After this has been called, all other DB methods except for reset() will fail.

Implements dballe::DB.

bool dballe::db::v6::DB::export_msgs ( const Query query,
std::function< bool(std::unique_ptr< Message > &&)>  dest 
)
overridevirtual

Perform the query in `query', and send the results to dest.

Return false from dest to interrupt the query.

Parameters
queryThe query to perform
destThe function that will handle the resulting messages
Returns
true if the query reached its end, false if it got interrupted because dest returned false.

Implements dballe::DB.

void dballe::db::v6::DB::import_msg ( const Message msg,
const char *  repmemo,
int  flags 
)
overridevirtual

Import a Message into the DB-All.e database.

Parameters
dbThe DB-All.e database to write the data into
msgThe Message containing the data to import
repmemoReport mnemonic to which imported data belong. If NULL is passed, then it will be chosen automatically based on the message type.
flagsCustomise different aspects of the import process. It is a bitmask of the various DBA_IMPORT_* macros.

Implements dballe::DB.

void dballe::db::v6::DB::insert_data ( DataValues vals,
bool  can_replace,
bool  station_can_add 
)
overridevirtual

Insert data values into the database.

The IDs of the station andl all variables that were inserted will be stored in vals.

Parameters
valsThe values to insert.
can_replaceIf true, then existing data can be rewritten, else data can only be added.
station_can_addIf false, it will not create a missing station record, and only data for existing stations can be added. If true, then if we are inserting data for a station that does not yet exists in the database, it will be created.

Implements dballe::DB.

void dballe::db::v6::DB::insert_station_data ( StationValues vals,
bool  can_replace,
bool  station_can_add 
)
overridevirtual

Insert station values into the database.

The IDs of the station andl all variables that were inserted will be stored in vals.

Parameters
valsThe values to insert.
can_replaceIf true, then existing data can be rewritten, else data can only be added.
station_can_addIf false, it will not create a missing station record, and only data for existing stations can be added. If true, then if we are inserting data for a station that does not yet exists in the database, it will be created.

Implements dballe::DB.

bool dballe::db::v6::DB::is_station_variable ( int  data_id,
wreport::Varcode  varcode 
)
overridevirtual

Check if this varcode and data_id correspond to a station variable.

This is used only to implement attr_* functions to be used when this information is not known. A database for which this information is not relevant (for example, in v6 databases there is a single ID space for station and data variable) can return any arbitrary value, since later they will be ignored.

This should disappear once client APIs start making a distinction between attributes in station variables and attributes on data variables.

Implements dballe::DB.

std::unique_ptr<db::CursorData> dballe::db::v6::DB::query_data ( const Query query)
virtual

Query the database.

When multiple values per variable are present, the results will be presented in increasing order of priority.

Parameters
queryThe record with the query data (see technical specifications, par. 1.6.4 "parameter output/input")
Returns
The cursor to use to iterate over the results

Implements dballe::DB.

std::unique_ptr<db::CursorStationData> dballe::db::v6::DB::query_station_data ( const Query query)
overridevirtual

Query the station variables in the database.

When multiple values per variable are present, the results will be presented in increasing order of priority.

Parameters
queryThe record with the query data (see technical specifications, par. 1.6.4 "parameter output/input")
Returns
The cursor to use to iterate over the results

Implements dballe::DB.

std::unique_ptr<db::CursorStation> dballe::db::v6::DB::query_stations ( const Query query)
virtual

Start a query on the station variables archive.

The cursor will iterate over unique lat, lon, ident triples, and will contain all station vars. If a station var exists twice on two different networks, only one will be present: the one of the network with the highest priority.

Parameters
queryThe record with the query data (see Keywords used by dba_record)
Returns
The cursor to use to iterate over the results

Implements dballe::DB.

std::unique_ptr<db::CursorSummary> dballe::db::v6::DB::query_summary ( const Query query)
virtual

Query a summary of what the result would be for a query.

Parameters
queryThe record with the query data (see technical specifications, par. 1.6.4 "parameter output/input")
Returns
The cursor to use to iterate over the results. The results are the same as query_data, except that no context_id, datetime and value are provided, so it only gives all the available combinations of data contexts.

Implements dballe::DB.

void dballe::db::v6::DB::remove ( const Query rec)
virtual

Remove data from the database.

Parameters
recThe record with the query data (see technical specifications, par. 1.6.4 "parameter output/input") to select the items to be deleted

Implements dballe::DB.

void dballe::db::v6::DB::remove_all ( )
virtual

Remove all data from the database.

This is faster than remove() with an empty record, and unlike reset() it preserves existing report information.

Implements dballe::DB.

void dballe::db::v6::DB::remove_station_data ( const Query query)
overridevirtual

Remove data from the database.

Parameters
recThe record with the query data (see technical specifications, par. 1.6.4 "parameter output/input") to select the items to be deleted

Implements dballe::DB.

void dballe::db::v6::DB::reset ( const char *  repinfo_file = 0)
virtual

Reset the database, removing all existing DBALLE tables and re-creating them empty.

Parameters
repinfo_fileThe 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.

Implements dballe::DB.

void dballe::db::v6::DB::update_repinfo ( const char *  repinfo_file,
int *  added,
int *  deleted,
int *  updated 
)
virtual

Update the repinfo table in the database, with the data found in the given file.

Parameters
repinfo_fileThe 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.
Return values
addedThe number of repinfo entryes that have been added
deletedThe number of repinfo entryes that have been deleted
updatedThe number of repinfo entryes that have been updated

Implements dballe::DB.

void dballe::db::v6::DB::vacuum ( )
virtual

Remove orphan values from the database.

Orphan values are currently:

  • lev_tr values for which no data exists
  • station values for which no lev_tr exists

Depending on database size, this routine can take a few minutes to execute.

Implements dballe::DB.

Field Documentation

struct sql::Repinfo* dballe::db::v6::DB::m_repinfo
protected

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_* functionsReport information

The documentation for this class was generated from the following file: