Skip to content

flowmachine.core.model_result

Source: flowmachine/core/model_result.py

ModelResult provides machinery to interface with results created outside of postgres.

Class ModelResult

ModelResult(parent: 'Model', run_args: Union[List[Any], NoneType] = None, run_kwargs: Union[Dict[Any, Any], NoneType] = None)
Source: flowmachine/core/model_result.py

Class representing a result calculated outside of the database.

Attributes

Parameters

  • parent: Model

    The Model this is a run of

  • run_args: typing.Union[typing.List[typing.Any], NoneType], default None

    List of arguments passed in the Model.run() method

  • run_kwargs: typing.Union[typing.Dict[typing.Any, typing.Any], NoneType], default None

    List of named arguments passed in the Model.run() method

Methods

to_sql

to_sql(self, name: str, schema: Union[str, NoneType] = None, store_dependencies: bool = False) -> concurrent.futures._base.Future
Source: flowmachine/core/model_result.py

Store the result of the calculation back into the database.

Parameters

  • name: str

    name of the table

  • schema: typing.Union[str, NoneType], default None

    Name of an existing schema. If none will use the postgres default, see postgres docs for more info.

  • store_dependencies: bool, default False

    If True, store the dependencies of this query.

Returns

  • concurrent.futures._base.Future

    Future object, containing this query and any result information.

Note

This method will return a Future immediately.

cache

cache
Source: flowmachine/core/query.py

Returns

  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/core/model_result.py

Returns the column names.

Returns

  • typing.List[str]

    List of the column names of this query.

column_names_as_string_list

column_names_as_string_list
Source: flowmachine/core/query.py

Get the column names as a comma separated list

Returns

  • str

    Comma separated list of column names

dependencies

dependencies
Source: flowmachine/core/query.py

Returns

  • set

    The set of queries which this one is directly dependent on.

fully_qualified_table_name

fully_qualified_table_name
Source: flowmachine/core/query.py

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
Source: flowmachine/core/query.py

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
Source: flowmachine/core/query.py

Returns

  • bool

    True if the table is stored, and False otherwise.

query_id

query_id
Source: flowmachine/core/query.py

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
Source: flowmachine/core/query.py

Return the current query state.

Returns

  • QueryState

    The current query state

query_state_str

query_state_str
Source: flowmachine/core/query.py

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
Source: flowmachine/core/query.py

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