Go to the documentation of this file.
34 #if !defined(MYSQLPP_OPTIONS_H)
35 #define MYSQLPP_OPTIONS_H
45 #if !defined(DOXYGEN_IGNORE)
57 class MYSQLPP_EXPORT Option
70 virtual Error set(DBDriver* dbd) = 0;
77 class MYSQLPP_EXPORT DataOption :
public Option
95 #if !defined(DOXYGEN_IGNORE)
108 #if !defined(DOXYGEN_IGNORE)
113 Error set(DBDriver* dbd);
123 #if !defined(DOXYGEN_IGNORE)
139 #if !defined(DOXYGEN_IGNORE)
152 #if !defined(DOXYGEN_IGNORE)
157 Error set(DBDriver* dbd);
165 #if !defined(DOXYGEN_IGNORE)
170 Error set(DBDriver* dbd);
180 #if !defined(DOXYGEN_IGNORE)
193 #if !defined(DOXYGEN_IGNORE)
198 Error set(DBDriver* dbd);
206 #if !defined(DOXYGEN_IGNORE)
211 Error set(DBDriver* dbd);
219 #if !defined(DOXYGEN_IGNORE)
224 Error set(DBDriver* dbd);
232 #if !defined(DOXYGEN_IGNORE)
237 Error set(DBDriver* dbd);
245 #if !defined(DOXYGEN_IGNORE)
250 Error set(DBDriver* dbd);
258 #if !defined(DOXYGEN_IGNORE)
263 Error set(DBDriver* dbd);
268 #if MYSQL_VERSION_ID > 40000 // only in 4.0 +
272 #if !defined(DOXYGEN_IGNORE)
286 #if !defined(DOXYGEN_IGNORE)
291 Error set(DBDriver* dbd);
297 class MYSQLPP_EXPORT ReadDefaultGroupOption :
public StringOption
299 #if !defined(DOXYGEN_IGNORE)
301 ReadDefaultGroupOption(ArgType arg) :
StringOption(arg) { }
304 Error set(DBDriver* dbd);
312 #if !defined(DOXYGEN_IGNORE)
317 Error set(DBDriver* dbd);
325 #if !defined(DOXYGEN_IGNORE)
330 Error set(DBDriver* dbd);
338 #if !defined(DOXYGEN_IGNORE)
343 Error set(DBDriver* dbd);
352 #if !defined(DOXYGEN_IGNORE)
365 #if !defined(DOXYGEN_IGNORE)
370 Error set(DBDriver* dbd);
378 #if !defined(DOXYGEN_IGNORE)
383 Error set(DBDriver* dbd);
391 #if !defined(DOXYGEN_IGNORE)
396 Error set(DBDriver* dbd);
404 #if !defined(DOXYGEN_IGNORE)
409 Error set(DBDriver* dbd);
430 SslOption(
const char* key = 0,
const char* cert = 0,
431 const char* ca = 0,
const char* capath = 0,
432 const char* cipher = 0)
434 if (key) key_.assign(key);
435 if (cert) cert_.assign(cert);
436 if (ca) ca_.assign(ca);
437 if (capath) capath_.assign(capath);
438 if (cipher) cipher_.assign(cipher);
442 std::string key_, cert_, ca_, capath_, cipher_;
448 class MYSQLPP_EXPORT UseEmbeddedConnectionOption :
public Option
450 #if !defined(DOXYGEN_IGNORE)
461 class MYSQLPP_EXPORT UseRemoteConnectionOption :
public Option
463 #if !defined(DOXYGEN_IGNORE)
465 UseRemoteConnectionOption() : Option() { }
468 Error set(DBDriver* dbd);
476 #if !defined(DOXYGEN_IGNORE)
481 Error set(DBDriver* dbd);
497 #endif // !defined(MYSQLPP_OPTIONS_H)
Enable LOAD DATA LOCAL statement.
Definition: options.h:212
Define abstract interface for all *Option subclasses.
Definition: options.h:78
Give path to charset definition files.
Definition: options.h:384
@ err_api_reject
underlying C API returned error when setting option
Definition: options.h:127
Set reporting of data truncation errors.
Definition: options.h:357
@ err_disconnected
can only set the given option while connected
Definition: options.h:129
Set name of shmem segment for IPC.
Definition: options.h:423
virtual Error set(DBDriver *dbd)=0
Apply option.
@ err_api_limit
option not supported by underlying C API
Definition: options.h:126
Allow C API to guess what kind of connection to use.
Definition: options.h:158
Override use of my.cnf.
Definition: options.h:305
Enable multiple result sets in a reply.
Definition: options.h:238
Set timeout for IPC data reads.
Definition: options.h:495
Allow spaces after function names in queries.
Definition: options.h:171
Set timeout for IPC data reads.
Definition: options.h:331
DataOption< std::string > StringOption
Option w/ string argument.
Definition: options.h:110
Declares the Option class hierarchy, used to implement connection options in Connection and DBDriver ...
std::deque< Option * > OptionList
The data type of the list of connection options.
Definition: options.h:511
Provides a thin abstraction layer over the underlying database client library.
Definition: dbdriver.h:79
Disable db.tbl.col syntax in queries.
Definition: options.h:277
Give name of default charset.
Definition: options.h:397
Assert that this is an interactive program.
Definition: options.h:199
Specialized option for handling SSL parameters.
Definition: options.h:436
T arg_
The argument value.
Definition: options.h:105
Enable data compression on the connection.
Definition: options.h:114
Suggest use of named pipes.
Definition: options.h:264
Define abstract interface for all *Options that take a lone scalar as an argument.
Definition: options.h:98
Declares the DBDriver class.
@ err_NONE
option was set successfully
Definition: options.h:125
@ err_connected
can't set the given option while connected
Definition: options.h:128
Enable LOAD LOCAL INFILE statement.
Definition: options.h:225
Fake client IP address when connecting to embedded server.
Definition: options.h:410
Connect to embedded server in preference to remote server.
Definition: options.h:469
This file includes top-level definitions for use both internal to the library, and outside it....
OptionList::const_iterator OptionListIt
Primary iterator type into List.
Definition: options.h:514
Make Query::affected_rows() return number of matched rows.
Definition: options.h:142
Enforce use of secure authentication, refusing connection if not available.
Definition: options.h:371
Error
Types of option setting errors we can diagnose.
Definition: options.h:103
Change Connection::connect() default timeout.
Definition: options.h:127
Give SQL executed on connect.
Definition: options.h:184
Enable multiple queries in a request to the server.
Definition: options.h:251
Enable automatic reconnection to server.
Definition: options.h:344