MySQL 8.0.31
Source Code Documentation
abstract_connection_program.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2014, 2022, Oracle and/or its affiliates.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License, version 2.0,
6 as published by the Free Software Foundation.
7
8 This program is also distributed with certain software (including
9 but not limited to OpenSSL) that is licensed under separate terms,
10 as designated in a particular file or component or in included license
11 documentation. The authors of MySQL hereby grant you an additional
12 permission to link the program and your derivative works with the
13 separately licensed software that they have included with MySQL.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23*/
24
25#ifndef ABSTRACT_CONNECTION_PROGRAM_INCLUDED
26#define ABSTRACT_CONNECTION_PROGRAM_INCLUDED
27
28#include <string>
29
35#include "client/client_priv.h"
36
37namespace Mysql {
38namespace Tools {
39namespace Base {
40
41/**
42 Base class for all programs that use connection to MySQL database server.
43 */
46 public:
47 /**
48 Provides new connection to MySQL database server based on option values.
49 Implementation of I_connection_factory interface.
50 */
51 MYSQL *create_connection() override;
52
53 /**
54 Retrieves charset that will be used in new MySQL connections. Can be NULL
55 if none was set explicitly.
56 */
58
59 /**
60 Sets charset that will be used in new MySQL connections.
61 */
63
64 protected:
66
67 private:
69};
70
71} // namespace Base
72} // namespace Tools
73} // namespace Mysql
74
75#endif
Base class for all programs that use connection to MySQL database server.
Definition: abstract_connection_program.h:45
Options::Mysql_connection_options m_connection_options
Definition: abstract_connection_program.h:68
MYSQL * create_connection() override
Provides new connection to MySQL database server based on option values.
Definition: abstract_connection_program.cc:34
Abstract_connection_program()
Definition: abstract_connection_program.cc:29
void set_current_charset(CHARSET_INFO *charset)
Sets charset that will be used in new MySQL connections.
Definition: abstract_connection_program.cc:42
CHARSET_INFO * get_current_charset() const
Retrieves charset that will be used in new MySQL connections.
Definition: abstract_connection_program.cc:38
Base class for all MySQL client tools.
Definition: abstract_program.h:46
Interface for classes that are capable of creating connection to MySQL database server.
Definition: i_connection_factory.h:38
Options provider providing options to specify connection to MySQL server.
Definition: mysql_connection_options.h:47
Definition: abstract_connection_program.h:37
const std::string charset("charset")
Definition: m_ctype.h:382
Definition: mysql.h:298