Generate Schema Report (Data Management)

Summary

Generates an Excel, JSON, PDF, or HTML representation of the geodatabase schema. These formats are output to a target destination folder.

Learn more about generating a schema report

Usage

• Schema elements in the geodatabase will be included.

• This tool can be run on a workspace (file, mobile, and enterprise), feature class, feature dataset, feature layer, and feature service.

• The selected report formats are output to a single folder.

• Datasets must be registered with the geodatabase.

Parameters

Dialog

Label	Explanation	Data Type
Input Dataset	The workspace, feature dataset, feature layer, or table view that will be used to generate the schema report.	Workspace; Feature Dataset; Feature Layer; Table View
Output Location	The folder where the report will be created.	Folder
Name	The name of the file outputs.	String
Output Formats	Specifies the file types that will be included in the output folder. JSON—The output folder will include a .json file. PDF—The output folder will include a .pdf file. HTML—The output folder will include an .html file. XLSX—The output folder will include an Excel .xlsx file.	String

Derived Output

Label	Explanation	Data Type
Output Files	The derived file types in the output folder.	File

Python

arcpy.management.GenerateSchemaReport(in_dataset, out_location, name, formats)

Name	Explanation	Data Type
in_dataset	The workspace, feature dataset, feature layer, or table view that will be used to generate the schema report.	Workspace; Feature Dataset; Feature Layer; Table View
out_location	The folder where the report will be created.	Folder
name	The name of the file outputs.	String
formats [formats,...]	Specifies the file types that will be included in the output folder. JSON—The output folder will include a .json file. PDF—The output folder will include a .pdf file. HTML—The output folder will include an .html file. XLSX—The output folder will include an Excel .xlsx file.	String

Derived Output

Name	Explanation	Data Type
out_files	The derived file types in the output folder.	File

Code sample

GenerateSchemaReport example 1 (Python window)

The following Python window script demonstrates how to use the GenerateSchemaReport function.

import arcpy
arcpy.management.GenerateSchemaReport("C:/MyProject/MyGDB.gdb", "C:/MyProject/My_folder", "schema_report", ["JSON", "PDF"])

GenerateSchemaReport example 2 (stand-alone script)

The following stand-alone script is an example of how to use the GenerateSchemaReport function in a scripting environment.

# Name: GenerateSchemaReport_Example.py
# Description: GenerateSchemaReport of a file geodatabase

# Import the system modules
import arcpy

# Set local variables
gdbWorkspace = "C:/data/data.gdb"

arcpy.management.GenerateSchemaReport(gdbWorkspace, "C:/MyProject/My_folder", "schema_report", ["JSON", "PDF"])

Environments

Current Workspace