Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

mysqlpp Namespace Reference


Compounds

class  BadConversion
 Exception thrown when a bad conversion takes place. More...

class  BadFieldName
 Exception thrown when a requested named field doesn't exist. More...

class  BadNullConversion
 Exception thrown when you attempt to convert a SQL null to an incompatible type. More...

class  BadQuery
 Exception thrown when MySQL encounters a problem while processing your query. More...

class  ColData_Tmpl
 Template for string data that can convert itself to any standard C data type. Do not use directly. More...

class  Connection
 Manages the connection to the MySQL database. More...

class  const_string
 Wrapper for const char* to make it behave in a way more useful to MySQL++. More...

class  const_subscript_container
 A base class that one derives from to become a random access container, which can be accessed with subscript notation. More...

struct  cstr_equal_to
 Documentation needed! More...

struct  cstr_greater
 Documentation needed! More...

struct  cstr_greater_equal
 Documentation needed! More...

struct  cstr_less
 Documentation needed! More...

struct  cstr_less_equal
 Documentation needed! More...

struct  cstr_not_equal_to
 Documentation needed! More...

struct  Date
 Holds MySQL dates. More...

struct  DateTime
 A combination of the Date and Time classes for holding MySQL DateTimes. More...

struct  equal_list_b
 Documentation needed! More...

struct  equal_list_ba
 Documentation needed! More...

struct  escape_type1
 Documentation needed! More...

struct  escape_type2
 Documentation needed! More...

class  FieldNames
 Holds a list of SQL field names. More...

class  Fields
 A container similar to std::vector for holding mysqlpp::Field records. More...

class  FieldTypes
 A vector of SQL field types. More...

struct  ignore_type2
 Documentation needed! More...

struct  mysql_date
 Base class of Date. More...

struct  mysql_dt_base
 Base class for mysql_date and mysql_time. More...

struct  mysql_time
 Base class of Time. More...

class  mysql_type_info
 Holds basic type information for ColData. More...

class  MysqlCmp
 Documentation needed! More...

class  MysqlCmpCStr
 Documentation needed! More...

class  Null
 Container class for holding SQL nulls. More...

class  null_type
 The type of the global mysqlpp::null object. More...

struct  NullisBlank
 Used for the behavior parameter for template Null. More...

struct  NullisNull
 Used for the behavior parameter for template Null. More...

struct  NullisZero
 Used for the behavior parameter for template Null. More...

class  Query
 A class for building and executing SQL queries. More...

class  ResNSel
 Holds the information on the success of queries that don't return any results. More...

class  Result
 This class manages SQL result sets. More...

class  ResUse
 A basic result set class, for use with "use" queries. More...

class  Row
 Manages rows from a result set. More...

class  RowTemplate
 Documentation needed! More...

class  Set
 A special std::set derivative for holding MySQL data sets. More...

class  simp_list_b
 Documentation needed! More...

struct  SQLParseElement
 Documentation needed! More...

class  SQLQuery
 The base class for mysqlpp::Query. More...

class  SQLQueryNEParms
 Exception thrown when not enough parameters are provided. More...

class  SQLQueryParms
 This class holds the parameter values for filling template queries. More...

class  SQLString
 A specialized std::string that will convert from any valid MySQL type. More...

class  subscript_iterator
 Iterator that can be subscripted. More...

struct  Time
 Holds MySQL times. More...

class  tiny_int
 Class for holding an SQL tiny_int object. More...

struct  type_info_cmp
 Documentation needed! More...

struct  value_list_b
 Documentation needed! More...

struct  value_list_ba
 Documentation needed! More...


Typedefs

typedef ColData_Tmpl< const_stringColData
 The type that is returned by constant rows.

typedef ColData_Tmpl< std::string > MutableColData
 The type that is returned by mutable rows.


Enumerations

enum  quote_type0 { quote }
enum  quote_only_type0 { quote_only }
enum  quote_double_only_type0 { quote_double_only }
enum  escape_type0
enum  do_nothing_type0 { do_nothing }
enum  ignore_type0 { ignore }
enum  query_reset
 Used for indicating whether a query object should auto-reset or not.


Functions

template<class BinaryPred, class CmpType> MysqlCmp< BinaryPred, CmpType > mysql_cmp (uint i, const BinaryPred &func, const CmpType &cmp2)
 For comparing any two objects, as long as they can be converted to SQLString.

