KDb

KDbSelectStatementOptions.shared.h
1/* This file is part of the KDE project
2 Copyright (C) 2003-2017 Jarosław Staniek <staniek@kde.org>
3
4 This program 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 program 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 program; see the file COPYING. 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_KDBSELECTSTATEMENTOPTIONS_H
21#define KDB_KDBSELECTSTATEMENTOPTIONS_H
22
23#include "kdb_export.h"
24
25class KDbConnection;
26class KDbQuerySchema;
27class KDbTableSchema;
29
30//! Options used in KDbNativeStatementBuilder::generateSelectStatement()
31class KDB_EXPORT KDbSelectStatementOptions //SDC: operator==
32{
33public:
34 /*!
35 @getter
36 @return @c true if record IDs should be also retrieved. @c false by default.
37 @setter
38 Specifies whether record IDs should be also retrieved.
39 */
40 bool alsoRetrieveRecordId; //SDC: default=false
41
42 /*!
43 @getter
44 @return @c true if relations (LEFT OUTER JOIN) for visible lookup columns should be added.
45 @c false is used only when user-visible statement is generated e.g. the one used in Kexi's
46 Query Designer. @c true by default.
47 @setter
48 Specifies whether if relations (LEFT OUTER JOIN) for visible lookup columns should be added.
49 */
50 bool addVisibleLookupColumns; //SDC: default=true
51};
52
53#endif
Provides database connection, allowing queries and data modification.
Specialized string for escaping.
KDbQuerySchema provides information about database query.
Options used in KDbNativeStatementBuilder::generateSelectStatement()
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 12:00:07 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.