KDb

KDbAdmin.h
1 /* This file is part of the KDE project
2  Copyright (C) 2006 JarosÅ‚aw Staniek <[email protected]>
3 
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef KDB_ADMIN_H
21 #define KDB_ADMIN_H
22 
23 #include "KDbResult.h"
24 
25 class KDbConnectionData;
26 
27 //! @short An interface containing a set of tools for database administration
28 /*! Can be implemented in database drivers. @see KDbDriver::adminTools
29 */
30 class KDB_EXPORT KDbAdminTools : public KDbResultable
31 {
32 public:
33  KDbAdminTools();
34  ~KDbAdminTools() override;
35 
36  /*! Performs vacuum (compacting) for connection @a data.
37  Can be implemented for your driver.
38  Note: in most cases the database should not be opened.
39 
40  Currently it is implemented for SQLite drivers.
41 
42  @return true on success, false on failure
43  (then you can get error status from the KDbAdminTools object). */
44  virtual bool vacuum(const KDbConnectionData& data, const QString& databaseName);
45 
46 private:
47  Q_DISABLE_COPY(KDbAdminTools)
48  class Private;
49  Private * const d;
50 };
51 
52 #endif
Interface for classes providing a result.
An interface containing a set of tools for database administration.
Definition: KDbAdmin.h:30
Database specific connection data, e.g. host, port.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Dec 9 2022 04:09:46 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.