Skip to content

schemas

layer

workspace

Classes:

Name Description
SchemaAttributeRule

ESRI Attribute Rule Schema
SchemaDataset

Esri Dataset Schema
SchemaDomain

ESRI Domain Schema
SchemaDomainCode

ESRI Domain Code Schema
SchemaExtent

ESRI Extent Schema
SchemaField

ESRI Field Schema
SchemaFieldInfo

ESRI FieldInfo Schema
SchemaGeometryDef

ESRI Geometry Definition Schema
SchemaIndex

ESRI Index Schema
SchemaIndexArray

ESRI Index Array Schema
SchemaParcelFabricController

ESRI Parcel Fabric Schema
SchemaPropertySet

ESRI Property Set Schema
SchemaRelationshipClasses

ESRI Relationship Classes Schema
SchemaSpatialRef

Esri Spatial Reference Schema
SchemaSubtype

ESRI Subtype Schema
SchemaTopologyController

ESRI Topology Controller Schema
SchemaTopologyRule

ESRI TopologyRule Schema
SchemaWorkspace

ESRI Workspace Schema

Attributes:

Name Type Description
ESRIAttributeRuleTrigger
ESRIAttributeRuleType
ESRIClientVersion
ESRIDatasetType
ESRIDomainMergePolicy
ESRIDomainSplitPolicy
ESRIDomainType
ESRIExtensionType
ESRIFeatureType
ESRIFieldType
ESRIGeometryType
ESRISplitModel
ESRITopologyRuleType
ESRIWorkspaceProgID
ESRIWorkspaceType
SchemaFieldArray

ESRIAttributeRuleTrigger = Literal['esriARTEUpdate', 'esriARTEInsert', 'esriARTEDelete'] module-attribute

ESRIAttributeRuleType = Literal['esriARTCalculation', 'esriARTValidation', 'esriARTConstraint'] module-attribute

ESRIClientVersion = Literal['10.0', '12.3'] module-attribute

ESRIDatasetType = Literal['DEWorkspace', 'esriDTFeatureClass', 'esriDTTable', 'esriDTTopology'] module-attribute

ESRIDomainMergePolicy = Literal['esriMPTDefaultValue'] module-attribute

ESRIDomainSplitPolicy = Literal['esriSPTDuplicate'] module-attribute

ESRIDomainType = Literal['codedValue'] module-attribute

ESRIExtensionType = Literal['PropertySet'] module-attribute

ESRIFeatureType = Literal['esriFTSimple'] module-attribute

ESRIFieldType = Literal['esriFieldTypeOID', 'esriFieldTypeString', 'esriFieldTypeInteger', 'esriFieldTypeDouble', 'esriFieldTypeGeometry'] module-attribute

ESRIGeometryType = Literal['esriGeometryPolyline'] module-attribute

ESRISplitModel = Literal['esriSMUpdateInsert'] module-attribute

ESRITopologyRuleType = Literal['esriTRTPointCoveredByLineEndpoint', 'esriTRTPointCoveredByLine', 'esriTRTPointCoincidePoint', 'esriTRTLineCoveredByLineClass', 'esriTRTLineEndpointCoveredByPoint', 'esriTRTLineNoMultipart', 'esriTRTLineNoSelfIntersect', 'esriTRTLineNoSelfOverlap'] module-attribute

ESRIWorkspaceProgID = Literal['esriDataSourcesGDB.FileGDBWorkspaceFactory'] module-attribute

ESRIWorkspaceType = Literal['esriLocalDatabaseWorkspace'] module-attribute

SchemaFieldArray = dict[Literal['fieldArray'], list[SchemaField]] module-attribute

SchemaAttributeRule

Bases: TypedDict

ESRI Attribute Rule Schema

Attributes:

