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

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

Classes
class	ColumnsResolver

Public Member Functions
	TableInfo (ObjectName tableName)
	Constructs the object with the given table name. More...

void	Establish (int id)

void	AddColumn (ColumnInfo column)
	Adds a new column to the table at the last position of the columns list in the table metadata. More...

ColumnInfo	AddColumn (string columnName, SqlType columnType)
	Adds a new column to the table having the given name and type. More...

ColumnInfo	AddColumn (string columnName, SqlType columnType, bool notNull)
	Adds a new column to the table having the given name and type. More...

IEnumerator< ColumnInfo >	GetEnumerator ()

int	IndexOfColumn (string columnName)
	Gets the offset of the column with the given name. More...

int	IndexOfColumn (ObjectName columnName)

TableInfo	AsReadOnly ()
	Creates a new instance of TableInfo as an immutable copy of this table metadata. More...

TableInfo	Alias (ObjectName alias)

IEnumerable< int >	IndexOfColumns (IEnumerable< string > columnNames)

Static Public Member Functions
static void	Serialize (TableInfo tableInfo, Stream stream)

static void	Serialize (TableInfo tableInfo, BinaryWriter writer)

static TableInfo	Deserialize (Stream stream, ITypeResolver typeResolver)

static TableInfo	Deserialize (BinaryReader reader, ITypeResolver typeResolver)

Package Functions
void	AddColumnSafe (ColumnInfo column)

SqlExpression	ResolveColumns (bool ignoreCase, SqlExpression expression)

Properties
DbObjectType IObjectInfo.	ObjectType `[get]`

ObjectName	TableName `[get, private set]`
	Gets the fully qualified name of the table that is ensured to be unique within the system. More...

ObjectName IObjectInfo.	FullName `[get]`

int	Id `[get, private set]`
	Gets a unique identifier of the table in a database system. More...

bool	IsPermanent `[get, private set]`
	Gets a value that indicates if the table is permanent. More...

string	Name `[get]`
	Gets the name part of the table name. More...

ObjectName	SchemaName `[get]`
	Gets the schema name part of the table name. More...

string	CatalogName `[get]`
	Gets the name of the catalog containing the table, if defined. More...

bool	IsReadOnly `[get, private set]`
	Gets a boolean value that indicates if the structure of this table cannot be altered. More...

int	ColumnCount `[get]`
	Gets a count of the columns defined by this object. More...

ColumnInfo	this[int offset] `[get]`
	Gets the column object defined at the given offset within the table. More...

Properties inherited from Deveel.Data.Sql.IObjectInfo
DbObjectType	ObjectType `[get]`

ObjectName	FullName `[get]`

Private Member Functions
	TableInfo (ObjectName tableName, int id, bool perm, IList< ColumnInfo > columns, bool isReadOnly)

	TableInfo (ObjectData data)

void	AssertNotReadOnly ()

void ISerializable.	GetData (SerializeData data)

IEnumerator IEnumerable.	GetEnumerator ()

Private Attributes
readonly IList< ColumnInfo >	columns

readonly Dictionary< ObjectName, int >	columnsCache

Detailed Description

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

A table structure implements a unique name within a database system, and a list columns that shape the design of the data that the table can accommodate.

Definition at line 41 of file TableInfo.cs.

Constructor & Destructor Documentation

Deveel.Data.Sql.Tables.TableInfo.TableInfo ( ObjectName tableName )

inline

Constructs the object with the given table name.

Parameters

tableName	The unique name of the table within the database system.
id	The unique identifier of the table in the database.

Exceptions

ArgumentNullException If the provided tableName is null.

Definition at line 54 of file TableInfo.cs.

55 : this(tableName, -1, false, new List<ColumnInfo>(), false) {

56 }

Deveel.Data.Sql.Tables.TableInfo.TableInfo	(	ObjectName	tableName,
		int	id,
		bool	perm,
		IList< ColumnInfo >	columns,
		bool	isReadOnly
	)

inlineprivate

Definition at line 58 of file TableInfo.cs.

                                                                                                                {
             if (tableName == null) 
                 throw new ArgumentNullException("tableName");
 
             TableName = tableName;
             Id = id;
             IsPermanent = perm;
             this.columns = columns;
             IsReadOnly = isReadOnly;
 
             columnsCache = new Dictionary<ObjectName, int>();
         }

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

