mstrio.project_objects.incremental_refresh_report package¶
Submodules¶
mstrio.project_objects.incremental_refresh_report.advanced_properties 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.advanced_properties.AdvancedProperties(vldb_properties: Optional[dict] = None, metric_join_types: Optional[dict] = None, attribute_join_types: Optional[dict] = None)¶
Bases:
Dictable- attribute_join_types: Optional[dict] = None¶
- metric_join_types: Optional[dict] = None¶
- to_dict(camel_case: bool = True) dict¶
Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.
- Parameters:
camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.
- Returns:
- A dictionary representation of object’s attributes and values.
By default, the dictionary keys are in camel case.
- Return type:
dict
- vldb_properties: Optional[dict] = None¶
- class mstrio.project_objects.incremental_refresh_report.advanced_properties.AttributeJoinType(attribute: mstrio.modeling.schema.helpers.SchemaObjectReference, no_participation_in_preserve_row: bool, resolved_location: mstrio.project_objects.incremental_refresh_report.advanced_properties.PropertyLocation)¶
Bases:
Dictable- attribute: SchemaObjectReference¶
- no_participation_in_preserve_row: bool¶
- resolved_location: PropertyLocation¶
- class mstrio.project_objects.incremental_refresh_report.advanced_properties.JoinType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
AutoName- INNER = 'inner'¶
- OUTER = 'outer'¶
- class mstrio.project_objects.incremental_refresh_report.advanced_properties.MetricJoinType(metric: mstrio.modeling.schema.helpers.SchemaObjectReference, join_type: mstrio.project_objects.incremental_refresh_report.advanced_properties.JoinType, resolved_location: mstrio.project_objects.incremental_refresh_report.advanced_properties.PropertyLocation)¶
Bases:
Dictable- metric: SchemaObjectReference¶
- resolved_location: PropertyLocation¶
- class mstrio.project_objects.incremental_refresh_report.advanced_properties.PropertyLocation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
AutoName- DBMS = 'dbms'¶
- DB_ROLE = 'db_role'¶
- DEFAULT = 'default'¶
- OBJECT = 'object'¶
- PROJECT = 'project'¶
- REPORT = 'report'¶
- REPORT_TARGET = 'report_target'¶
- TEMPLATE = 'template'¶
- TEMPLATE_TARGET = 'template_target'¶
- class mstrio.project_objects.incremental_refresh_report.advanced_properties.VLDBProperty(name: str, value: str, type: mstrio.project_objects.incremental_refresh_report.advanced_properties.VLDBPropertyType, resolved_location: mstrio.project_objects.incremental_refresh_report.advanced_properties.PropertyLocation)¶
Bases:
Dictable- name: str¶
- resolved_location: PropertyLocation¶
- type: VLDBPropertyType¶
- value: str¶
- class mstrio.project_objects.incremental_refresh_report.advanced_properties.VLDBPropertyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
AutoNameEnumeration constant indicating type of value of a VLDB property value
- BOOLEAN = 'boolean'¶
- DATE = 'date'¶
- DOUBLE = 'double'¶
- INT32 = 'int32'¶
- INT64 = 'int64'¶
- STRING = 'string'¶
- TIME = 'time'¶
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: Optional[str] = None, name: Optional[str] = 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- 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: Optional[str] = None, target_cube: Optional[Union[OlapCube, SchemaObjectReference, dict]] = None, increment_type: Optional[Union[IncrementType, str]] = None, refresh_type: Optional[Union[RefreshType, str]] = None, template: Optional[Union[Template, dict]] = None, filter: Optional[Union[Expression, dict]] = None, advanced_properties: Optional[dict] = None, description: Optional[str] = None, primary_locale: Optional[str] = None, is_embedded: Optional[bool] = 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.incremental_refresh_report.template.Template | dict = None, filter: Optional[Union[Expression, dict]] = None, advanced_properties: Optional[dict] = None, description: Optional[str] = None, primary_locale: Optional[str] = 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: Optional[Union[Expression, dict]] = None, advanced_properties: Optional[dict] = None, description: Optional[str] = None, primary_locale: Optional[str] = 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: Optional[str] = None, project_id: Optional[str] = None, project_name: Optional[str] = None) None¶
- get_preview_data(offset: Optional[int] = None, limit: Optional[int] = None, fields: Optional[str] = None) DataFrame¶
- classmethod list(connection: Connection, name: Optional[str] = None, project_id: Optional[str] = None, project_name: Optional[str] = None, to_dictionary: bool = False, limit: Optional[int] = None, folder_id: Optional[str] = None, filters: Optional[dict] = 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: Optional[str] = None, project_id: Optional[str] = None, project_name: Optional[str] = None, to_dictionary: bool = False, limit: Optional[int] = None, folder_id: Optional[str] = None, filters: Optional[dict] = 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]¶
mstrio.project_objects.incremental_refresh_report.template 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.template.AttributeFormReference(id: str, name: str)¶
Bases:
Dictable- id: str¶
- name: str¶
- class mstrio.project_objects.incremental_refresh_report.template.AttributeTemplateUnit(id: str, name: Optional[str] = None, alias: Optional[str] = None, forms: Optional[list[mstrio.project_objects.incremental_refresh_report.template.AttributeFormReference]] = None)¶
Bases:
TemplateUnit- alias: Optional[str] = None¶
- forms: Optional[list[mstrio.project_objects.incremental_refresh_report.template.AttributeFormReference]] = None¶
- id: str¶
- name: Optional[str] = None¶
- class mstrio.project_objects.incremental_refresh_report.template.MetricElement(id: str, name: Optional[str] = None, alias: Optional[str] = None)¶
Bases:
Dictable- alias: Optional[str] = None¶
- id: str¶
- name: Optional[str] = None¶
- to_dict(camel_case: bool = True) dict¶
Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.
- Parameters:
camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.
- Returns:
- A dictionary representation of object’s attributes and values.
By default, the dictionary keys are in camel case.
- Return type:
dict
- class mstrio.project_objects.incremental_refresh_report.template.MetricTemplateUnit(elements: list[mstrio.project_objects.incremental_refresh_report.template.MetricElement])¶
Bases:
TemplateUnit
- class mstrio.project_objects.incremental_refresh_report.template.Template(rows: list[mstrio.project_objects.incremental_refresh_report.template.TemplateUnit] = <factory>, columns: list[mstrio.project_objects.incremental_refresh_report.template.TemplateUnit] = <factory>, page_by: list[mstrio.project_objects.incremental_refresh_report.template.TemplateUnit] = <factory>)¶
Bases:
Dictable
- class mstrio.project_objects.incremental_refresh_report.template.TemplateUnit¶
Bases:
Dictable- static dispatch(source, connection: Optional[Connection] = None) Type[TemplateUnit]¶
- to_dict(camel_case: bool = True) dict¶
Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.
- Parameters:
camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.
- Returns:
- A dictionary representation of object’s attributes and values.
By default, the dictionary keys are in camel case.
- Return type:
dict
- class mstrio.project_objects.incremental_refresh_report.template.TemplateUnitType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
AutoName- ATTRIBUTE = 'attribute'¶
- CONSOLIDATION = 'consolidation'¶
- CUSTOM_GROUP = 'custom_group'¶
- DIMENSION = 'dimension'¶
- METRICS = 'metrics'¶
- PROMPT = 'prompt'¶
- RAW_UNIT = 'raw_unit'¶