Skip to main content

reset_index

reset_index

Functions

Name Description
prefix_index Reindex node-tables and links with a prefix and a max number of digits
reindex_nodes Reindex all model-nodes to a new node_index series
reset_index Reset a model index to a given node_start and link_start number. Will result in sub-sequent node_ids and link_ids from node_start and link_start.

prefix_index

reset_index.prefix_index(
    model,
    prefix_id,
    max_digits=4,
    original_index_postfix='waterbeheerder',
)

Reindex node-tables and links with a prefix and a max number of digits

Args: model (Model): Model to be reindexed prefix_id (int): integer used as prefix max_digits (int, optional): max digits in original node_ids. Defaults to 4. original_index_postfix (str | None, optional): if provided the original index will be stored in a meta-column. Defaults to “waterbeheerder”.

Returns

Model: reindexed model

Raises

ValueError: If any node_id exceeds the max_digits limit

reindex_nodes

reset_index.reindex_nodes(
    model,
    node_index,
    original_index_postfix='waterbeheerder',
)

Reindex all model-nodes to a new node_index series

reset_index

reset_index.reset_index(
    model,
    node_start=1,
    link_start=1,
    original_index_postfix='waterbeheerder',
)

Reset a model index to a given node_start and link_start number. Will result in sub-sequent node_ids and link_ids from node_start and link_start.

Args: model (Model): Model to be reindexed node_start (int, optional): start node_id. Defaults to 1. link_start (int, optional): start link_id. Defaults to 1. original_index_postfix (str | None, optional): if provided the original index will be stored in a meta-column. Defaults to “waterbeheerder”.

Returns

Model: reindexed model