_table_reference#

Object to reference Tables.

Functions#

lookup_domain()

Return the domain of the target of a reference.

lookup_metric()

Return the metric of the target of a reference.

find_children()

Return the children of a reference, or None if it references a single table.

find_named_tables()

Get a list of the names of all named tables in a domain.

find_reference()

Get a TableReference to the table with the given name.
lookup_domain(domain, ref)#

Return the domain of the target of a reference.

Parameters
Return type

tmlt.core.domains.base.Domain

lookup_metric(metric, ref)#

Return the metric of the target of a reference.

Parameters
Return type

tmlt.core.metrics.Metric

find_children(domain, ref)#

Return the children of a reference, or None if it references a single table.

Parameters
Return type

Optional[List[TableReference]]

find_named_tables(domain)#

Get a list of the names of all named tables in a domain.

Parameters

domain (tmlt.core.domains.base.Domain) –

Return type

List[TableReference]

find_reference(table_name, domain)#

Get a TableReference to the table with the given name.

Parameters

  • table_name (str) –

  • domain (tmlt.core.domains.base.Domain) –

Return type

Optional[TableReference]

Classes#

TableReference

A way to reference tables via their path.
class TableReference#

A way to reference tables via their path.

path :List[tmlt.analytics._table_identifier.Identifier]#

The path for the table reference, provided as a list of Identifiers.

property identifier#

Get the identifier, i.e. last path segment, of this reference.

Return type

tmlt.analytics._table_identifier.Identifier

property parent#

Get the parent of this reference.

Return type

TableReference

__truediv__(value)#

Add additional segment(s) to the path via the / operator.

Parameters

value (Union[TableReference, tmlt.analytics._table_identifier.Identifier]) –

Return type

TableReference