Skip to content

flowmachine.core.geotable

Source: flowmachine/core/geotable.py

Simple utility class that represents tables with geometry.

Class GeoTable

GeoTable(
    name=None, schema=None, columns=None, geom_column="geom", gid_column=None
)
Source: flowmachine/core/geotable.py

Provides an interface to get a representation of a table with geographic information.

Attributes

Parameters

  • name: str

    Name of the table, may be fully qualified

  • schema: optional, str, default None

    Optional if name is fully qualified

  • columns: optional, str, default None

    Optional list of columns

  • geom_column: optional, str, default "geom"

    Name of the column containing geometry

  • gid_column: optional, str, default None

    Name of the column containing a gid, if set to None gid will be row numbers unless a gid column is present.

Examples

t = GeoTable(name="admin3", schema="geography")
t.to_geojson()['features'][0]
 ..
  'type': 'MultiPolygon'},
 'id': 1,
 'properties': {'admin0name': 'Nepal',
  'admin0pcod': 'NP',
  'admin1name': 'Central Development Region',
  'admin1pcod': '524 2',
  'admin2name': 'Bagmati',
  'admin2pcod': '524 2 05',

Methods

cache

cache
Source: flowmachine/core/query.py

Returns

  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/core/table.py

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/table.py

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/table.py

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