Skip To Content

Describe

Summary

The Describe function returns a dictionary with multiple properties, such as data type, fields, indexes, and many others. The dictionary's keys are dynamic, meaning that depending on what data type is described, different properties will be available for use.

Describe keys are organized into a series of property groups. Any particular dataset will acquire the properties of at least one of these groups. For instance, if describing a geodatabase feature class, you could access properties from the GDB FeatureClass, FeatureClass, Table, and Dataset property groups. All data, regardless of the data type, will always acquire the generic Describe properties.

Syntax

Describe (value, {datatype})
ParameterExplanationData Type
value

The specified data element or geoprocessing object to describe.

String
datatype

The type of data. This is only necessary when naming conflicts exists, for example, if a geodatabase contains a feature dataset (FeatureDataset) and a feature class (FeatureClass) with the same name. In this case, the data type is used to clarify which dataset you want to describe.

(The default value is None)

String
Return Value
Data TypeExplanation
Dictionary

Returns a dictionary with keys detailing the data element described.

Related topics


In this topic