:tocdepth: 3

:py:mod:`gws.plugin.alkis.data.index`
=====================================

.. py:module:: gws.plugin.alkis.data.index


**Source code:** :source:`gws.plugin.alkis.data.index<gws/plugin/alkis/data/index.py>`



Module Contents
---------------



.. py:function:: all_flat_keys()

   Return a dict key->type for all flat keys in the Flurstueck structure.


.. py:function:: flatten_fs(fs: gws.plugin.alkis.data.types.Flurstueck, keys_to_extract: set[str]) -> list[dict]

   Flatten a Flurstueck into a list of dicts with keys from keys_to_extract.


.. py:function:: make_fsnummer(r: gws.plugin.alkis.data.types.FlurstueckRecord)

   Create a 'fsnummer' for a Flurstueck, which is 'flur-zaeher/nenner (folge)'.


.. py:function:: normalize_hausnummer(s)

   Clean up house number formatting.


.. py:class:: Object


   Bases: :py:obj:`gws.Node`

   GWS object tree node.

   .. py:attribute:: ALL_TABLES
      :value: ['place', 'flurstueck', 'lage', 'part', 'indexflurstueck', 'indexlage', 'indexgeom',...


   .. py:attribute:: columnDct

   .. py:attribute:: crs
      :type:  gws.Crs

   .. py:attribute:: db
      :type:  gws.plugin.postgres.provider.Object

   .. py:attribute:: excludeGemarkung
      :type:  set[str]

   .. py:attribute:: gemarkungFilter
      :type:  set[str]

   .. py:attribute:: HAUSNUMMER_NOT_NULL_VALUE
      :value: '*'


   .. py:attribute:: INSERT_SIZE
      :value: 5000


   .. py:attribute:: saMeta
      :type:  gws.lib.sa.MetaData

   .. py:attribute:: schema
      :type:  str

   .. py:attribute:: tables
      :type:  dict[str, gws.lib.sa.Table]

   .. py:attribute:: TABLES_BASIC

   .. py:attribute:: TABLES_BUCHUNG

   .. py:attribute:: TABLES_EIGENTUEMER

   .. py:attribute:: VERSION
      :value: '82'


   .. py:method:: activate()

      Activation hook.


   .. py:method:: configure()

      Configuration hook.


   .. py:method:: count_all(qo: gws.plugin.alkis.data.types.FlurstueckQueryOptions) -> int

   .. py:method:: create_table(table_id: str, values: list[dict], progress: Optional[gws.lib.cli.ProgressIndicator] = None)

   .. py:method:: default_land()

   .. py:method:: drop()

   .. py:method:: drop_table(table_id: str)

   .. py:method:: find_adresse(q: gws.plugin.alkis.data.types.AdresseQuery) -> list[gws.plugin.alkis.data.types.Adresse]

   .. py:method:: find_flurstueck(q: gws.plugin.alkis.data.types.FlurstueckQuery) -> list[gws.plugin.alkis.data.types.Flurstueck]

   .. py:method:: has_table(table_id: str) -> bool

   .. py:method:: iter_all(qo: gws.plugin.alkis.data.types.FlurstueckQueryOptions) -> Iterable[gws.plugin.alkis.data.types.Flurstueck]

   .. py:method:: load_flurstueck(fs_uids: list[str], qo: gws.plugin.alkis.data.types.FlurstueckQueryOptions) -> list[gws.plugin.alkis.data.types.Flurstueck]

   .. py:method:: status() -> gws.plugin.alkis.data.types.IndexStatus

   .. py:method:: strasse_list() -> list[gws.plugin.alkis.data.types.Strasse]

   .. py:method:: table(table_id: str) -> gws.lib.sa.Table

   .. py:method:: table_size(table_id) -> int


.. py:function:: parse_fsnummer(s)

   Parse a Flurstueck fsnummer into parts.


.. py:function:: serialize(o: gws.plugin.alkis.data.types.Object, encode_enum_pairs=True) -> dict

.. py:function:: strasse_key(s)

   Normalize a steet name for full-text search.


.. py:data:: TABLE_BUCHUNGSBLATT
   :value: 'buchungsblatt'


.. py:data:: TABLE_FLURSTUECK
   :value: 'flurstueck'


.. py:data:: TABLE_INDEXBUCHUNGSBLATT
   :value: 'indexbuchungsblatt'


.. py:data:: TABLE_INDEXFLURSTUECK
   :value: 'indexflurstueck'


.. py:data:: TABLE_INDEXGEOM
   :value: 'indexgeom'


.. py:data:: TABLE_INDEXLAGE
   :value: 'indexlage'


.. py:data:: TABLE_INDEXPERSON
   :value: 'indexperson'


.. py:data:: TABLE_LAGE
   :value: 'lage'


.. py:data:: TABLE_PART
   :value: 'part'


.. py:data:: TABLE_PLACE
   :value: 'place'


.. py:function:: text_key(s)

   Normalize a text string for full-text search.


.. py:function:: text_search_clause(column, val, tso: gws.TextSearchOptions)

.. py:function:: unserialize(data: dict)