mstrio.project_objects.incremental_refresh_report package

Submodules

mstrio.project_objects.incremental_refresh_report.incremental_refresh_report module

—————— WORK IN PROGRESS ——————

This functionality is a work-in-progress. Use it only if you understand the underlying code. It may change in future updates.

---

class mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.IncrementalRefreshReport(connection: Connection, id: str | None = None, name: str | None = None, show_expression_as: mstrio.modeling.expression.enums.ExpressionFormat | str = ExpressionFormat.TREE, show_filter_tokens: bool = False, show_advanced_properties: bool = False)

Bases: Entity, CopyMixin, MoveMixin, DeleteMixin, TranslationMixin

class IncrementType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

FILTER = 'filter'

REPORT = 'report'

class RefreshType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

DELETE = 'delete'

INSERT = 'insert'

REPLACE = 'replace'

UPDATE = 'update'

UPDATE_ONLY = 'update_only'

alter(name: str | None = None, target_cube: mstrio.project_objects.datasets.olap_cube.OlapCube | mstrio.modeling.schema.helpers.SchemaObjectReference | dict | None = None, increment_type: mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.IncrementalRefreshReport.IncrementType | str | None = None, refresh_type: mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.IncrementalRefreshReport.RefreshType | str | None = None, template: mstrio.project_objects.datasets.helpers.Template | dict | None = None, filter: mstrio.modeling.expression.expression.Expression | dict | None = None, advanced_properties: dict | None = None, description: str | None = None, primary_locale: str | None = None, is_embedded: bool | None = None, hidden: bool | None = None)

change_increment_type_to_filter() → None

classmethod create(connection: Connection, name: str, destination_folder: mstrio.object_management.folder.Folder | str, target_cube: mstrio.project_objects.datasets.olap_cube.OlapCube | mstrio.modeling.schema.helpers.SchemaObjectReference | dict, increment_type: mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.IncrementalRefreshReport.IncrementType | str, refresh_type: mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.IncrementalRefreshReport.RefreshType | str, template: mstrio.project_objects.datasets.helpers.Template | dict = None, filter: mstrio.modeling.expression.expression.Expression | dict | None = None, advanced_properties: dict | None = None, description: str | None = None, primary_locale: str | None = None, is_embedded: bool = False, show_expression_as: mstrio.modeling.expression.enums.ExpressionFormat | str = ExpressionFormat.TREE, show_filter_tokens: bool = False, show_advanced_properties: bool = False) → IncrementalRefreshReport

classmethod create_from_cube(connection: Connection, name: str, destination_folder: mstrio.object_management.folder.Folder | str, target_cube: mstrio.project_objects.datasets.olap_cube.OlapCube | mstrio.modeling.schema.helpers.SchemaObjectReference | dict, refresh_type: mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.IncrementalRefreshReport.RefreshType | str, filter: mstrio.modeling.expression.expression.Expression | dict | None = None, advanced_properties: dict | None = None, description: str | None = None, primary_locale: str | None = None, is_embedded: bool = False, show_expression_as: mstrio.modeling.expression.enums.ExpressionFormat | str = ExpressionFormat.TREE, show_filter_tokens: bool = False, show_advanced_properties: bool = False) → IncrementalRefreshReport

execute(fields: str | None = None, project_id: str | None = None, project_name: str | None = None) → None

get_preview_data(offset: int | None = None, limit: int | None = None, fields: str | None = None) → DataFrame

classmethod list(connection: Connection, name: str | None = None, pattern: mstrio.object_management.search_enums.SearchPattern | int = SearchPattern.CONTAINS, project_id: str | None = None, project_name: str | None = None, to_dictionary: bool = False, limit: int | None = None, folder_id: str | None = None, filters: dict | None = None, show_expression_as: mstrio.modeling.expression.enums.ExpressionFormat | str = ExpressionFormat.TREE, show_filter_tokens: bool = False, show_advanced_properties: bool = False) → list[type[mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.IncrementalRefreshReport]] | list[dict]

list_applicable_vldb_properties() → dict

reset_template_to_default() → None

mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.list_incremental_refresh_reports(connection: Connection, name: str | None = None, pattern: mstrio.object_management.search_enums.SearchPattern | int = SearchPattern.CONTAINS, project_id: str | None = None, project_name: str | None = None, to_dictionary: bool = False, limit: int | None = None, folder_id: str | None = None, filters: dict | None = None, show_expression_as: mstrio.modeling.expression.enums.ExpressionFormat | str = ExpressionFormat.TREE, show_filter_tokens: bool = False, show_advanced_properties: bool = False) → list[type[mstrio.project_objects.incremental_refresh_report.incremental_refresh_report.IncrementalRefreshReport]] | list[dict]

Module contents