File indexing completed on 2024-12-01 04:19:05
0001 /* This file is part of the KDE project 0002 Copyright (C) 2006 Jarosław Staniek <staniek@kde.org> 0003 0004 This library is free software; you can redistribute it and/or 0005 modify it under the terms of the GNU Library General Public 0006 License as published by the Free Software Foundation; either 0007 version 2 of the License, or (at your option) any later version. 0008 0009 This library is distributed in the hope that it will be useful, 0010 but WITHOUT ANY WARRANTY; without even the implied warranty of 0011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 0012 Library General Public License for more details. 0013 0014 You should have received a copy of the GNU Library General Public License 0015 along with this library; see the file COPYING.LIB. If not, write to 0016 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 0017 * Boston, MA 02110-1301, USA. 0018 */ 0019 0020 #ifndef KDB_ADMIN_H 0021 #define KDB_ADMIN_H 0022 0023 #include "KDbResult.h" 0024 0025 class KDbConnectionData; 0026 0027 //! @short An interface containing a set of tools for database administration 0028 /*! Can be implemented in database drivers. @see KDbDriver::adminTools 0029 */ 0030 class KDB_EXPORT KDbAdminTools : public KDbResultable 0031 { 0032 public: 0033 KDbAdminTools(); 0034 ~KDbAdminTools() override; 0035 0036 /*! Performs vacuum (compacting) for connection @a data. 0037 Can be implemented for your driver. 0038 Note: in most cases the database should not be opened. 0039 0040 Currently it is implemented for SQLite drivers. 0041 0042 @return true on success, false on failure 0043 (then you can get error status from the KDbAdminTools object). */ 0044 virtual bool vacuum(const KDbConnectionData& data, const QString& databaseName); 0045 0046 private: 0047 Q_DISABLE_COPY(KDbAdminTools) 0048 class Private; 0049 Private * const d; 0050 }; 0051 0052 #endif