dataframe.DataFrameFactory
Factory to create pandas.DataFrame instances.
Methods: - indexed(self, index_by: IndexDef, columns:ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]] = None) -> pandas.DataFrame: - not_indexed(self, columns: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]] = None) -> pandas.DataFrame: - for_items(self, items: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]] = None, auto_index: bool = True) -> pandas.DataFrame: - for_visualization(self, visualization_id: str, auto_index: bool = True) -> pandas.DataFrame: - result_cache_metadata_for_exec_result_id(self, result_id: str) -> ResultCacheMetadata: - for_exec_def(self, exec_def: ExecutionDefinition, label_overrides: Optional[LabelOverrides] = None, result_size_dimensions_limits: ResultSizeDimensions = (), result_size_bytes_limit: Optional[int] = None, page_size: int = _DEFAULT_PAGE_SIZE,) -> Tuple[pandas.DataFrame, DataFrameMetadata]: - for_exec_result_id(self, result_id: str, label_overrides: Optional[LabelOverrides] = None, result_cache_metadata: Optional[ResultCacheMetadata] = None, result_size_dimensions_limits: ResultSizeDimensions = (), result_size_bytes_limit: Optional[int] = None, use_local_ids_in_headers: bool = False, page_size: int = _DEFAULT_PAGE_SIZE,) -> Tuple[pandas.DataFrame, DataFrameMetadata]:
Properties
NoneMethods
| Name | Description |
|---|---|
| for_exec_def ( exec_def: ExecutionDefinition, label_overrides: Optional[LabelOverrides], result_size_dimensions_limits: ResultSizeDimensions, result_size_bytes_limit: Optional[int], page_size: int ) | Creates a data frame using an execution definition. |
| for_exec_result_id ( result_id: str, label_overrides: Optional[LabelOverrides], result_cache_metadata: Optional[ResultCacheMetadata], result_size_dimensions_limits: ResultSizeDimensions, result_size_bytes_limit: Optional[int], use_local_ids_in_headers: bool, use_primary_labels_in_attributes: bool, page_size: int ) | Retrieves a DataFrame and DataFrame metadata for a given execution result identifier. |
| for_items ( items: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]], auto_index: bool ) | Creates a data frame for named items. This is a convenience method that will create DataFrame with or |
| for_visualization ( visualization_id: str, auto_index: bool ) | Creates a data frame with columns based on the content of the visualization with the provided identifier. |
| indexed ( index_by: IndexDef, columns: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]] ) | Creates a data frame indexed by values of the label. The data frame columns will be created from either |
| not_indexed ( columns: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]] ) | Creates a data frame with columns created from metrics and or labels. |
| result_cache_metadata_for_exec_result_id ( result_id: str ) | Retrieves result cache metadata for given :result_id: |