Résumé
Renomme les champs et les alias de champ, ou modifie les propriétés de champ.
Utilisation
Cet outil permet de renommer les champs ou les alias de champ d’une classe d’entités ou d’une table de géodatabase.
Lorsque vous utilisez des tables ou classes d’entités en mémoire, le fait de renommer le champ ObjectID, Shape ou d’autres champs obligatoires, tels que ceux présents dans les couches d’analyse de réseau, risque d’endommager les données ou d’entraîner un comportement inattendu.
Syntaxe
arcpy.management.AlterField(in_table, field, {new_field_name}, {new_field_alias}, {field_type}, {field_length}, {field_is_nullable}, {clear_field_alias})
Paramètre | Explication | Type de données |
in_table | Classe d’entités ou table en entrée qui contient le champ à modifier. | Table View; Raster Layer; Raster Catalog Layer; Mosaic Layer |
field | Nom du champ à modifier. S’il s’agit d’un champ obligatoire (isRequired=true), seul l’alias de champ peut être modifié. | Field |
new_field_name (Facultatif) | Nouveau nom du champ. | String |
new_field_alias (Facultatif) | Nouvel alias du champ. | String |
field_type (Facultatif) | Indique le nouveau type du champ. Cette propriété s’applique uniquement si la table en entrée est vide (ne contient aucun enregistrement).
| String |
field_length (Facultatif) | Nouvelle longueur du champ. Définit le nombre maximal de caractères autorisés pour chaque enregistrement du champ. Cette option ne s’applique qu’aux champs de type TEXT ou BLOB. Elle ne s’applique également que si la table est vide. | Long |
field_is_nullable (Facultatif) | Indique si le champ peut contenir des valeurs Null (nulles). Les valeurs Null sont prises en charge uniquement pour les champs d'une géodatabase. Cette option s’applique uniquement si la table en entrée est vide (ne contient aucun enregistrement).
| Boolean |
clear_field_alias (Facultatif) | Indique si l’alias du champ en entrée doit être effacé. Le paramètre d'alias de champ doit être vide pour effacer l'alias du champ.
| Boolean |
Sortie dérivée
Nom | Explication | Type de données |
out_table | Table en entrée mise à jour. | Table View; Raster Layer; Mosaic Layer |
Exemple de code
Exemple 1 d'utilisation de l'outil AlterField (fenêtre Python)
Le script de fenêtre Python suivant montre comment utiliser l'outil AlterField en mode immédiat.
arcpy.AlterField_management(r'C:\Data\Garbo.gdb\Khyber', 'Elev', 'ELEVATION', 'Elevation in Metres')
Exemple 2 d’utilisation de l’outil AlterField (script autonome)
Le script de fenêtre Python ci-dessous illustre l’utilisation de l’outil AlterField dans un script autonome.
#Import geoprocessing
import arcpy
#Set workspace
arcpy.env.workspace = r'C:\Data\Garbo.gdb'
#Loop through feature classes looking for a field named 'elev'
fcList = arcpy.ListFeatureClasses() #get a list of feature classes
for fc in fcList: #loop through feature classes
fieldList = arcpy.ListFields(fc) #get a list of fields for each feature class
for field in fieldList: #loop through each field
if field.name.lower() == 'elev': #look for the name elev
arcpy.AlterField_management(fc, field.name, 'ELEVATION', 'Elevation in Metres')
Exemple 3 d'utilisation de l'outil AlterField (script autonome)
Le script de fenêtre Python ci-dessous illustre l’utilisation de l’outil AlterField sur une classe d’entités vide dans un script autonome.
#Import arcpy module
import arcpy
#Set local variables
in_table = "C:/Data/Garbo.gdb/trails" #Note: empty feature class
field = "condition_rating" #short int, non nullable field
new_field_name = "notes"
new_field_alias = "Comments on Trail Condition"
field_type = "TEXT"
field_length = "60"
field_is_nullable = "NULLABLE"
clear_field_alias = "FALSE"
#Alter the properties of a non nullable, short data type field to become a text field
arcpy.management.AlterField(in_table,
field,
new_field_name,
new_field_alias,
field_type,
field_length,
field_is_nullable,
clear_field_alias)
Environnements
Informations de licence
- Basic: Oui
- Standard: Oui
- Advanced: Oui