Name Type Description
batch bool
category int
checkParameters SchemaPropertySet
creationTime int
description str
errorMessage str
errorNumber int
evaluationOrder int
excludeFromClientEvaluation bool
fieldName str
id int
isEnabled bool
name str
referencesExternalService bool
requiredGeodatabaseClientVersion ESRIClientVersion
scriptExpression str
severity int
subtypeCode int
subtypeCodes list[int]
tags str
triggeringEvents list[ESRIAttributeRuleTrigger]
triggeringFields list[str]
type ESRIAttributeRuleType
userEditable bool
Source code in src/arcpie/schemas/workspace.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
class SchemaAttributeRule(TypedDict):
    """ESRI Attribute Rule Schema"""
    id: int
    name: str
    type: ESRIAttributeRuleType
    evaluationOrder: int
    fieldName: str
    subtypeCode: int
    description: str
    errorNumber: int
    errorMessage: str
    userEditable: bool
    isEnabled: bool
    referencesExternalService: bool
    excludeFromClientEvaluation: bool
    scriptExpression: str
    triggeringEvents: list[ESRIAttributeRuleTrigger]
    checkParameters: SchemaPropertySet
    category: int
    severity: int
    tags: str
    batch: bool
    requiredGeodatabaseClientVersion: ESRIClientVersion
    creationTime: int
    triggeringFields: list[str]
    subtypeCodes: list[int]

batch instance-attribute

category instance-attribute

checkParameters instance-attribute

creationTime instance-attribute

description instance-attribute

errorMessage instance-attribute

errorNumber instance-attribute

evaluationOrder instance-attribute

excludeFromClientEvaluation instance-attribute

fieldName instance-attribute

id instance-attribute

isEnabled instance-attribute

name instance-attribute

referencesExternalService instance-attribute

requiredGeodatabaseClientVersion instance-attribute

scriptExpression instance-attribute

severity instance-attribute

subtypeCode instance-attribute

subtypeCodes instance-attribute

tags instance-attribute

triggeringEvents instance-attribute

triggeringFields instance-attribute

type instance-attribute

userEditable instance-attribute

SchemaDataset

Bases: TypedDict

Esri Dataset Schema

Attributes:

Name Type Description
aliasName str
areaFieldName str
attributeRules list[SchemaAttributeRule]
canVersion bool
catalogID str
catalogPath str
changeTracked bool
childrenExpanded bool
clsId str
clusterTolerance float
configurationKeyword str
controllerMemberships list[SchemaTopologyController | SchemaParcelFabricController]
createdAtFieldName str
creatorFieldName str
datasetType ESRIDatasetType
defaultSubtypeCode int
dsId int
editedAtFieldName str
editorTrackingEnabled bool
extClsId str
extensionProperties SchemaPropertySet
extent SchemaExtent
featureType ESRIFeatureType
fieldFilteringEnabled bool
fields SchemaFieldArray
globalIdFieldName str
hasGlobalID bool
hasM bool
hasOID bool
hasOID64 bool
hasSpatialIndex bool
hasZ bool
indexes SchemaIndexArray
isTimeInUTC bool
lastEditorFieldName str
layers list[dict[Literal['layerId'], str]]
lengthFieldName str
maxGeneratedErrorCount int
modelName str
name str
oidFieldName str
rasterFieldName str
relationshipClassNames SchemaRelationshipClasses
replicaTracked bool
requiredGeodatabaseClientVersion ESRIClientVersion
shapeFieldName str
shapeType ESRIGeometryType
spatialReference SchemaSpatialRef
splitModel ESRISplitModel
subtypeFieldName str
subtypes list[SchemaSubtype]
topologyRules list[SchemaTopologyRule]
versioned bool
zClusterTolerance float
Source code in src/arcpie/schemas/workspace.py 
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
class SchemaDataset(TypedDict):
    """Esri Dataset Schema"""
    catalogPath: str
    name: str
    childrenExpanded: bool
    datasetType: ESRIDatasetType
    dsId: int
    versioned: bool
    canVersion: bool
    configurationKeyword: str
    requiredGeodatabaseClientVersion: ESRIClientVersion
    changeTracked: bool
    replicaTracked: bool
    hasOID: bool
    hasOID64: bool
    oidFieldName: str
    fields: SchemaFieldArray
    indexes: SchemaIndexArray
    clsId: str
    extClsId: str
    relationshipClassNames: SchemaRelationshipClasses
    aliasName: str
    modelName: str
    hasGlobalID: bool
    globalIdFieldName: str
    rasterFieldName: str
    extensionProperties: SchemaPropertySet
    subtypeFieldName: str
    defaultSubtypeCode: int
    subtypes: list[SchemaSubtype]
    controllerMemberships: list[SchemaTopologyController | SchemaParcelFabricController]
    editorTrackingEnabled: bool
    creatorFieldName: str
    createdAtFieldName: str
    lastEditorFieldName: str
    editedAtFieldName: str
    isTimeInUTC: bool
    catalogID: str
    fieldFilteringEnabled: bool
    attributeRules: list[SchemaAttributeRule]
    featureType: ESRIFeatureType
    shapeType: ESRIGeometryType
    shapeFieldName: str
    hasM: bool
    hasZ: bool
    hasSpatialIndex: bool
    areaFieldName: str
    lengthFieldName: str
    extent: SchemaExtent
    spatialReference: SchemaSpatialRef
    splitModel: ESRISplitModel

    # Topology Keys (Move to a new TypedDict?)
    layers: list[dict[Literal['layerId'], str]]
    clusterTolerance: float
    zClusterTolerance: float
    maxGeneratedErrorCount: int
    topologyRules: list[SchemaTopologyRule]