inlineprivate

Definition at line 71 of file TableInfo.cs.

                                            {
             TableName = data.GetValue<ObjectName>("TableName");
             Id = data.GetInt32("TableId");
             IsPermanent = data.GetBoolean("Permanent");
             IsReadOnly = data.GetBoolean("ReaDOnly");
 
             columns = new List<ColumnInfo>();
             var columnInfo = data.GetValue<ColumnInfo[]>("Columns");
             if (columnInfo != null) {
                 foreach (var info in columnInfo) {
                     info.TableInfo = this;
                     columns.Add(info);
                 }
             }
 
             columnsCache = new Dictionary<ObjectName, int>();
         }

Member Function Documentation

void Deveel.Data.Sql.Tables.TableInfo.AddColumn ( ColumnInfo column )

inline

Adds a new column to the table at the last position of the columns list in the table metadata.

Parameters

column The ColumnInfo metadata to add to the table.

Exceptions

ArgumentNullException	If the given column is `null`.
InvalidOperationException	If the table is immutable (IsReadOnly is equals to `true`)
ArgumentException	If the column is already defined in this table or if it is attacted to another table.

Definition at line 230 of file TableInfo.cs.

                                                  {
             if (column == null)
                 throw new ArgumentNullException("column");
 
             AssertNotReadOnly();
 
             if (column.TableInfo != null &&
                 column.TableInfo != this)
                 throw new ArgumentException(String.Format("The column {0} belongs to another table already ({1})", column.ColumnName,
                     column.TableInfo.Name));
 
             if (columns.Any(x => x.ColumnName == column.ColumnName))
                 throw new ArgumentException(String.Format("Column {0} is already defined in table {1}", column.ColumnName, TableName));
 
             columnsCache.Clear();
             column.TableInfo = this;
             columns.Add(column);
         }

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

inline

Adds a new column to the table having the given name and type.

Parameters

columnName	The name of the column to add.
columnType	The SqlType of the column to add.

Returns: Returns an instance of ColumnInfo that is generated by the given parameters.

See also: AddColumn(string, SqlType, bool)

Definition at line 259 of file TableInfo.cs.

                                                                            {
             return AddColumn(columnName, columnType, false);
         }

ColumnInfo Deveel.Data.Sql.Tables.TableInfo.AddColumn	(	string	columnName,
		SqlType	columnType,
		bool	notNull
	)

inline

Adds a new column to the table having the given name and type.

Parameters

columnName	The name of the column to add.
columnType	The SqlType of the column to add.
notNull	If the column values must be `NOT NULL`.

Returns: Returns an instance of ColumnInfo that is generated by the given parameters.

See also: AddColumn(string, SqlType, bool), AddColumn(ColumnInfo)

Exceptions

ArgumentNullException If either columnName or the columnType arguments are null.

Definition at line 279 of file TableInfo.cs.

                                                                                          {
             if (String.IsNullOrEmpty(columnName))
                 throw new ArgumentNullException("columnName");
 
             if (columnType == null)
                 throw new ArgumentNullException("columnType");
 
             var column = new ColumnInfo(columnName, columnType);
             column.IsNotNull = notNull;
             AddColumn(column);
             return column;
         }

void Deveel.Data.Sql.Tables.TableInfo.AddColumnSafe ( ColumnInfo column )

inlinepackage

Definition at line 203 of file TableInfo.cs.

                                                        {
             if (column == null)
                 throw new ArgumentNullException("column");
 
             AssertNotReadOnly();
 
             columnsCache.Clear();
             column.TableInfo = this;
             columns.Add(column);
         }

TableInfo Deveel.Data.Sql.Tables.TableInfo.Alias ( ObjectName alias )

inline

Definition at line 346 of file TableInfo.cs.

                                                  {
             return new TableInfo(alias, Id, IsPermanent, new ReadOnlyCollection<ColumnInfo>(columns), true);
         }

TableInfo Deveel.Data.Sql.Tables.TableInfo.AsReadOnly ( )

inline

Creates a new instance of TableInfo as an immutable copy of this table metadata.

