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

DB-ALLe database connection. More...

#include <db.h>

Inheritance diagram for dballe::db::v5::DB:
dballe::DB

Public Member Functions

db::Format format () const
 Return the format of this DB.
 
Repinforepinfo ()
 Access the repinfo table.
 
Stationstation ()
 Access the station table.
 
Contextcontext ()
 Access the context table.
 
Datadata ()
 Access the data table.
 
Attrattr ()
 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...
 
virtual 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.
 
bool check_rep_cod (int rep_cod)
 Verify that a rep_cod is supported by the database. More...
 
int last_station_insert_id ()
 Return the ID of the last inserted station.
 
int last_context_insert_id ()
 Return the ID of the last inserted context.
 
int get_rep_cod (const Record &rec)
 Get the report id from this record. More...
 
int obtain_station (const Record &rec, bool can_add=true)
 
int obtain_context (const Record &rec)
 
void insert (const Record &rec, bool can_replace, bool station_can_add)
 Insert a record into the database. More...
 
int last_station_id () const
 Return the station id for the last data that was inserted.
 
void remove (const Record &rec)
 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::auto_ptr< db::Cursorquery (const Record &query, unsigned int wanted, unsigned int modifiers)
 Create and execute a database query. More...
 
std::auto_ptr< db::Cursorquery_stations (const Record &query)
 Start a query on the station variables archive. More...
 
std::auto_ptr< db::Cursorquery_data (const Record &rec)
 Query the database. More...
 
virtual std::auto_ptr< db::Cursorquery_summary (const Record &rec)
 Query a summary of what the result would be for a query. More...
 
void query_datetime_extremes (const Record &query, Record &result)
 
unsigned query_attrs (int reference_id, wreport::Varcode id_var, const db::AttrList &qcs, Record &attrs)
 Query attributes. More...
 
void attr_insert (wreport::Varcode id_var, const Record &attrs)
 Insert new attributes into the database, reusing the reference IDs stored by the last insert. More...
 
void attr_insert (int reference_id, wreport::Varcode id_var, const Record &attrs)
 Insert new attributes into the database. More...
 
void attr_remove (int reference_id, wreport::Varcode id_var, const db::AttrList &qcs)
 Delete QC data for the variable `var' in record `rec' (coming from a previous dba_query) More...
 
void import_msg (const Msg &msg, const char *repmemo, int flags)
 Import a Msg message into the DB-All.e database. More...
 
void export_msgs (const Record &query, MsgConsumer &cons)
 Perform the query in `query', and return the results as a NULL-terminated array of dba_msg. 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 Msgs &msgs, const char *repmemo, int flags)
 Import Msgs messages into the DB-All.e database. More...
 

Data Fields

db::Connectionconn
 ODBC database connection.
 

Protected Member Functions

void init_after_connect ()
 
void run_sql (const char *query)
 Run a one-off SQL query.
 
void fill_ana_layer (Msg &msg, int id_station, int id_report)
 Fill a message station info layer with information from the given station and report IDs.
 
 DB (std::auto_ptr< Connection > &conn)
 

Protected Attributes

int last_context_id
 
db::Statementstm_last_insert_id
 Precompiled LAST_INSERT_ID (or equivalent) SQL statement.
 
DBALLE_SQL_C_SINT_TYPE m_last_insert_id
 ID of the last autogenerated primary key.
 
int _last_station_id
 
struct Repinfom_repinfo
 Accessors for the various parts of the database. More...
 
struct Stationm_station
 Station information.
 
struct Contextm_context
 Variable context.
 
struct Datam_data
 Variable data.
 
struct Attrm_attr
 Variable attributes.
 
db::Sequenceseq_station
 Sequence accessors. More...
 
db::Sequenceseq_context
 Context ID sequence.
 

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::auto_ptr< DBconnect (const char *dsn, const char *user, const char *password)
 Start a session with DB-All.e. More...
 
static std::auto_ptr< DBconnect_from_file (const char *pathname)
 Create from a SQLite file pathname. More...
 
static std::auto_ptr< DBconnect_from_url (const char *url)
 Create from an url-like specification, that can be: More...
 
static std::auto_ptr< DBconnect_memory (const std::string &arg=std::string())
 Create an in-memory database.
 
static std::auto_ptr< DBconnect_test ()
 Start a test session with DB-All.e. More...
 
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.
 
- Static Protected Member Functions inherited from dballe::DB
static std::auto_ptr< DBinstantiate_db (std::auto_ptr< db::Connection > &conn)
 

Detailed Description

DB-ALLe database connection.

Member Function Documentation

void dballe::db::v5::DB::attr_insert ( wreport::Varcode  id_var,
const Record attrs 
)
virtual

Insert new attributes into the database, reusing the reference IDs stored by the last insert.

Parameters
id_varThe varcode of the variable related to the attributes to add. See vartable.h
attrsThe record with the attributes to be added
can_replaceIf true, then existing data can be rewritten, else data can only be added.

Implements dballe::DB.

void dballe::db::v5::DB::attr_insert ( int  reference_id,
wreport::Varcode  id_var,
const Record attrs 
)
virtual

Insert new attributes into the database.

Parameters
reference_idThe id (returned by Cursor::attr_reference_id()) used to refer to the variable we query
id_varThe varcode of the variable related to the attributes to add. See vartable.h
attrsThe record with the attributes to be added
can_replaceIf true, then existing data can be rewritten, else data can only be added.

Implements dballe::DB.

void dballe::db::v5::DB::attr_remove ( int  reference_id,
wreport::Varcode  id_var,
const db::AttrList &  qcs 
)
virtual

Delete QC data for the variable `var' in record `rec' (coming from a previous dba_query)

