MySQL
8.2.0
Source Code Documentation
abstract_connection_program.h
Go to the documentation of this file.
1
/*
2
Copyright (c) 2014, 2023, 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
30
#include "
client/base/abstract_program.h
"
31
#include "
client/base/composite_options_provider.h
"
32
#include "
client/base/i_connection_factory.h
"
33
#include "
client/base/i_options_provider.h
"
34
#include "
client/base/mysql_connection_options.h
"
35
#include "
client/client_priv.h
"
36
37
struct
CHARSET_INFO
;
38
39
namespace
Mysql
{
40
namespace
Tools {
41
namespace
Base {
42
43
/**
44
Base class for all programs that use connection to MySQL database server.
45
*/
46
class
Abstract_connection_program
:
public
Abstract_program
,
47
public
I_connection_factory
{
48
public
:
49
/**
50
Provides new connection to MySQL database server based on option values.
51
Implementation of I_connection_factory interface.
52
*/
53
MYSQL
*
create_connection
()
override
;
54
55
/**
56
Retrieves charset that will be used in new MySQL connections. Can be NULL
57
if none was set explicitly.
58
*/
59
CHARSET_INFO
*
get_current_charset
()
const
;
60
61
/**
62
Sets charset that will be used in new MySQL connections.
63
*/
64
void
set_current_charset
(
CHARSET_INFO
*
charset
);
65
66
protected
:
67
Abstract_connection_program
();
68
69
private
:
70
Options::Mysql_connection_options
m_connection_options
;
71
};
72
73
}
// namespace Base
74
}
// namespace Tools
75
}
// namespace Mysql
76
77
#endif
abstract_program.h
Mysql::Tools::Base::Abstract_connection_program
Base class for all programs that use connection to MySQL database server.
Definition:
abstract_connection_program.h:47
Mysql::Tools::Base::Abstract_connection_program::m_connection_options
Options::Mysql_connection_options m_connection_options
Definition:
abstract_connection_program.h:70
Mysql::Tools::Base::Abstract_connection_program::create_connection
MYSQL * create_connection() override
Provides new connection to MySQL database server based on option values.
Definition:
abstract_connection_program.cc:36
Mysql::Tools::Base::Abstract_connection_program::Abstract_connection_program
Abstract_connection_program()
Definition:
abstract_connection_program.cc:31
Mysql::Tools::Base::Abstract_connection_program::set_current_charset
void set_current_charset(CHARSET_INFO *charset)
Sets charset that will be used in new MySQL connections.
Definition:
abstract_connection_program.cc:44
Mysql::Tools::Base::Abstract_connection_program::get_current_charset
CHARSET_INFO * get_current_charset() const
Retrieves charset that will be used in new MySQL connections.
Definition:
abstract_connection_program.cc:40
Mysql::Tools::Base::Abstract_program
Base class for all MySQL client tools.
Definition:
abstract_program.h:46
Mysql::Tools::Base::I_connection_factory
Interface for classes that are capable of creating connection to MySQL database server.
Definition:
i_connection_factory.h:38
Mysql::Tools::Base::Options::Mysql_connection_options
Options provider providing options to specify connection to MySQL server.
Definition:
mysql_connection_options.h:49
client_priv.h
composite_options_provider.h
i_connection_factory.h
i_options_provider.h
mysql_connection_options.h
Mysql
Definition:
abstract_connection_program.h:39
consts::charset
const std::string charset("charset")
CHARSET_INFO
Definition:
m_ctype.h:422
MYSQL
Definition:
mysql.h:299
client
base
abstract_connection_program.h
Generated by
1.9.2