src/database.h

   1 /*
   2  * This file is part of LineMan.
   3  *
   4  * Copyright 2006 Igor Khanin
   5  *
   6  * LiteMan is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * LiteMan is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with LiteMan; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  */
  20
  21 #ifndef DATABASE_H
  22 #define DATABASE_H
  23
  24 #include <QCoreApplication>
  25 #include <QSqlDatabase>
  26 #include <QStringList>
  27
  28 typedef struct
  29 {
  30         QString name;
  31         QString type;
  32         QString comment;
  33 }
  34 DatabaseTableField;
  35
  36 typedef QList<DatabaseTableField> FieldList;
  37
  38 /*!
  39  * @brief An exception indicating %Database error
  40  */
  41 class DatabaseException
  42 {
  43         public:
  44                 DatabaseException(QString msg) { message = msg; }
  45
  46                 QString message;
  47 };
  48
  49 /*!
  50  * @brief The database manager
  51  *
  52  * The %Database class represents a single database file/object, and provides convinient methods
  53  * for accessing specific elements in it (currently only tables and views). Though the application
  54  * still doesn't use this capability, it is completly safe to have multipile %Database object managing
  55  * diffirent databases in the same time.
  56  *
  57  * Internally, the class uses the QtSQL API for manipulating the database.
  58  */
  59 class Database
  60 {
  61                 Q_DECLARE_TR_FUNCTIONS(Database)
  62
  63         public:
  64                 Database(const QString & fileName);
  65                 ~Database();
  66
  67                 bool isValid();
  68                 QString id();
  69
  70                 //
  71                 // Table related methods
  72                 //
  73                 QStringList getTables();
  74
  75                 void createTable(const QString & name, const FieldList & fields);
  76                 void renameTable(const QString & table, const QString & newName);
  77                 void dropTable(const QString & table);
  78
  79                 FieldList tableFields(const QString & table);
  80
  81                 //
  82                 // View related methods
  83                 //
  84                 QStringList getViews();
  85
  86                 void createView(const QString & name, const QString & sql);
  87                 void dropView(const QString & view);
  88
  89                 //
  90                 // Other methods
  91                 //
  92                 void exportSql(const QString & fileName);
  93
  94         private:
  95                 bool testDB();
  96
  97                 bool valid;
  98                 QString databaseId;
  99 };
 100
 101 #endif //DATABASE_H