Defines the metadata properties of a column within a table of a database. More...

Inheritance diagram for Deveel.Data.Sql.Tables.ColumnInfo:

Public Member Functions
	ColumnInfo (string columnName, SqlType columnType)
	Constructs a new column with the given name and type. More...

Static Public Member Functions
static void	Serialize (ColumnInfo columnInfo, BinaryWriter writer)

static void	Serialize (ColumnInfo columnInfo, Stream stream, Encoding encoding)

static void	Serialize (ColumnInfo columnInfo, Stream stream)

static ColumnInfo	Deserialize (Stream stream, ITypeResolver typeResolver)

static ColumnInfo	Deserialize (BinaryReader reader, ITypeResolver typeResolver)

Properties
TableInfo	TableInfo `[get, set]`
	Gets the table where the column is attached to. More...

string	ColumnName `[get, private set]`
	Gets the name of the column. More...

ObjectName	FullColumnName `[get]`
	Gets the fully qualified name of the column within the database system. More...

SqlType	ColumnType `[get, private set]`
	Gets the SqlType that cells within a table for this column will handle. More...

int	Offset `[get]`
	Gets the zero-based offset of the column within the containing table. More...

bool	HasSize `[get]`

int	Size `[get]`

bool	HasScale `[get]`

int	Scale `[get]`

bool	IsIndexable `[get]`
	Gets a boolean vale indicating if the value of a column can participate to an index. More...

bool	IsNotNull `[get, set]`
	Gets or sets a boolean value indicating if the column values are constrained to be ony `NOT NULL`. More...

SqlExpression	DefaultExpression `[get, set]`
	Gets or sets a SqlExpression used as a `DEFAULT` when a constraint for the column is to `SET DEFAULT`. More...

bool	HasDefaultExpression `[get]`
	Gets a boolean value indicating if the column has a DefaultExpression. More...

string	IndexType `[get, set]`

Private Member Functions
	ColumnInfo (ObjectData data)

void ISerializable.	GetData (SerializeData data)

Detailed Description

Defines the metadata properties of a column within a table of a database.

Columns have unique names within a table and a given SqlType that is used to define the type of data cells in the table will handle.

Definition at line 36 of file ColumnInfo.cs.

Constructor & Destructor Documentation

Deveel.Data.Sql.Tables.ColumnInfo.ColumnInfo	(	string	columnName,
		SqlType	columnType
	)

inline

Constructs a new column with the given name and type.

Parameters

columnName	The name of the column, as case-sensitive and unique within the table.
columnType	The SqlType that this column will handle.

Exceptions

ArgumentNullException If either one of columnName or columnType is null.

Definition at line 47 of file ColumnInfo.cs.

                                                                  {
             if (String.IsNullOrEmpty(columnName))
                 throw new ArgumentNullException("columnName");
             if (columnType == null) 
                 throw new ArgumentNullException("columnType");
 
 
             ColumnType = columnType;
             ColumnName = columnName;
         }

Deveel.Data.Sql.Tables.ColumnInfo.ColumnInfo ( ObjectData data )

inlineprivate

Definition at line 58 of file ColumnInfo.cs.

                                             {
             ColumnName = data.GetString("ColumnName");
             ColumnType = data.GetValue<SqlType>("ColumnType");
             IsNotNull = data.GetBoolean("IsNotNull");
             DefaultExpression = data.GetValue<SqlExpression>("Default");
             IndexType = data.GetString("IndexType");
         }

Member Function Documentation

static ColumnInfo Deveel.Data.Sql.Tables.ColumnInfo.Deserialize	(	Stream	stream,
		ITypeResolver	typeResolver
	)

inlinestatic

Definition at line 198 of file ColumnInfo.cs.

                                                                                         {
             var reader = new BinaryReader(stream, Encoding.Unicode);
             return Deserialize(reader, typeResolver);
         }

static ColumnInfo Deveel.Data.Sql.Tables.ColumnInfo.Deserialize	(	BinaryReader	reader,
		ITypeResolver	typeResolver
	)

inlinestatic

Definition at line 203 of file ColumnInfo.cs.

                                                                                               {
             var version = reader.ReadInt32();
             if (version != 3)
                 throw new FormatException("Invalid version of the Column-Info");
 
             var columnName = reader.ReadString();
             var columnType = TypeSerializer.Deserialize(reader, typeResolver);
 
             var notNull = reader.ReadByte() == 1;
 
             var columnInfo = new ColumnInfo(columnName, columnType);
             columnInfo.IsNotNull = notNull;
 
             var hasDefault = reader.ReadByte() == 1;
             if (hasDefault)
                 columnInfo.DefaultExpression = SqlExpression.Deserialize(reader);
 
             return columnInfo;
         }

void ISerializable. Deveel.Data.Sql.Tables.ColumnInfo.GetData ( SerializeData data )

inlineprivate

Implements Deveel.Data.Serialization.ISerializable.

