fastpyxl.pivot.cache module

class fastpyxl.pivot.cache.CacheDefinition(invalid=None, saveData=None, refreshOnLoad=None, optimizeMemory=None, enableRefresh=None, refreshedBy=None, refreshedDate=None, refreshedDateIso=None, backgroundQuery=None, missingItemsLimit=None, createdVersion=None, refreshedVersion=None, minRefreshableVersion=None, recordCount=None, upgradeOnRefresh=None, tupleCache=None, supportSubquery=None, supportAdvancedDrill=None, cacheSource=None, cacheFields=(), cacheHierarchies=(), kpis=(), calculatedItems=(), calculatedMembers=(), dimensions=(), measureGroups=(), maps=(), extLst=None, id=None)

Bases: Serialisable

backgroundQuery: bool | None

cacheFields: list[CacheField]

cacheHierarchies: list[CacheHierarchy]

cacheSource: CacheSource | None

calculatedItems: list[CalculatedItem]

calculatedMembers: list[CalculatedMember]

createdVersion: int | None

dimensions: list[PivotDimension]

enableRefresh: bool | None

extLst: ExtensionList | None

id: str | None

invalid: bool | None

kpis: list[OLAPKPI]

maps: list[MeasureDimensionMap]

measureGroups: list[MeasureGroup]

mime_type = 'application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheDefinition+xml'

minRefreshableVersion: int | None

missingItemsLimit: int | None

optimizeMemory: bool | None

property path

recordCount: int | None

records = None

refreshOnLoad: bool | None

refreshedBy: str | None

refreshedDate: float | None

refreshedDateIso: datetime | None

refreshedVersion: int | None

rel_type = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotCacheDefinition'

saveData: bool | None

supportAdvancedDrill: bool | None

supportSubquery: bool | None

tagname = 'pivotCacheDefinition'

to_tree()

tupleCache: TupleCache | None

upgradeOnRefresh: bool | None

xml_order = ('cacheSource', 'cacheFields', 'cacheHierarchies', 'kpis', 'tupleCache', 'calculatedItems', 'calculatedMembers', 'dimensions', 'measureGroups', 'maps')

class fastpyxl.pivot.cache.CacheField(sharedItems=None, fieldGroup=None, mpMap=None, extLst=None, name=None, caption=None, propertyName=None, serverField=None, uniqueList=True, numFmtId=None, formula=None, sqlType=0, hierarchy=0, level=0, databaseField=True, mappingCount=None, memberPropertyField=None)

Bases: Serialisable

caption: str | None

databaseField: bool | None

extLst: ExtensionList | None

fieldGroup: FieldGroup | None

formula: str | None

hierarchy: int | None

level: int | None

mappingCount: int | None

memberPropertyField: bool | None

mpMap: Any

name: str | None

numFmtId: int | None

propertyName: str | None

serverField: bool | None

sharedItems: SharedItems | None

sqlType: int | None

tagname = 'cacheField'

uniqueList: bool | None

xml_order = ('sharedItems', 'fieldGroup', 'mpMap')

class fastpyxl.pivot.cache.CacheHierarchy(uniqueName='', caption=None, measure=False, set=False, parentSet=None, iconSet=0, attribute=None, time=None, keyAttribute=False, defaultMemberUniqueName=None, allUniqueName=None, allCaption=None, dimensionUniqueName=None, displayFolder=None, measureGroup=None, measures=False, count=None, oneField=False, memberValueDatatype=None, unbalanced=None, unbalancedGroup=None, hidden=False, fieldsUsage=(), groupLevels=(), extLst=None)

Bases: Serialisable

allCaption: str | None

allUniqueName: str | None

attribute: bool | None

caption: str | None

count: int | None

defaultMemberUniqueName: str | None

dimensionUniqueName: str | None

displayFolder: str | None

extLst: ExtensionList | None

fieldsUsage: list[FieldUsage]

groupLevels: list[GroupLevel]

hidden: bool | None

iconSet: int | None

keyAttribute: bool | None

measure: bool | None

measureGroup: str | None

measures: bool | None

memberValueDatatype: int | None

oneField: bool | None

parentSet: int | None

set: bool | None

tagname = 'cacheHierarchy'

time: bool | None

unbalanced: bool | None

unbalancedGroup: bool | None

uniqueName: str | None

xml_order = ('fieldsUsage', 'groupLevels')

class fastpyxl.pivot.cache.CacheSource(type=None, connectionId=None, worksheetSource=None, consolidation=None, extLst=None)

Bases: Serialisable

connectionId: int | None

consolidation: Consolidation | None

extLst: ExtensionList | None

tagname = 'cacheSource'

type: str | None

worksheetSource: WorksheetSource | None

xml_order = ('worksheetSource', 'consolidation')

class fastpyxl.pivot.cache.CalculatedItem(field=None, formula=None, pivotArea=None, extLst=None)

Bases: Serialisable

extLst: ExtensionList | None

field: int | None

formula: str | None

pivotArea: PivotArea | None

tagname = 'calculatedItem'

xml_order = ('pivotArea', 'extLst')

class fastpyxl.pivot.cache.CalculatedMember(name=None, mdx=None, memberName=None, hierarchy=None, parent=None, solveOrder=None, set=None, extLst=None)

Bases: Serialisable

extLst: ExtensionList | None

hierarchy: str | None

mdx: str | None

memberName: str | None

name: str | None

parent: str | None

set: bool | None

solveOrder: int | None

tagname = 'calculatedMember'

xml_order = ()

class fastpyxl.pivot.cache.Consolidation(autoPage=None, pages=(), rangeSets=())

Bases: Serialisable

autoPage: bool | None

pages: list[PageItem]

rangeSets: list[RangeSet]

tagname = 'consolidation'

xml_order = ('pages', 'rangeSets')

class fastpyxl.pivot.cache.FieldGroup(par=None, base=None, rangePr=None, discretePr=(), groupItems=None)

Bases: Serialisable

base: int | None

discretePr: list[Any]

groupItems: GroupItems | None

par: int | None

rangePr: RangePr | None

tagname = 'fieldGroup'

xml_order = ('rangePr', 'discretePr', 'groupItems')

class fastpyxl.pivot.cache.FieldUsage(x=None)

Bases: Serialisable

tagname = 'fieldUsage'

x: int | None

class fastpyxl.pivot.cache.GroupItems(count=None, m=(), n=(), b=(), e=(), s=(), d=())

Bases: Serialisable

b: list[Boolean]

property count

d: list[DateTimeField]

e: list[Error]

m: list[Missing]

n: list[Number]

s: list[Text]

tagname = 'groupItems'

xml_order = ('m', 'n', 'b', 'e', 's', 'd')

class fastpyxl.pivot.cache.GroupLevel(uniqueName=None, caption=None, user=None, customRollUp=None, groups=(), extLst=None)

Bases: Serialisable

caption: str | None

customRollUp: bool | None

extLst: ExtensionList | None

groups: list[LevelGroup]

tagname = 'groupLevel'

uniqueName: str | None

user: bool | None

xml_order = ('groups', 'extLst')

class fastpyxl.pivot.cache.GroupMember(uniqueName=None, group=False)

Bases: Serialisable

group: bool | None

tagname = 'groupMember'

uniqueName: str | None

class fastpyxl.pivot.cache.LevelGroup(name=None, uniqueName=None, caption=None, uniqueParent=None, id=None, groupMembers=())

Bases: Serialisable

caption: str | None

groupMembers: list[GroupMember] | None

id: int | None

name: str | None

tagname = 'group'

uniqueName: str | None

uniqueParent: str | None

xml_order = ('groupMembers',)

class fastpyxl.pivot.cache.MeasureDimensionMap(measureGroup=None, dimension=None)

Bases: Serialisable

dimension: int | None

measureGroup: int | None

tagname = 'map'

class fastpyxl.pivot.cache.MeasureGroup(name=None, caption=None)

Bases: Serialisable

caption: str | None

name: str | None

tagname = 'measureGroup'

class fastpyxl.pivot.cache.OLAPKPI(uniqueName=None, caption=None, displayFolder=None, measureGroup=None, parent=None, value=None, goal=None, status=None, trend=None, weight=None, time=None)