template<class BinaryPred> MysqlCmpCStr< BinaryPred > mysql_cmp_cstr (uint i, const BinaryPred &func, const char *cmp2)
 For comparing anything to a const char*.

template<class Type, class Behavior> std::ostream & operator<< (std::ostream &o, const Null< Type, Behavior > &n)
template<class Strng, class T> Strng stream2string (const T &object)
 Converts a stream-able object to any type that can be initialized from an std::string.

void strip (std::string &s)
 Strips blanks at left and right ends.

void escape_string (std::string &s)
 C++ equivalent of mysql_escape_string().

void str_to_upr (std::string &s)
 Changes case of string to upper.

void str_to_lwr (std::string &s)
 Changes case of string to lower.

void strip_all_blanks (std::string &s)
 Removes all blanks.

void strip_all_non_num (std::string &s)
 Removes all non-numerics.


Detailed Description

All global symbols in MySQL++ are in namespace mysqlpp. This is needed because many symbols are rather generic (e.g. Row, Query...), so there is a serious danger of conflicts.


Enumeration Type Documentation

enum mysqlpp::do_nothing_type0
 

The 'do_nothing' manipulator.

Does exactly what it says: nothing. Used as a dummy manipulator when you are required to use some manipulator but don't want anything to be done to the following item. When used with SQLQueryParms it will make sure that it does not get formatted in any way, overriding any setting set by the template query.

Enumeration values:
do_nothing  insert into a std::ostream to override manipulation of next item

enum mysqlpp::escape_type0
 

The 'escape' manipulator.

Calls mysql_escape_string() in the MySQL C API on the following argument to prevent any special SQL characters from being interpreted.

enum mysqlpp::ignore_type0
 

The 'ignore' manipulator.

Only valid when used with SQLQueryParms. It's a dummy manipulator like the do_nothing manipulator, except that it will not override formatting set by the template query. It is simply ignored.

Enumeration values:
ignore  insert into a std::ostream as a dummy manipulator

enum mysqlpp::quote_double_only_type0
 

The 'double_quote_only' manipulator.

Similar to quote_only manipulator, except that it uses double quotes instead of single quotes.

Enumeration values:
quote_double_only  insert into a std::ostream to double-quote next item

enum mysqlpp::quote_only_type0
 

The 'quote_only' manipulator.

Similar to quote manipulator, except that it doesn't escape special SQL characters.

Enumeration values:
quote_only  insert into a std::ostream to single-quote next item

enum mysqlpp::quote_type0
 

The standard 'quote' manipulator.

Insert this into a stream to put single quotes around the next item in the stream, and escape characters within it that are 'special' in SQL. This is the most generally useful of the manipulators.

Enumeration values:
quote  insert into a std::ostream to single-quote and escape next item


Function Documentation

template<class BinaryPred, class CmpType>
MysqlCmp<BinaryPred, CmpType> mysql_cmp uint    i,
const BinaryPred &    func,
const CmpType &    cmp2
 

For comparing any two objects, as long as they can be converted to SQLString.

This template is for creating predicate objects for use with STL algorithms like std::find_if().

This is a more generic form of mysql_cmp_cstr() which will work with any C++ type that can be converted to mysqlpp::SQLString. This is not nearly as efficient as that function, so use this only when absolutely necessary.

Parameters:
i  field index number
func  one of the functors in compare.h, or any compatible functor
cmp2  what to compare to

template<class BinaryPred>
MysqlCmpCStr<BinaryPred> mysql_cmp_cstr uint    i,
const BinaryPred &    func,
const char *    cmp2
 

For comparing anything to a const char*.

This template is for creating predicate objects for use with STL algorithms like std::find_if().

Parameters:
i  field index number
func  one of cstr_equal_to(), cstr_not_equal_to(), cstr_less(), cstr_less_equal(), cstr_less_equal(), or cstr_less_equal().
cmp2  what to compare to

template<class Type, class Behavior>
std::ostream& operator<< std::ostream &    o,
const Null< Type, Behavior > &    n
[inline]
 

template<class Strng, class T>
Strng stream2string const T &    object
 

Converts a stream-able object to any type that can be initialized from an std::string.

This adapter takes any object that has an out_stream() member function and converts it to a string type. An example of such a type within the library is mysqlpp::Date.


Generated on Thu May 5 05:31:23 2005 for MySQL++ by doxygen1.2.18