Deveel.Data.Sql.Query.IFromTableSource Interface Reference

A single table resource item in a query which handles the behaviour of resolving references to columns as well as providing various base utility methods for resolving general variable names. More...

Inheritance diagram for Deveel.Data.Sql.Query.IFromTableSource:

Public Member Functions
bool	MatchesReference (string catalog, string schema, string table)
	Checks if the table matches the given catalog, schema and table. More...
int	ResolveColumnCount (string catalog, string schema, string table, string column)
	Returns the number of instances we can resolve the given catalog, schema, table and column name to a column or columns within the current source. More...
ObjectName	ResolveColumn (string catalog, string schema, string table, string column)
	Resolves a variable within the current source. More...

Properties
string	UniqueName [get]
	Gets a unique name given to this table source. More...
ObjectName[]	ColumnNames [get]
	Returns an array of ObjectName objects that references each column available in the table set item in order from left column to right column. More...

Detailed Description

A single table resource item in a query which handles the behaviour of resolving references to columns as well as providing various base utility methods for resolving general variable names.

Each instance of this interface represents a single FROM resource.

Definition at line 29 of file IFromTableSource.cs.

Member Function Documentation

bool Deveel.Data.Sql.Query.IFromTableSource.MatchesReference	(	string	catalog,
		string	schema,
		string	table
	)

Checks if the table matches the given catalog, schema and table.

Parameters

catalog	The catalog name used for the matching.
schema	The schema name used for the matching.
table	The table name used for the maching.

If any arguments are null then it is not included in the match.

Used for 'Part.*' type glob searches.

Returns

Returns true if this source matches the given catalog, schema and table, otherwise false.

Implemented in Deveel.Data.Sql.Query.FromTableDirectSource, and Deveel.Data.Sql.Query.FromTableSubQuerySource.

ObjectName Deveel.Data.Sql.Query.IFromTableSource.ResolveColumn	(	string	catalog,
		string	schema,
		string	table,
		string	column
	)

Resolves a variable within the current source.

Parameters

catalog
schema
table
column

This method does not have to check whether the parameters reference more than one column. If more than one column is referenced, the actual column returned is implementation specific.

Returns

Returns a ObjectName that is a fully resolved form of the given column in the current table set.

Implemented in Deveel.Data.Sql.Query.FromTableDirectSource, and Deveel.Data.Sql.Query.FromTableSubQuerySource.

int Deveel.Data.Sql.Query.IFromTableSource.ResolveColumnCount	(	string	catalog,
		string	schema,
		string	table,
		string	column
	)

Returns the number of instances we can resolve the given catalog, schema, table and column name to a column or columns within the current source.

Parameters

catalog
schema
table
column

Note that if catalog, schema, table or column is null then it means it doesn't matter.

Note that parameters of null, null, null, null, null, null, null, not null, null, null, not null, not null, null, not null, not null, not null, and not null, not null, not null, not null are only accepted.

For example, say we need to resolve the column 'id' the arguments are null, null, null, "id". This may resolve to multiple columns if there is a mixture of tables with "id" as a column.

Returns

Implemented in Deveel.Data.Sql.Query.FromTableSubQuerySource, and Deveel.Data.Sql.Query.FromTableDirectSource.

Property Documentation

ObjectName [] Deveel.Data.Sql.Query.IFromTableSource.ColumnNames

get

Returns an array of ObjectName objects that references each column available in the table set item in order from left column to right column.

Definition at line 43 of file IFromTableSource.cs.

string Deveel.Data.Sql.Query.IFromTableSource.UniqueName

get

Gets a unique name given to this table source.

No other sources will share this identifier string.

Definition at line 36 of file IFromTableSource.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.Query/IFromTableSource.cs