This documentation is for the unstable version of GoodData, currrently in development.
For stable version, go to the latest stable version of this article.
DataFrameFactory.

for_exec_def

for_exec_def( exec_def: ExecutionDefinition, label_overrides: Optional[LabelOverrides], result_size_dimensions_limits: ResultSizeDimensions, result_size_bytes_limit: Optional[int], page_size: int ) -> Tuple[pandas.DataFrame, DataFrameMetadata]

Creates a data frame using an execution definition.

Each dimension may be sliced by multiple labels. The factory will create MultiIndex for the dataframe's row index and the columns. Example of label_overrides structure: .. code-block:: python { "labels": { "local_attribute_id": { "title": "My new attribute label" ,... }, "metrics": { "local_metric_id": { "title": "My new metric label" },... } }

Parameters

nametypedescription
exec_defExecutionDefinitionExecution definition.
label_overridesOptional[LabelOverrides]Label overrides for metrics and attributes.
result_size_dimensions_limitsResultSizeDimensionsA tuple containing maximum size of result dimensions.
result_size_bytes_limitOptional[int]Maximum size of result in bytes.
page_sizeintNumber of records per page.

Returns

typedescription
Tuple[pandas.DataFrame, DataFrameMetadata]Tuple holding DataFrame and DataFrame metadata.