aliasName instance-attribute

areaFieldName instance-attribute

attributeRules instance-attribute

canVersion instance-attribute

catalogID instance-attribute

catalogPath instance-attribute

changeTracked instance-attribute

childrenExpanded instance-attribute

clsId instance-attribute

clusterTolerance instance-attribute

configurationKeyword instance-attribute

controllerMemberships instance-attribute

createdAtFieldName instance-attribute

creatorFieldName instance-attribute

datasetType instance-attribute

defaultSubtypeCode instance-attribute

dsId instance-attribute

editedAtFieldName instance-attribute

editorTrackingEnabled instance-attribute

extClsId instance-attribute

extensionProperties instance-attribute

extent instance-attribute

featureType instance-attribute

fieldFilteringEnabled instance-attribute

fields instance-attribute

globalIdFieldName instance-attribute

hasGlobalID instance-attribute

hasM instance-attribute

hasOID instance-attribute

hasOID64 instance-attribute

hasSpatialIndex instance-attribute

hasZ instance-attribute

indexes instance-attribute

isTimeInUTC instance-attribute

lastEditorFieldName instance-attribute

layers instance-attribute

lengthFieldName instance-attribute

maxGeneratedErrorCount instance-attribute

modelName instance-attribute

name instance-attribute

oidFieldName instance-attribute

rasterFieldName instance-attribute

relationshipClassNames instance-attribute

replicaTracked instance-attribute

requiredGeodatabaseClientVersion instance-attribute

shapeFieldName instance-attribute

shapeType instance-attribute

spatialReference instance-attribute

splitModel instance-attribute

subtypeFieldName instance-attribute

subtypes instance-attribute

topologyRules instance-attribute

versioned instance-attribute

zClusterTolerance instance-attribute

SchemaDomain

Bases: TypedDict

ESRI Domain Schema

Attributes:

Name Type Description
codedValues list[SchemaDomainCode]
description str
domainName str
fieldType ESRIFieldType
mergePolicy ESRIDomainMergePolicy
splitPolicy ESRIDomainSplitPolicy
type ESRIDomainType
Source code in src/arcpie/schemas/workspace.py 
57
58
59
60
61
62
63
64
65
class SchemaDomain(TypedDict):
    """ESRI Domain Schema"""
    type: ESRIDomainType
    domainName: str
    description: str
    codedValues: list[SchemaDomainCode]
    fieldType: ESRIFieldType
    mergePolicy: ESRIDomainMergePolicy
    splitPolicy: ESRIDomainSplitPolicy

codedValues instance-attribute

description instance-attribute

domainName instance-attribute

fieldType instance-attribute

mergePolicy instance-attribute

splitPolicy instance-attribute

type instance-attribute

SchemaDomainCode

Bases: TypedDict

ESRI Domain Code Schema

Attributes:

Name Type Description
code str
name str
Source code in src/arcpie/schemas/workspace.py 
52
53
54
55
class SchemaDomainCode(TypedDict):
    """ESRI Domain Code Schema"""
    name: str
    code: str

code instance-attribute

name instance-attribute

SchemaExtent

Bases: TypedDict

ESRI Extent Schema

Attributes:

Name Type Description
spatialReference SchemaSpatialRef
xmax float | Literal['NaN']
xmin float | Literal['NaN']
ymax float | Literal['NaN']
ymin float | Literal['NaN']
Source code in src/arcpie/schemas/workspace.py 
153
154
155
156
157
158
159
class SchemaExtent(TypedDict):
    """ESRI Extent Schema"""
    xmin: float | Literal['NaN']
    ymin: float | Literal['NaN']
    xmax: float | Literal['NaN']
    ymax: float | Literal['NaN']
    spatialReference: SchemaSpatialRef