Definition at line 164 of file ColumnInfo.cs.

                                                        {
             data.SetValue("ColumnName", ColumnName);
             data.SetValue("ColumnType", ColumnType);
             data.SetValue("IsNotNull", IsNotNull);
             data.SetValue("Default", DefaultExpression);
             data.SetValue("IndexType", IndexType);
         }

static void Deveel.Data.Sql.Tables.ColumnInfo.Serialize	(	ColumnInfo	columnInfo,
		BinaryWriter	writer
	)

inlinestatic

Definition at line 173 of file ColumnInfo.cs.

                                                                                  {
             writer.Write(3);    // Version
             writer.Write(columnInfo.ColumnName);
 
             TypeSerializer.SerializeTo(writer, columnInfo.ColumnType);
 
             writer.Write(columnInfo.IsNotNull ? (byte)1 : (byte)0);
 
             if (columnInfo.DefaultExpression != null) {
                 writer.Write((byte)1);
                 SqlExpression.Serialize(columnInfo.DefaultExpression, writer);
             } else {
                 writer.Write((byte)0);
             }
         }

static void Deveel.Data.Sql.Tables.ColumnInfo.Serialize	(	ColumnInfo	columnInfo,
		Stream	stream,
		Encoding	encoding
	)

inlinestatic

Definition at line 189 of file ColumnInfo.cs.

                                                                                               {
             var writer = new BinaryWriter(stream, encoding);
             Serialize(columnInfo, writer);
         }

static void Deveel.Data.Sql.Tables.ColumnInfo.Serialize	(	ColumnInfo	columnInfo,
		Stream	stream
	)

inlinestatic

Definition at line 194 of file ColumnInfo.cs.

                                                                            {
             Serialize(columnInfo, stream, Encoding.Unicode);
         }

Property Documentation

string Deveel.Data.Sql.Tables.ColumnInfo.ColumnName

getprivate set

Gets the name of the column.

Definition at line 79 of file ColumnInfo.cs.

SqlType Deveel.Data.Sql.Tables.ColumnInfo.ColumnType

getprivate set

Gets the SqlType that cells within a table for this column will handle.

See also: SqlType

Definition at line 99 of file ColumnInfo.cs.

SqlExpression Deveel.Data.Sql.Tables.ColumnInfo.DefaultExpression

getset

Gets or sets a SqlExpression used as a DEFAULT when a constraint for the column is to SET DEFAULT.

See also: SqlExpression

Definition at line 151 of file ColumnInfo.cs.

ObjectName Deveel.Data.Sql.Tables.ColumnInfo.FullColumnName

get

Gets the fully qualified name of the column within the database system.

When TableInfo is set, the value returned is the fully qualified name of the column, otherwise this returns an instance of ObjectName that defines only ColumnName.

Definition at line 90 of file ColumnInfo.cs.

bool Deveel.Data.Sql.Tables.ColumnInfo.HasDefaultExpression

get

Gets a boolean value indicating if the column has a DefaultExpression.

See also: DefaultExpression

Definition at line 157 of file ColumnInfo.cs.

bool Deveel.Data.Sql.Tables.ColumnInfo.HasScale

get

Definition at line 120 of file ColumnInfo.cs.

bool Deveel.Data.Sql.Tables.ColumnInfo.HasSize

get

Definition at line 109 of file ColumnInfo.cs.

string Deveel.Data.Sql.Tables.ColumnInfo.IndexType

getset

Definition at line 161 of file ColumnInfo.cs.

bool Deveel.Data.Sql.Tables.ColumnInfo.IsIndexable

get

Gets a boolean vale indicating if the value of a column can participate to an index.

See also: SqlType.IsIndexable

Definition at line 136 of file ColumnInfo.cs.

bool Deveel.Data.Sql.Tables.ColumnInfo.IsNotNull

getset

Gets or sets a boolean value indicating if the column values are constrained to be ony NOT NULL.

Definition at line 144 of file ColumnInfo.cs.

int Deveel.Data.Sql.Tables.ColumnInfo.Offset

get

Gets the zero-based offset of the column within the containing table.

See also: Tables.TableInfo.IndexOfColumn(string)

Definition at line 105 of file ColumnInfo.cs.

int Deveel.Data.Sql.Tables.ColumnInfo.Scale

get

Definition at line 124 of file ColumnInfo.cs.

int Deveel.Data.Sql.Tables.ColumnInfo.Size

get

Definition at line 113 of file ColumnInfo.cs.

TableInfo Deveel.Data.Sql.Tables.ColumnInfo.TableInfo

getset

Gets the table where the column is attached to.

This value is set when this object is added to a table.

See also: Tables.TableInfo.AddColumn(ColumnInfo)

Definition at line 74 of file ColumnInfo.cs.

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

/var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Sql.Tables/ColumnInfo.cs

Public Member Functions

Static Public Member Functions

Properties

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation