-
Notifications
You must be signed in to change notification settings - Fork 11
/
GeodatabaseDocumentation.py
332 lines (290 loc) · 14.1 KB
/
GeodatabaseDocumentation.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
#-------------------------------------------------------------
# Name: Geodatabase Documentation
# Purpose: Documents a geodatabase by exporting feature class, table and domain information to
# a CSV file.
# Author: Shaun Weston ([email protected])
# Date Created: 15/01/2015
# Last Updated: 10/03/2015
# Copyright: (c) Eagle Technology
# ArcGIS Version: 10.2+
# Python Version: 2.7
#--------------------------------
# Import modules
import os
import sys
import logging
import smtplib
import arcpy
import csv
import xml.etree.ElementTree as ET
from xml.etree.ElementTree import ElementTree
# Enable data to be overwritten
arcpy.env.overwriteOutput = True
# Set global variables
enableLogging = "false" # Use logger.info("Example..."), logger.warning("Example..."), logger.error("Example...")
logFile = "" # os.path.join(os.path.dirname(__file__), "Example.log")
sendErrorEmail = "false"
emailTo = ""
emailUser = ""
emailPassword = ""
emailSubject = ""
emailMessage = ""
enableProxy = "false"
requestProtocol = "http" # http or https
proxyURL = ""
output = None
# Start of main function
def mainFunction(geodatabase,outputFolder): # Get parameters from ArcGIS Desktop tool by seperating by comma e.g. (var1 is 1st parameter,var2 is 2nd parameter,var3 is 3rd parameter)
try:
# --------------------------------------- Start of code --------------------------------------- #
# Get a list of the feature classes and tables in the database
arcpy.env.workspace = geodatabase
featureClassList = arcpy.ListFeatureClasses()
tableList = arcpy.ListTables()
datasetList = featureClassList + tableList
# Describe the workspace
descWorkspace = arcpy.Describe(geodatabase)
workspaceType = descWorkspace.workspaceType
# Create the CSV files and setup headers
datasetsCSVFile = open(os.path.join(outputFolder, descWorkspace.baseName + "_Datasets.csv"), 'wb')
relationshipClassesCSVFile = open(os.path.join(outputFolder, descWorkspace.baseName + "_RelationshipClasses.csv"), 'wb')
domainsCSVFile = open(os.path.join(outputFolder, descWorkspace.baseName + "_Domains.csv"), 'wb')
datasetsWriter = csv.writer(datasetsCSVFile, delimiter=",")
relationshipClassesWriter = csv.writer(relationshipClassesCSVFile, delimiter=",")
domainsWriter = csv.writer(domainsCSVFile, delimiter=",")
# Add in header information
datasetsHeaderRow = ["Name","Description","Dataset Type","Geometry","Spatial Reference","Versioned","Archived"]
relationshipClassesHeaderRow = ["Name","Description","Cardinality","Origin Feature Class","Destination Feature Class"]
domainsHeaderRow = ["Name","Description","Domain Type", "Field Type"]
singleDatasetHeaderRow = ["Field Name","Field Alias Name","Type","Domain","Is Nullable","Is Editable","Length"]
singleDomainHeaderRow = ["Code","Description"]
datasetsWriter.writerow(datasetsHeaderRow)
relationshipClassesWriter.writerow(relationshipClassesHeaderRow)
domainsWriter.writerow(domainsHeaderRow)
# For each dataset
for dataset in datasetList:
# Describe the dataset
descDataset = arcpy.Describe(dataset)
datasetName = descDataset.name
dataType = descDataset.dataType
arcpy.AddMessage("Documenting dataset - " + datasetName + "...")
if (dataType.lower() == "featureclass"):
shapeType = descDataset.shapeType
else:
shapeType = "Non-Spatial"
if (dataType.lower() == "featureclass"):
spatialReference = descDataset.spatialReference.name
else:
spatialReference = "Non-Spatial"
if (descDataset.canVersion == True):
versionedEnabled = descDataset.isVersioned
else:
versionedEnabled = "False"
if (descDataset.canVersion == True):
archiveEnabled = descDataset.isArchived
else:
archiveEnabled = "False"
# Set the directory for the translator
installDirectory = arcpy.GetInstallInfo("desktop")["InstallDir"]
# Use the FGDC to get into clean xml format
translator = installDirectory + "Metadata\Translator\ARCGIS2FGDC.xml"
# Export the metadata for the dataset
arcpy.ExportMetadata_conversion(dataset, translator, os.path.join(arcpy.env.scratchFolder, "Metadata.xml"))
# Convert file to xml
tree = ET.ElementTree(file=os.path.join(arcpy.env.scratchFolder, "Metadata.xml"))
# Import and reference the xml file
root = tree.getroot()
datasetDescription = "No Description"
# Look at the metadata
description = root.find("idinfo/descript")
# If there are description values
if description:
# Look at the description xml element
for child in root.find("idinfo/descript"):
# Get purpose
if (child.tag.lower() == "purpose"):
datasetDescription = child.text
# If any variables are none
if (datasetDescription is None):
datasetDescription = "No Description"
# Write in dataset information
row = [datasetName,datasetDescription,dataType,shapeType,spatialReference,versionedEnabled,archiveEnabled]
datasetsWriter.writerow(row)
with open(os.path.join(outputFolder, "Dataset_" + datasetName + ".csv"), 'wb') as file:
singleDatasetWriter = csv.writer(file, delimiter=",")
singleDatasetWriter.writerow(singleDatasetHeaderRow)
# Get a list of fields
fields = arcpy.ListFields(dataset)
# Iterate through the list of fields
for field in fields:
fieldInfo = [field.name,field.aliasName,field.type,field.domain,field.isNullable,field.editable,field.length]
singleDatasetWriter.writerow(fieldInfo)
# Get a list of domains on the geodatabase
geodatabaseDomains = arcpy.da.ListDomains(geodatabase)
# For each of the domains
for domain in geodatabaseDomains:
domainName = domain.name
domainDescription = domain.description
domainType = domain.domainType
domainFieldType = domain.type
codedValues = domain.codedValues
arcpy.AddMessage("Documenting domain - " + domainName + "...")
# Write in domain information
row = [domainName,domainDescription,domainType,domainFieldType]
domainsWriter.writerow(row)
with open(os.path.join(outputFolder, "Domain_" + domainName + ".csv"), 'wb') as file:
singleDomainWriter = csv.writer(file, delimiter=",")
singleDomainWriter.writerow(singleDomainHeaderRow)
for codedValue in codedValues:
domainValue = codedValue
domainDescription = codedValues[codedValue]
domainInfo = [domainValue,domainDescription]
singleDomainWriter.writerow(domainInfo)
# Get a list of relationship classes in the geodatabase
# For each relationship class
for dataset in arcpy.Describe(geodatabase).children:
if dataset.datatype == "RelationshipClass":
rcName = dataset.name
rcCardinality = dataset.cardinality
rcOriginClassNames = dataset.originClassNames[0]
rcDestinationClassNames = dataset.destinationClassNames[0]
# Set the directory for the translator
installDirectory = arcpy.GetInstallInfo("desktop")["InstallDir"]
# Use the FGDC to get into clean xml format
translator = installDirectory + "Metadata\Translator\ARCGIS2FGDC.xml"
# Export the metadata for the dataset
arcpy.ExportMetadata_conversion(dataset.catalogPath, translator, os.path.join(arcpy.env.scratchFolder, "Metadata.xml"))
# Convert file to xml
tree = ET.ElementTree(file=os.path.join(arcpy.env.scratchFolder, "Metadata.xml"))
# Import and reference the xml file
root = tree.getroot()
rcDescription = "No Description"
# Look at the metadata
description = root.find("idinfo/descript")
# If there are description values
if description:
# Look at the description xml element
for child in root.find("idinfo/descript"):
# Get purpose
if (child.tag.lower() == "purpose"):
rcDescription = child.text
# If any variables are none
if (rcDescription is None):
rcDescription = "No Description"
arcpy.AddMessage("Documenting relationship class - " + rcName + "...")
# Write in relationship class information
row = [rcName,rcDescription,rcCardinality,rcOriginClassNames,rcDestinationClassNames]
relationshipClassesWriter.writerow(row)
# --------------------------------------- End of code --------------------------------------- #
# If called from gp tool return the arcpy parameter
if __name__ == '__main__':
# Return the output if there is any
if output:
arcpy.SetParameterAsText(1, output)
# Otherwise return the result
else:
# Return the output if there is any
if output:
return output
# Logging
if (enableLogging == "true"):
# Log end of process
logger.info("Process ended.")
# Remove file handler and close log file
logging.FileHandler.close(logMessage)
logger.removeHandler(logMessage)
pass
# If arcpy error
except arcpy.ExecuteError:
# Build and show the error message
errorMessage = arcpy.GetMessages(2)
arcpy.AddError(errorMessage)
# Logging
if (enableLogging == "true"):
# Log error
logger.error(errorMessage)
# Log end of process
logger.info("Process ended.")
# Remove file handler and close log file
logging.FileHandler.close(logMessage)
logger.removeHandler(logMessage)
if (sendErrorEmail == "true"):
# Send email
sendEmail(errorMessage)
# If python error
except Exception as e:
errorMessage = ""
# Build and show the error message
for i in range(len(e.args)):
if (i == 0):
errorMessage = unicode(e.args[i]).encode('utf-8')
else:
errorMessage = errorMessage + " " + unicode(e.args[i]).encode('utf-8')
arcpy.AddError(errorMessage)
# Logging
if (enableLogging == "true"):
# Log error
logger.error(errorMessage)
# Log end of process
logger.info("Process ended.")
# Remove file handler and close log file
logging.FileHandler.close(logMessage)
logger.removeHandler(logMessage)
if (sendErrorEmail == "true"):
# Send email
sendEmail(errorMessage)
# End of main function
# Start of set logging function
def setLogging(logFile):
# Create a logger
logger = logging.getLogger(os.path.basename(__file__))
logger.setLevel(logging.DEBUG)
# Setup log message handler
logMessage = logging.FileHandler(logFile)
# Setup the log formatting
logFormat = logging.Formatter("%(asctime)s: %(levelname)s - %(message)s", "%d/%m/%Y - %H:%M:%S")
# Add formatter to log message handler
logMessage.setFormatter(logFormat)
# Add log message handler to logger
logger.addHandler(logMessage)
return logger, logMessage
# End of set logging function
# Start of send email function
def sendEmail(message):
# Send an email
arcpy.AddMessage("Sending email...")
# Server and port information
smtpServer = smtplib.SMTP("smtp.gmail.com",587)
smtpServer.ehlo()
smtpServer.starttls()
smtpServer.ehlo
# Login with sender email address and password
smtpServer.login(emailUser, emailPassword)
# Email content
header = 'To:' + emailTo + '\n' + 'From: ' + emailUser + '\n' + 'Subject:' + emailSubject + '\n'
body = header + '\n' + emailMessage + '\n' + '\n' + message
# Send the email and close the connection
smtpServer.sendmail(emailUser, emailTo, body)
# End of send email function
# This test allows the script to be used from the operating
# system command prompt (stand-alone), in a Python IDE,
# as a geoprocessing script tool, or as a module imported in
# another script
if __name__ == '__main__':
# Arguments are optional - If running from ArcGIS Desktop tool, parameters will be loaded into *argv
argv = tuple(arcpy.GetParameterAsText(i)
for i in range(arcpy.GetArgumentCount()))
# Logging
if (enableLogging == "true"):
# Setup logging
logger, logMessage = setLogging(logFile)
# Log start of process
logger.info("Process started.")
# Setup the use of a proxy for requests
if (enableProxy == "true"):
# Setup the proxy
proxy = urllib2.ProxyHandler({requestProtocol : proxyURL})
openURL = urllib2.build_opener(proxy)
# Install the proxy
urllib2.install_opener(openURL)
mainFunction(*argv)