spatialReference instance-attribute

xmax instance-attribute

xmin instance-attribute

ymax instance-attribute

ymin instance-attribute

SchemaField

Bases: TypedDict

ESRI Field Schema

Attributes:

Name Type Description
aliasName str
domain SchemaDomain
editable bool
geometryDef SchemaGeometryDef
isNullable bool
length int
name str
precision int
required bool
scale int
type ESRIFieldType
Source code in src/arcpie/schemas/workspace.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
class SchemaField(TypedDict, total=False):
    """ESRI Field Schema"""
    name: str
    type: ESRIFieldType
    isNullable: bool
    length: int
    precision: int
    scale: int
    required: bool
    editable: bool
    aliasName: str
    geometryDef: SchemaGeometryDef
    domain: SchemaDomain

aliasName instance-attribute

domain instance-attribute

editable instance-attribute

geometryDef instance-attribute

isNullable instance-attribute

length instance-attribute

name instance-attribute

precision instance-attribute

required instance-attribute

scale instance-attribute

type instance-attribute

SchemaFieldInfo

Bases: TypedDict

ESRI FieldInfo Schema

Attributes:

Name Type Description
defaultValue Any
domainName str
fieldName str
Source code in src/arcpie/schemas/workspace.py 
114
115
116
117
118
class SchemaFieldInfo(TypedDict):
    """ESRI FieldInfo Schema"""
    fieldName: str
    domainName: str
    defaultValue: Any

defaultValue instance-attribute

domainName instance-attribute

fieldName instance-attribute

SchemaGeometryDef

Bases: TypedDict

ESRI Geometry Definition Schema

Attributes:

Name Type Description
avgNumPoints int
geometryType ESRIGeometryType
gridSize0 int
hasM bool
hasZ bool
spatialReference SchemaSpatialRef
Source code in src/arcpie/schemas/workspace.py 
72
73
74
75
76
77
78
79
class SchemaGeometryDef(TypedDict):
    """ESRI Geometry Definition Schema"""
    avgNumPoints: int
    geometryType: ESRIGeometryType
    hasM: bool
    hasZ: bool
    spatialReference: SchemaSpatialRef
    gridSize0: int

avgNumPoints instance-attribute

geometryType instance-attribute

gridSize0 instance-attribute

hasM instance-attribute

hasZ instance-attribute

spatialReference instance-attribute

SchemaIndex

Bases: TypedDict

ESRI Index Schema

Attributes:

Name Type Description
fields SchemaFieldArray
isAscending bool
isUnique bool
name str
Source code in src/arcpie/schemas/workspace.py 
 98
 99
100
101
102
103
class SchemaIndex(TypedDict):
    """ESRI Index Schema"""
    name: str
    isUnique: bool
    isAscending: bool
    fields: SchemaFieldArray

fields instance-attribute

isAscending instance-attribute

isUnique instance-attribute

name instance-attribute

SchemaIndexArray

Bases: TypedDict

ESRI Index Array Schema

Attributes:

Name Type Description
indexArray list[SchemaIndex]
Source code in src/arcpie/schemas/workspace.py 
105
106
107
class SchemaIndexArray(TypedDict):
    """ESRI Index Array Schema"""
    indexArray: list[SchemaIndex]

indexArray instance-attribute

SchemaParcelFabricController

Bases: TypedDict

ESRI Parcel Fabric Schema

Source code in src/arcpie/schemas/workspace.py 
173
174
175
class SchemaParcelFabricController(TypedDict):
    """ESRI Parcel Fabric Schema"""
    ...

SchemaPropertySet

Bases: TypedDict

ESRI Property Set Schema

Attributes:

Name Type Description
propertySetItems list[Any]
type Literal['PropertySet']
Source code in src/arcpie/schemas/workspace.py 
109
110
111
112
class SchemaPropertySet(TypedDict):
    """ESRI Property Set Schema"""
    type: Literal['PropertySet']
    propertySetItems: list[Any]

propertySetItems instance-attribute

type instance-attribute

SchemaRelationshipClasses

Bases: TypedDict

ESRI Relationship Classes Schema

Attributes:

Name Type Description
names list[str]
Source code in src/arcpie/schemas/workspace.py 
161
162
163
class SchemaRelationshipClasses(TypedDict):
    """ESRI Relationship Classes Schema"""
    names: list[str]