Parameters
reference_idThe database id of the context related to the attributes to remove
id_varThe varcode of the variable related to the attributes to remove. See vartable.h
qcsArray of WMO codes of the attributes to delete. If empty, all attributes associated to id_data will be deleted.

Implements dballe::DB.

bool dballe::db::v5::DB::check_rep_cod ( int  rep_cod)

Verify that a rep_cod is supported by the database.

Parameters
rep_codThe report code to verify
Returns
true if the report code is supported, false if not
void dballe::db::v5::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.

void dballe::db::v5::DB::export_msgs ( const Record query,
MsgConsumer cons 
)
virtual

Perform the query in `query', and return the results as a NULL-terminated array of dba_msg.

Parameters
queryThe query to perform
consThe MsgsConsumer that will handle the resulting messages

Implements dballe::DB.

int dballe::db::v5::DB::get_rep_cod ( const Record rec)

Get the report id from this record.

If rep_memo is specified instead, the corresponding report id is queried in the database and set as "rep_cod" in the record.

void dballe::db::v5::DB::import_msg ( const Msg msg,
const char *  repmemo,
int  flags 
)
virtual

Import a Msg message into the DB-All.e database.

Parameters
dbThe DB-All.e database to write the data into
msgThe Msg 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::v5::DB::insert ( const Record rec,
bool  can_replace,
bool  station_can_add 
)
virtual

Insert a record into the database.

The reference IDs of all variables that were inserted will be stored in memory until the next insert operation. To insert attributes related to one of the variables just inserted, just call attr_insert() without the reference_id parameter.

Parameters
recThe record 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.

std::auto_ptr<db::Cursor> dballe::db::v5::DB::query ( const Record query,
unsigned int  wanted,
unsigned int  modifiers 
)

Create and execute a database query.

The results are retrieved by iterating the cursor.

Parameters
queryThe record with the query data (see technical specifications, par. 1.6.4 "parameter output/input"
wantedThe values wanted in output
modifiersOptional modifiers to ask for special query behaviours
Returns
The cursor to use to iterate over the results
unsigned dballe::db::v5::DB::query_attrs ( int  reference_id,
wreport::Varcode  id_var,
const db::AttrList &  qcs,
Record attrs 
)
virtual

Query attributes.

Parameters
reference_idThe database id of the context related to the attributes to retrieve
id_varThe varcode of the variable related to the attributes to retrieve. See vartable.h
qcsThe WMO codes of the QC values requested. If it is empty, then all values are returned.
attrsThe Record that will hold the resulting attributes
Returns
Number of attributes returned in attrs

Implements dballe::DB.

std::auto_ptr<db::Cursor> dballe::db::v5::DB::query_data ( const Record rec)
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::auto_ptr<db::Cursor> dballe::db::v5::DB::query_stations ( const Record query)
virtual

Start a query on the station variables archive.

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.

virtual std::auto_ptr<db::Cursor> dballe::db::v5::DB::query_summary ( const Record rec)
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::v5::DB::remove ( const Record 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::v5::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::v5::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::v5::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::v5::DB::vacuum ( )
virtual

Remove orphan values from the database.

Orphan values are currently:

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

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

Implements dballe::DB.

Field Documentation

struct Repinfo* dballe::db::v5::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
db::Sequence* dballe::db::v5::DB::seq_station
protected

Sequence accessors.

They are NULL for databases such as MySQL that do not use sequences.Station ID sequence


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