Returns: Returns a new read-only instance of TableInfo that is a copy of this table metadata.

Definition at line 342 of file TableInfo.cs.

                                       {
             return new TableInfo(TableName, Id, IsPermanent, new ReadOnlyCollection<ColumnInfo>(columns), true);
         }

void Deveel.Data.Sql.Tables.TableInfo.AssertNotReadOnly ( )

inlineprivate

Definition at line 185 of file TableInfo.cs.

                                          {
             if (IsReadOnly)
                 throw new InvalidOperationException();
         }

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

inlinestatic

Definition at line 411 of file TableInfo.cs.

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

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

inlinestatic

Definition at line 416 of file TableInfo.cs.

                                                                                              {
             var version = reader.ReadInt32();
             if (version != 3)
                 throw new FormatException("Invalid version of the table info.");
 
             var catName = reader.ReadString();
             var schemName = reader.ReadString();
             var tableName = reader.ReadString();
 
             var objSchemaName = !String.IsNullOrEmpty(catName)
                 ? new ObjectName(new ObjectName(catName), schemName)
                 : new ObjectName(schemName);
 
             var objTableName = new ObjectName(objSchemaName, tableName);
 
             var tableInfo = new TableInfo(objTableName);
 
             var colCount = reader.ReadInt32();
             for (int i = 0; i < colCount; i++) {
                 var columnInfo = ColumnInfo.Deserialize(reader, typeResolver);
 
                 if (columnInfo != null)
                     tableInfo.AddColumn(columnInfo);
             }
 
             return tableInfo;
         }

void Deveel.Data.Sql.Tables.TableInfo.Establish ( int id )

inline

Definition at line 190 of file TableInfo.cs.

                                       {
             Id = id;
             IsPermanent = true;
         }

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

inlineprivate

Implements Deveel.Data.Serialization.ISerializable.

Definition at line 195 of file TableInfo.cs.

                                                        {
             data.SetValue("TableName", TableName);
             data.SetValue("TableId", Id);
             data.SetValue("ReadOnly", IsReadOnly);
             data.SetValue("Permanent", IsPermanent);
             data.SetValue("Columns", columns.ToArray());
         }

IEnumerator<ColumnInfo> Deveel.Data.Sql.Tables.TableInfo.GetEnumerator ( )

inline

Definition at line 293 of file TableInfo.cs.

                                                        {
             return columns.GetEnumerator();
         }

IEnumerator IEnumerable. Deveel.Data.Sql.Tables.TableInfo.GetEnumerator ( )

inlineprivate

Definition at line 297 of file TableInfo.cs.

                                                 {
             return GetEnumerator();
         }

int Deveel.Data.Sql.Tables.TableInfo.IndexOfColumn ( string columnName )

inline

Gets the offset of the column with the given name.

Parameters

columnName The name of the column of which to get the offset.

Returns: Returns a zero-based index of a column with the given name, if defined by the table metadata, or -1 otherwise.

Definition at line 310 of file TableInfo.cs.

                                                     {
             return IndexOfColumn(new ObjectName(TableName, columnName));
         }

int Deveel.Data.Sql.Tables.TableInfo.IndexOfColumn ( ObjectName columnName )

inline

Definition at line 314 of file TableInfo.cs.

                                                         {
             int index;
             if (!columnsCache.TryGetValue(columnName, out index)) {
                 bool found = false;
                 for (int i = 0; i < columns.Count; i++) {
                     var column = columns[i];
                     if (column.ColumnName.Equals(columnName.Name, StringComparison.Ordinal)) {
                         index = i;
                         columnsCache[columnName] = index;
                         found = true;
                     }
                 }
 
                 if (!found)
                     index = -1;
             }
 
             return index;
         }

IEnumerable<int> Deveel.Data.Sql.Tables.TableInfo.IndexOfColumns ( IEnumerable< string > columnNames )

inline

Definition at line 380 of file TableInfo.cs.

                                                                                 {
             if (columnNames == null)
                 return new int[0];
 
             return columnNames.Select(IndexOfColumn).ToArray();
         }

SqlExpression Deveel.Data.Sql.Tables.TableInfo.ResolveColumns	(	bool	ignoreCase,
		SqlExpression	expression
	)

