flowmachine.core.dummy_query¶
Source: flowmachine/core/dummy_query.py
A dummy query class, primarily useful for testing.
Class DummyQuery¶
DummyQuery(dummy_param)
Dummy query which can be used for testing. It does not write to the database.
Attributes¶
Methods¶
explain¶
explain(self, format="json", analyse=False)
Override Query.explain so that no SQL is executed
store¶
store(self, store_dependencies=False)
Store the results of this computation with the correct table name using a background thread.
Parameters¶
-
store_dependencies
:bool
, defaultFalse
If True, store the dependencies of this query.
Returns¶
-
Future
Future object which can be queried to check the query is stored.
cache¶
cache
Returns¶
-
bool
True is caching is switched on.
column_names¶
column_names
Returns the column names.
Returns¶
-
list
ofstr
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
Determine dummy 'stored' status from redis, instead of checking the database.
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