MySQL 8.0.29
Source Code Documentation
system_view.h
Go to the documentation of this file.
1/* Copyright (c) 2017, 2021, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is also distributed with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have included with MySQL.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License, version 2.0, for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22
23#ifndef DD__SYSTEM_VIEW_INCLUDED
24#define DD__SYSTEM_VIEW_INCLUDED
25
26#include "sql/dd/string_type.h" // dd::String_type
27
28namespace dd {
29namespace system_views {
30
31class System_view_definition;
32
33/**
34 This class represents base class for all INFORMATION_SCHEMA system views
35 defined in sql/dd/impl/system_views/ headers.
36*/
37
39 public:
40 virtual ~System_view() = default;
41
42 /*
43 Get name of system view.
44
45 @return String containing name of view.
46 */
47 virtual const String_type &name() const = 0;
48
49 /*
50 Get SQL string containing CREATE VIEW definition to create the system view.
51
52 @return SQL String.
53 */
54 virtual const System_view_definition *view_definition() const = 0;
55
56 /*
57 Check if the system view is to be hidden from users.
58
59 @return true If system view is hidden.
60 false If system view is not hidden.
61
62 */
63 virtual bool hidden() const = 0;
64};
65
66} // namespace system_views
67} // namespace dd
68
69#endif // DD__SYSTEM_VIEW_INCLUDED
Definition: system_view_definition.h:36
This class represents base class for all INFORMATION_SCHEMA system views defined in sql/dd/impl/syste...
Definition: system_view.h:38
virtual ~System_view()=default
virtual bool hidden() const =0
virtual const System_view_definition * view_definition() const =0
virtual const String_type & name() const =0
The version of the current data dictionary table definitions.
Definition: dictionary_client.h:42
Char_string_template< String_type_allocator > String_type
Definition: string_type.h:50