names instance-attribute

SchemaSpatialRef

Bases: TypedDict

Esri Spatial Reference Schema

Attributes:

Name Type Description
latestWkid int
wkid int
Source code in src/arcpie/schemas/workspace.py 
67
68
69
70
class SchemaSpatialRef(TypedDict):
    """Esri Spatial Reference Schema"""
    wkid: int
    latestWkid: int

latestWkid instance-attribute

wkid instance-attribute

SchemaSubtype

Bases: TypedDict

ESRI Subtype Schema

Attributes:

Name Type Description
fieldInfos list[SchemaFieldInfo]
subtypeCode int
subtypeName str
Source code in src/arcpie/schemas/workspace.py 
120
121
122
123
124
class SchemaSubtype(TypedDict):
    """ESRI Subtype Schema"""
    subtypeName: str
    subtypeCode: int
    fieldInfos: list[SchemaFieldInfo]

fieldInfos instance-attribute

subtypeCode instance-attribute

subtypeName instance-attribute

SchemaTopologyController

Bases: TypedDict

ESRI Topology Controller Schema

Attributes:

Name Type Description
eventNotificationOnValidate bool
topologyName str
weight int
xyRank int
zRank int
Source code in src/arcpie/schemas/workspace.py 
165
166
167
168
169
170
171
class SchemaTopologyController(TypedDict):
    """ESRI Topology Controller Schema"""
    topologyName: str
    weight: int
    xyRank: int
    zRank: int
    eventNotificationOnValidate: bool

eventNotificationOnValidate instance-attribute

topologyName instance-attribute

weight instance-attribute

xyRank instance-attribute

zRank instance-attribute

SchemaTopologyRule

Bases: TypedDict

ESRI TopologyRule Schema

Attributes:

Name Type Description
allDestinationSubtypes bool
allOriginSubtypes bool
destinationClassID int
guid str
helpString str
name str
originClassID int
originSubtype int
ruleId int
topologyRuleType ESRITopologyRuleType
triggerErrorEvents bool
Source code in src/arcpie/schemas/workspace.py 
177
178
179
180
181
182
183
184
185
186
187
188
189
class SchemaTopologyRule(TypedDict):
    """ESRI TopologyRule Schema"""
    helpString: str
    ruleId: int
    name: str
    guid: str
    originClassID: int
    destinationClassID: int
    originSubtype: int
    triggerErrorEvents: bool
    allOriginSubtypes: bool
    allDestinationSubtypes: bool
    topologyRuleType: ESRITopologyRuleType

allDestinationSubtypes instance-attribute

allOriginSubtypes instance-attribute

destinationClassID instance-attribute

guid instance-attribute

helpString instance-attribute

name instance-attribute

originClassID instance-attribute

originSubtype instance-attribute

ruleId instance-attribute

topologyRuleType instance-attribute

triggerErrorEvents instance-attribute

SchemaWorkspace

Bases: TypedDict

ESRI Workspace Schema

Attributes:

Name Type Description
bugfixVersion int
catalogPath str
childrenExpanded bool
connectionString str
datasetType Literal['DEWorkspace']
datasets list[SchemaDataset]
domains list[SchemaDomain]
majorVersion int
maxAttributeRuleID int
minorVersion int
name str
realm str
workspaceFactoryProgID ESRIWorkspaceProgID
workspaceType ESRIWorkspaceType
Source code in src/arcpie/schemas/workspace.py 
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
class SchemaWorkspace(TypedDict):
    """ESRI Workspace Schema"""
    datasetType: Literal['DEWorkspace']
    catalogPath: str
    name: str
    childrenExpanded: bool
    workspaceType: ESRIWorkspaceType
    workspaceFactoryProgID: ESRIWorkspaceProgID
    connectionString: str
    majorVersion: int
    minorVersion: int
    bugfixVersion: int
    realm: str
    maxAttributeRuleID: int
    domains: list[SchemaDomain]
    datasets: list[SchemaDataset]

bugfixVersion instance-attribute

catalogPath instance-attribute

childrenExpanded instance-attribute

connectionString instance-attribute

datasetType instance-attribute

datasets instance-attribute

domains instance-attribute

majorVersion instance-attribute

maxAttributeRuleID instance-attribute

minorVersion instance-attribute

name instance-attribute

realm instance-attribute

workspaceFactoryProgID instance-attribute

workspaceType instance-attribute