arcpy.management.DeleteField(in_table, drop_field, {method})
|
Name
|
Explanation
|
Data type
|
|
in_table
|
The table containing the fields to be deleted. The existing input table will be modified.
|
Mosaic Layer; Raster Layer; Table View
|
|
drop_field
[drop_field,...]
|
The fields to be dropped or kept from the input table, as specified by the method parameter. Only nonrequired fields can be deleted.
|
Field
|
|
method
(Optional)
|
Specifies whether the fields specified by the drop_field parameter will be deleted or kept.
DELETE_FIELDS—The fields specified by the drop_field parameter will be deleted. This is the default.
KEEP_FIELDS—The fields specified by the drop_field parameter will be kept; all other fields will be deleted.
|
String
|
Derived output
|
Name
|
Explanation
|
Data type
|
|
out_table
|
The updated dataset.
|
Table View; Raster Layer; Mosaic Layer
|
Code sample
DeleteField example 1 (Python window)
The following Python window script demonstrates how to use the DeleteField function to delete specified fields.
import arcpy
arcpy.env.workspace = "C:/data"
arcpy.management.CopyFeatures("majorrds.shp", "C:/output/majorrds_copy.shp")
arcpy.management.DeleteField("C:/output/majorrds_copy.shp",
["STREET_NAM", "LABEL", "CLASS"])
DeleteField example 2 (Python window)
The following Python window script demonstrates how to use the DeleteField function to keep only the specified fields.
import arcpy
arcpy.env.workspace = "C:/data"
arcpy.management.CopyFeatures("majorrds.shp", "C:/output/majorrds_copy.shp")
arcpy.management.DeleteField("C:/output/majorrds_copy.shp",
["STREET_ALIAS", "DISTRICT_ID"], "KEEP_FIELDS")
DeleteField example 3 (stand-alone script)
The following stand-alone script demonstrates how to use the DeleteField function.
# Name: DeleteField_Example3.py
# Description: Keep several fields from a feature class and delete all the rest of the fields
# Import system modules
import arcpy
# Set environment settings
arcpy.env.workspace = "C:/data"
# Set local variables
inFeatures = "accident.dbf"
outFeatureClass = "C:/output/new_accident.dbf"
fields = ["STREET_NAM", "LABEL", "CLASS"]
method = "KEEP_FIELDS"
# Run CopyFeatures to make a new copy of the feature class
# Use CopyRows if you have a table
arcpy.management.CopyFeatures(inFeatures, outFeatureClass)
# Run DeleteField
arcpy.management.DeleteField(outFeatureClass, fields, method)
DeleteField example 4 (stand-alone script)
Use the DeleteField function to delete all unnecessary fields from a feature class or table.
# Description: Delete unnecessary fields from a feature class or table.
# Import system modules
import arcpy
# Get user-supplied input and output arguments
inTable = arcpy.GetParameterAsText(0)
updatedTable = arcpy.GetParameterAsText(1)
# Describe the input (need to test the dataset and data types)
desc = arcpy.Describe(inTable)
# Make a copy of the input (so you can maintain the original as is)
if desc.datasetType == "FeatureClass":
arcpy.management.CopyFeatures(inTable, updatedTable)
else:
arcpy.management.CopyRows(inTable, updatedTable)
# Use ListFields to get a list of field objects
fieldObjList = arcpy.ListFields(updatedTable)
# Create an empty list that will be populated with field names
fieldNameList = []
# For each field in the object list, add the field name to the
# name list. Exclude required fields to prevent errors
for field in fieldObjList:
if not field.required:
fieldNameList.append(field.name)
# dBASE tables require a field other than an OID and Shape. If this is
# the case, retain an extra field (the first one in the original list)
if desc.dataType in ["ShapeFile", "DbaseTable"]:
fieldNameList = fieldNameList[1:]
# Run DeleteField to delete all fields in the field list.
arcpy.management.DeleteField(updatedTable, fieldNameList)