DeveelDB: Deveel.Data.Sql.Tables.ITableContainer Interface Reference

DeveelDB 20151217

complete SQL database system, primarly developed for .NET/Mono frameworks

A container for any system tables that are generated from information inside the database engine. More...

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

Public Member Functions
int	FindByName (ObjectName name)
	Finds the index in this container of the given table by its name. More...

ObjectName	GetTableName (int offset)
	Gets the name of the table at the given index in this container. More...

TableInfo	GetTableInfo (int offset)
	Gets the information of the table at the given offset in this container. More...

string	GetTableType (int offset)
	Gets the type of the table at the given offset. More...

bool	ContainsTable (ObjectName name)
	Checks if a table with the given name is contained in the current context. More...

ITable	GetTable (int offset)
	Gets the table contained at the given offset within the context. More...

Properties
int	TableCount `[get]`
	Returns the total count of tables that this object is maintaining. More...

Detailed Description

A container for any system tables that are generated from information inside the database engine.

Implementations of this contract expose system tables that have a read-only access, and used to materialize system information as ITable

Definition at line 31 of file ITableContainer.cs.

Member Function Documentation

bool Deveel.Data.Sql.Tables.ITableContainer.ContainsTable ( ObjectName name )

Checks if a table with the given name is contained in the current context.

Parameters

name	The name of the table to search.

Returns: Returns true if any table with the given name was found in the container, false otherwise.

Implemented in Deveel.Data.Transactions.Transaction.OldAndNewTableContainer, Deveel.Data.Transactions.Transaction.TransactionTableContainer, Deveel.Data.Sql.Sequences.SequenceManager.SequenceTableContainer, and Deveel.Data.SystemTableContainer.

int Deveel.Data.Sql.Tables.ITableContainer.FindByName ( ObjectName name )

Finds the index in this container of the given table by its name.

Parameters

name	The name of the table to find.

Returns: Returns a zero-based index that represents the offset of the table identified by the given name within the context, ot -1 of not found.

Implemented in Deveel.Data.Transactions.Transaction.OldAndNewTableContainer, Deveel.Data.Transactions.Transaction.TransactionTableContainer, Deveel.Data.Sql.Sequences.SequenceManager.SequenceTableContainer, and Deveel.Data.SystemTableContainer.

ITable Deveel.Data.Sql.Tables.ITableContainer.GetTable ( int offset )

Gets the table contained at the given offset within the context.

Parameters

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

Returns: Returns an instance of ITable that provides access to the backed informaion for an object provided by the context.

Exceptions

ArgumentOutOfRangeException If the given offset is smaller than 0 or greater or equal than TableCount.

Implemented in Deveel.Data.Transactions.Transaction.OldAndNewTableContainer, Deveel.Data.Sql.Triggers.TriggerManager.TriggersTableContainer, Deveel.Data.Transactions.Transaction.TransactionTableContainer, Deveel.Data.Sql.Views.ViewManager.ViewTableContainer, Deveel.Data.Routines.RoutineManager.RoutinesTableContainer, Deveel.Data.Sql.Sequences.SequenceManager.SequenceTableContainer, and Deveel.Data.SystemTableContainer.

TableInfo Deveel.Data.Sql.Tables.ITableContainer.GetTableInfo ( int offset )

Gets the information of the table at the given offset in this container.

Parameters

offset The zero-based offset of the table whose information to return.

Returns

Returns an instance of

See also: TableInfo

that describes the metadata of a table at the given offset within the context.

Exceptions

ArgumentOutOfRangeException If the given offset is smaller than 0 or greater or equal than TableCount.

Implemented in Deveel.Data.Transactions.Transaction.OldAndNewTableContainer, Deveel.Data.Sql.Triggers.TriggerManager.TriggersTableContainer, Deveel.Data.Transactions.Transaction.TransactionTableContainer, Deveel.Data.Sql.Views.ViewManager.ViewTableContainer, Deveel.Data.Routines.RoutineManager.RoutinesTableContainer, Deveel.Data.Sql.Sequences.SequenceManager.SequenceTableContainer, and Deveel.Data.SystemTableContainer.

ObjectName Deveel.Data.Sql.Tables.ITableContainer.GetTableName ( int offset )

Gets the name of the table at the given index in this container.

Parameters

offset The zero-based offset of the table whose name to return.

Returns

Returns a

See also: ObjectName

that identifies the table.

Exceptions

ArgumentOutOfRangeException If the given offset is smaller than 0 or greater or equal than TableCount.

Implemented in Deveel.Data.Transactions.Transaction.OldAndNewTableContainer, Deveel.Data.Transactions.Transaction.TransactionTableContainer, Deveel.Data.Sql.Sequences.SequenceManager.SequenceTableContainer, and Deveel.Data.SystemTableContainer.

string Deveel.Data.Sql.Tables.ITableContainer.GetTableType ( int offset )

Gets the type of the table at the given offset.

Parameters

offset The zero-based offset of the table whose type to return.

Returns: Returns a String that describes the type of table at the given offset.

Exceptions

ArgumentOutOfRangeException If the given offset is smaller than 0 or greater or equal than TableCount.

Implemented in Deveel.Data.Transactions.Transaction.OldAndNewTableContainer, Deveel.Data.Sql.Triggers.TriggerManager.TriggersTableContainer, Deveel.Data.Transactions.Transaction.TransactionTableContainer, Deveel.Data.Sql.Views.ViewManager.ViewTableContainer, Deveel.Data.Routines.RoutineManager.RoutinesTableContainer, Deveel.Data.Sql.Sequences.SequenceManager.SequenceTableContainer, and Deveel.Data.SystemTableContainer.

Property Documentation

int Deveel.Data.Sql.Tables.ITableContainer.TableCount

get

Returns the total count of tables that this object is maintaining.

Definition at line 35 of file ITableContainer.cs.

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

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