field.h

Go to the documentation of this file.

/***********************************************************************
 Copyright (c) 2007 by Educational Technology Resources, Inc.
 Others may also hold copyrights on code in this file.  See the
 CREDITS.txt file in the top directory of the distribution for details.

 This file is part of MySQL++.

 MySQL++ is free software; you can redistribute it and/or modify it
 under the terms of the GNU Lesser General Public License as published
 by the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.

 MySQL++ is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with MySQL++; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
 USA
***********************************************************************/

#if !defined(MYSQLPP_FIELD_H)
#define MYSQLPP_FIELD_H

#include "common.h"
#include "type_info.h"

#include <vector>

namespace mysqlpp {


class Field
{
public:
        Field() :
        length_(0),
        max_length_(0),
        flags_(0)
        {
        }

        Field(const MYSQL_FIELD* pf) :
        name_(pf->name),
        table_(pf->table),
#if MYSQL_VERSION_ID > 40000    // only in 4.0 +
        db_(pf->db),
#endif
        type_(pf->type, (pf->flags & UNSIGNED_FLAG) != 0,
                        (pf->flags & NOT_NULL_FLAG) == 0),
        length_(pf->length),
        max_length_(pf->max_length),
        flags_(pf->flags)
        {
        }

        Field(const Field& other) :
        name_(other.name_),
        table_(other.table_),
        db_(other.db_),
        type_(other.type_),
        length_(other.length_),
        max_length_(other.max_length_),
        flags_(other.flags_)
        {
        }

        bool auto_increment() const { return flags_ & AUTO_INCREMENT_FLAG; }

        bool binary_type() const { return flags_ & BINARY_FLAG; }

        bool blob_type() const { return flags_ & BLOB_FLAG; }

        const char* db() const { return db_.c_str(); }

        bool enumeration() const { return flags_ & ENUM_FLAG; }

        size_t length() const { return length_; }

        size_t max_length() const { return max_length_; }

        bool multiple_key() const { return flags_ & MULTIPLE_KEY_FLAG; }

        const char* name() const { return name_.c_str(); }

#if defined(NO_DEFAULT_VALUE_FLAG)
        bool no_default() const { return flags_ & NO_DEFAULT_VALUE_FLAG; }
#endif

        bool primary_key() const { return flags_ & PRI_KEY_FLAG; }

        bool set_type() const { return flags_ & SET_FLAG; }

        const char* table() const { return table_.c_str(); }

        bool timestamp() const { return flags_ & TIMESTAMP_FLAG; }

        const mysql_type_info& type() const { return type_; }

        bool unique_key() const { return flags_ & UNIQUE_KEY_FLAG; }

        bool zerofill() const { return flags_ & ZEROFILL_FLAG; }

private:
        std::string name_;              
        std::string table_;             
        std::string db_;                
        mysql_type_info type_;  
        size_t length_;                 
        size_t max_length_;             
        unsigned int flags_;    
};


typedef std::vector<Field> Fields;

} // end namespace mysqlpp

#endif // !defined(MYSQLPP_FIELD_H)

---