TableDef Class Reference

Represents table definition used to create the table. More...

#include <Info.h>

Collaboration diagram for TableDef:

[legend]

Public Member Functions
	TableDef ()
	~TableDef ()
void	reset ()
int	addField (const char *name, DataType type=typeUnknown, size_t length=0, const void *defaultValue=0, bool notNull=false)
	adds a field to the schema definition.
int	dropField (const char *name)
	removes a field from the schema definition
int	getFieldCount ()
	returns the total number of fields in this table definition
size_t	getTupleSize ()
	returns the total tuple size in bytes.
FieldIterator	getFieldIterator ()

---

Detailed Description

Represents table definition used to create the table.

Encapsulates the information or schema definition of a table.For Example say if
we need to create table with two fields, call addField method with necessary parameters
twice. Passed as argument to createTable method of DatabaseManager to create table.

Author:

Prabakaran Thirumalai

Definition at line 69 of file Info.h.

---

Constructor & Destructor Documentation

TableDef::TableDef

(

)

[inline]

Definition at line 76 of file Info.h.

{ fldCount = 0; }

TableDef::~TableDef

(

)

Definition at line 21 of file TableDef.cxx.

References reset().

{
    reset();
}

Here is the call graph for this function:

---

Member Function Documentation

int TableDef::addField	(	const char *	name,
		DataType	type = typeUnknown,
		size_t	length = 0,
		const void *	defaultValue = 0,
		bool	notNull = false
	)

adds a field to the schema definition.

Parameters:

	name	field name
	type	data type of the field
	length	size of the field. used in case of char and binary data types.
	defaultValue	default value for the field. It is currently limited to 32 bytes.
	isPrimary	whether the field is primary key( not null + unique)
	notNull	whether the field can be null
	unique	whether the field values are unique

Returns:

int

Definition at line 30 of file TableDef.cxx.

References FieldList::append(), DEFAULT_VALUE_BUF_LENGTH, FieldDef::defaultValueBuf_, ErrAlready, ErrBadArg, FieldDef::fldName_, getFieldIterator(), FieldIterator::hasElement(), IDENTIFIER_LENGTH, FieldDef::isDefault_, FieldDef::isNull_, FieldDef::length_, os::memcpy(), os::memset(), FieldIterator::nextElement(), printError, AllDataType::size(), FieldDef::type_, typeBinary, and typeString.

Referenced by CacheTableLoader::load(), and CreateTblStatement::resolve().

{
    if (name == NULL) return (int)ErrBadArg;
    // The following code checks for duplicates
    FieldIterator iter = getFieldIterator();
    while (iter.hasElement())
    {
        FieldDef def = iter.nextElement();
        if (! strcmp(def.fldName_, name)) {
            printError(ErrAlready, "Field %s already Exists", name);
            return (int) ErrAlready;
        }
    }
    FieldDef fldDef;
    strcpy(fldDef.fldName_, name);
    fldDef.fldName_[IDENTIFIER_LENGTH] = '\0';
    fldDef.type_ = type;
    fldDef.length_ = length;
    if (defaultValue != NULL)
    {
        fldDef.isDefault_ = true;
        os::memcpy(fldDef.defaultValueBuf_, defaultValue,
                                DEFAULT_VALUE_BUF_LENGTH);
    }
    else
    {
        fldDef.isDefault_ = false;
        os::memset(fldDef.defaultValueBuf_,0, DEFAULT_VALUE_BUF_LENGTH);
    }
    fldDef.isNull_ = notNull;
    switch(type)
    {
        case typeString :
        case typeBinary:
            fldDef.length_ = length;
            break;
        default:
            fldDef.length_ = AllDataType::size(type);
            break;
    }
    int ret = fldList.append(fldDef);
    if (0 == ret)  fldCount++;
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int TableDef::dropField

(

const char *

name

)

removes a field from the schema definition

Parameters:

name

field name

Returns:

int

Definition at line 76 of file TableDef.cxx.

References FieldList::remove().

{
    int ret = fldList.remove(name);
    if (0 == ret) fldCount--;
    return ret;
}

Here is the call graph for this function:

int TableDef::getFieldCount

(

)

returns the total number of fields in this table definition

Returns:

int no of fields

Definition at line 83 of file TableDef.cxx.

Referenced by DatabaseManagerImpl::createTable().

{
    return fldCount;
}

Here is the caller graph for this function:

FieldIterator TableDef::getFieldIterator

(

)

[inline]

Definition at line 111 of file Info.h.

References FieldList::getIterator().

Referenced by addField(), DatabaseManagerImpl::createTable(), and getTupleSize().

{ return fldList.getIterator(); }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t TableDef::getTupleSize

(

)

returns the total tuple size in bytes.

Returns:

size_t tuple size

Definition at line 88 of file TableDef.cxx.

References os::align(), getFieldIterator(), FieldIterator::hasElement(), and FieldIterator::nextElement().

Referenced by DatabaseManagerImpl::createTable().

{
    size_t length = 0;
    FieldIterator iter = getFieldIterator();
    while (iter.hasElement())
    {
        FieldDef def = iter.nextElement();
        length = length + os::align(def.length_);
    }
    return length;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TableDef::reset

(

)

Definition at line 25 of file TableDef.cxx.

References FieldList::removeAll().

Referenced by CreateTblStatement::~CreateTblStatement(), and ~TableDef().

{
    fldList.removeAll();
    fldCount = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• include/Info.h
• src/server/TableDef.cxx

---