Skip to content

Commit

Permalink
add note that _get_statistics is meant to be run in parallel mode by …
Browse files Browse the repository at this point in the history
…default
  • Loading branch information
dbrakenhoff committed Nov 20, 2024
1 parent edd71e7 commit 4ebb58a
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion pastastore/connectors.py
Original file line number Diff line number Diff line change
Expand Up @@ -710,7 +710,13 @@ def _get_statistics(
connector: Union[None, BaseConnector] = None,
**kwargs,
) -> pd.Series:
"""Get statistics for a model in the store (internal method)."""
"""Get statistics for a model in the store (internal method).
This function was made to be run in parallel mode. For the odd user
that wants to run this function directly in sequential model using
an ArcticDBDConnector the connector argument must be passed in the kwargs
of the apply method.
"""
if connector is not None:
conn = connector
else:
Expand Down

0 comments on commit 4ebb58a

Please sign in to comment.