Bases: Serialisable

caption: str | None

displayFolder: str | None

goal: str | None

measureGroup: str | None

parent: str | None

status: str | None

tagname = 'kpi'

time: str | None

trend: str | None

uniqueName: str | None

value: str | None

weight: str | None

class fastpyxl.pivot.cache.OLAPSet(count=None, maxRank=None, setDefinition=None, sortType=None, queryFailed=None, tpls=None, sortByTuple=None)

Bases: Serialisable

count: int | None

maxRank: int | None

queryFailed: bool | None

setDefinition: str | None

sortByTuple: TupleList | None

sortType: str | None

tagname = 'set'

tpls: TupleList | None

xml_order = ('tpls', 'sortByTuple')

class fastpyxl.pivot.cache.PCDSDTCEntries(count=None, m=None, n=None, e=None, s=None)

Bases: Serialisable

count: int | None

e: Error | None

m: Missing | None

n: Number | None

s: Text | None

tagname = 'entries'

xml_order = ('m', 'n', 'e', 's')

class fastpyxl.pivot.cache.PageItem(name=None)

Bases: Serialisable

name: str | None

tagname = 'pageItem'

class fastpyxl.pivot.cache.PivotDimension(measure=None, name=None, uniqueName=None, caption=None)

Bases: Serialisable

caption: str | None

measure: bool | None

name: str | None

tagname = 'dimension'

uniqueName: str | None

class fastpyxl.pivot.cache.Query(mdx=None, tpls=None)

Bases: Serialisable

mdx: str | None

tagname = 'query'

tpls: TupleList | None

xml_order = ('tpls',)

class fastpyxl.pivot.cache.RangePr(autoStart=True, autoEnd=True, groupBy='range', startNum=None, endNum=None, startDate=None, endDate=None, groupInterval=1)

Bases: Serialisable

autoEnd: bool | None

autoStart: bool | None

endDate: datetime | None

endNum: float | None

groupBy: str | None

groupInterval: float | None

startDate: datetime | None

startNum: float | None

tagname = 'rangePr'

class fastpyxl.pivot.cache.RangeSet(i1=None, i2=None, i3=None, i4=None, ref=None, name=None, sheet=None)

Bases: Serialisable

i1: int | None

i2: int | None

i3: int | None

i4: int | None

name: str | None

ref: str | None

sheet: str | None

tagname = 'rangeSet'

class fastpyxl.pivot.cache.ServerFormat(culture=None, format=None)

Bases: Serialisable

culture: str | None

format: str | None

tagname = 'serverFormat'

class fastpyxl.pivot.cache.SharedItems(_fields=(), containsSemiMixedTypes=None, containsNonDate=None, containsDate=None, containsString=None, containsBlank=None, containsMixedTypes=None, containsNumber=None, containsInteger=None, minValue=None, maxValue=None, minDate=None, maxDate=None, count=None, longText=None)

Bases: Serialisable

containsBlank: bool | None

containsDate: bool | None

containsInteger: bool | None

containsMixedTypes: bool | None

containsNonDate: bool | None

containsNumber: bool | None

containsSemiMixedTypes: bool | None

containsString: bool | None

property count

longText: bool | None

maxDate: datetime | None

maxValue: float | None

minDate: datetime | None

minValue: float | None

tagname = 'sharedItems'

xml_order = ()

class fastpyxl.pivot.cache.TupleCache(entries=None, sets=(), queryCache=(), serverFormats=(), extLst=None)

Bases: Serialisable

entries: PCDSDTCEntries | None

extLst: ExtensionList | None

queryCache: list[Query]

serverFormats: list[ServerFormat]

sets: list[OLAPSet]

tagname = 'tupleCache'

xml_order = ('entries', 'sets', 'queryCache', 'serverFormats', 'extLst')

class fastpyxl.pivot.cache.WorksheetSource(ref=None, name=None, sheet=None)

Bases: Serialisable

name: str | None

ref: str | None

sheet: str | None

tagname = 'worksheetSource'