flowmachine.features.spatial.versioned_infrastructure¶
Source: flowmachine/features/spatial/versioned_infrastructure.py
Versioned Infrastructure¶
Methods for fetching a set of versioned infrastructure elements. A version is selected based on the date in which that version is valid.
Class VersionedInfrastructure¶
VersionedInfrastructure(table="sites", date=None)
Simple class that returns the set of infrastructure elements (either sites
or cells
) that are valid for a given date. This class uses those tables' versioning scheme to figure out what set of towers is valid.
Attributes¶
Parameters¶
-
table
:str
Infrastructure table to use. This can either be
sites
orcells
. No other table is supported. -
date
:str
Date in ISO format
2016-01-22
. This is the date in which an infrastructure element is valid for. If no date is provided (i.e. None), the current date will be used (i.e.datetime.now()
).
Methods¶
cache¶
cache
Returns¶
-
bool
True is caching is switched on.
column_names¶
column_names
Returns the column names.
Returns¶
-
typing.List
List of the column names of this query.
column_names_as_string_list¶
column_names_as_string_list
Get the column names as a comma separated list
Returns¶
-
str
Comma separated list of column names
dependencies¶
dependencies
Returns¶
-
set
The set of queries which this one is directly dependent on.
fully_qualified_table_name¶
fully_qualified_table_name
Returns a unique fully qualified name for the query to be stored as under the cache schema, based on a hash of the parameters, class, and subqueries.
Returns¶
-
str
String form of the table's fqn
index_cols¶
index_cols
A list of columns to use as indexes when storing this query.
Returns¶
-
ixen
:list
By default, returns the location columns if they are present and self.spatial_unit is defined, and the subscriber column.
Examples¶
daily_location("2016-01-01").index_cols
[['name'], '"subscriber"']
is_stored¶
is_stored
Returns¶
-
bool
True if the table is stored, and False otherwise.
query_id¶
query_id
Generate a uniquely identifying hash of this query, based on the parameters of it and the subqueries it is composed of.
Returns¶
-
str
query_id hash string
query_state¶
query_state
Return the current query state.
Returns¶
-
QueryState
The current query state
query_state_str¶
query_state_str
Return the current query state as a string
Returns¶
-
str
The current query state. The possible values are the ones defined in
flowmachine.core.query_state.QueryState
.
table_name¶
table_name
Returns a uniquename for the query to be stored as, based on a hash of the parameters, class, and subqueries.
Returns¶
-
str
String form of the table's fqn