inlinepackage

Definition at line 350 of file TableInfo.cs.

                                                                                          {
             var visitor = new ColumnsResolver(this, ignoreCase);
             return visitor.Visit(expression);
         }

static void Deveel.Data.Sql.Tables.TableInfo.Serialize	(	TableInfo	tableInfo,
		Stream	stream
	)

inlinestatic

Definition at line 387 of file TableInfo.cs.

                                                                          {
             var writer = new BinaryWriter(stream, Encoding.Unicode);
             Serialize(tableInfo, writer);
         }

static void Deveel.Data.Sql.Tables.TableInfo.Serialize	(	TableInfo	tableInfo,
		BinaryWriter	writer
	)

inlinestatic

Definition at line 392 of file TableInfo.cs.

                                                                                {
             writer.Write(3);    // Version
 
             var catName = tableInfo.CatalogName;
             if (catName == null)
                 catName = String.Empty;
 
             writer.Write(catName);
             writer.Write(tableInfo.SchemaName.Name);
             writer.Write(tableInfo.Name);
 
             var colCount = tableInfo.columns.Count;
             writer.Write(colCount);
             for (int i = 0; i < colCount; i++) {
                 var column = tableInfo.columns[i];
                 ColumnInfo.Serialize(column, writer);
             }
         }

Member Data Documentation

readonly IList<ColumnInfo> Deveel.Data.Sql.Tables.TableInfo.columns

private

Definition at line 42 of file TableInfo.cs.

readonly Dictionary<ObjectName, int> Deveel.Data.Sql.Tables.TableInfo.columnsCache

private

Definition at line 43 of file TableInfo.cs.

Property Documentation

string Deveel.Data.Sql.Tables.TableInfo.CatalogName

get

Gets the name of the catalog containing the table, if defined.

Definition at line 136 of file TableInfo.cs.

int Deveel.Data.Sql.Tables.TableInfo.ColumnCount

get

Gets a count of the columns defined by this object.

Definition at line 159 of file TableInfo.cs.

ObjectName IObjectInfo. Deveel.Data.Sql.Tables.TableInfo.FullName

getprivate

Definition at line 99 of file TableInfo.cs.

int Deveel.Data.Sql.Tables.TableInfo.Id

getprivate set

Gets a unique identifier of the table in a database system.

See also: IsPermanent

Definition at line 107 of file TableInfo.cs.

bool Deveel.Data.Sql.Tables.TableInfo.IsPermanent

getprivate set

Gets a value that indicates if the table is permanent.

See also: ITransaction.CreateTable

Definition at line 113 of file TableInfo.cs.

bool Deveel.Data.Sql.Tables.TableInfo.IsReadOnly

getprivate set

Gets a boolean value that indicates if the structure of this table cannot be altered.

Definition at line 153 of file TableInfo.cs.

string Deveel.Data.Sql.Tables.TableInfo.Name

get

Gets the name part of the table name.

See also: TableName, ObjectName.Name

Definition at line 120 of file TableInfo.cs.

DbObjectType IObjectInfo. Deveel.Data.Sql.Tables.TableInfo.ObjectType

getprivate

Definition at line 89 of file TableInfo.cs.

ObjectName Deveel.Data.Sql.Tables.TableInfo.SchemaName

get

Gets the schema name part of the table name.

See also: TableName, ObjectName.Parent

Definition at line 129 of file TableInfo.cs.

ObjectName Deveel.Data.Sql.Tables.TableInfo.TableName

getprivate set

Gets the fully qualified name of the table that is ensured to be unique within the system.

Definition at line 97 of file TableInfo.cs.

ColumnInfo Deveel.Data.Sql.Tables.TableInfo.this[int offset]

get

Gets the column object defined at the given offset within the table.

Parameters

offset The zero-based offset of the column to return.

Returns: Returns an object of type ColumnInfo that is at the given offset within the table.

Exceptions

ArgumentOutOfRangeException If the given offset is less than zero or greater or equal than the number of columns defined in the table.

Definition at line 176 of file TableInfo.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/TableInfo.cs

Classes

Public Member Functions

Static Public Member Functions

Package Functions

Properties

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation