foundry_dev_tools.clients.foundry_stats module

foundry_dev_tools.clients.foundry_stats module#

Implementation of the foundry-stats API.

class foundry_dev_tools.clients.foundry_stats.FoundryStatsClient[source]#

Bases: APIClient

To be implemented/transferred.

api_name: ClassVar[str] = 'foundry-stats'#
api_foundry_stats(dataset_rid, end_transaction_rid, branch='master', **kwargs)[source]#

Returns row counts and size of the dataset/view.

Parameters:

  • dataset_rid (api_types.DatasetRid) – The dataset RID.

  • end_transaction_rid (api_types.TransactionRid) – The specific transaction RID, which will be used to return the statistics.

  • branch (api_types.Ref) – The branch to query

  • **kwargs – gets passed to APIClient.api_request()

Returns:

which has a json dict:

With the following structure: { datasetRid: str, branch: str, endTransactionRid: str, schemaId: str, computedDatasetStats: { rowCount: str | None, sizeInBytes: str, columnStats: { “…”: {nullCount: str | None, uniqueCount: str | None, avgLength: str | None, maxLength: str | None,} }, }, }

Return type:

requests.Response

Contents