Générer une règle attributaire d’ID (Gestion des données)

Synthèse

Crée une règle attributaire destinée à générer la valeur unique d’un champ à partir d’une requête. L’outil génère un fichier .csv qui contient une règle attributaire ArcGIS Arcade reposant sur les entrées fournies, un fichier Python contenant le code de génération des séquences dans l’espace de travail, ainsi qu’un fichier d’ID pour visualiser les ID générés.

Utilisation

• Le paramètre Dossier en sortie indique l’emplacement de création d’un dossier avec le nom de la classe d’entités en entrée. Le fichier .csv en sortie contenant la règle attributaire utilise le nom de la valeur du paramètre Table en entrée. Si l’outil est exécuté plusieurs fois, d’autres fichiers .csv sont créés dans le dossier.

• Une fois l’outil exécuté, importez la règle attributaire et appliquez-la au jeu de données. Si le jeu de données se trouve dans une géodatabase d’entreprise, vous devez être le propriétaire des données pour appliquer la règle attributaire du modèle en sortie.

  En savoir plus sur l’importation des règles attributaires

Paramètres

Boîte de dialogue

Étiquette	Explication	Type de données
Table en entrée	Jeu de données auquel la nouvelle règle est appliquée.	Table View
Dossier en sortie	Dossier dans lequel le fichier .csv en sortie est enregistré. Le nom du fichier provient de la valeur du paramètre Table en entrée.	Folder
Terrain	Nom du champ existant auquel la règle est appliquée.	Field
Expression (Facultatif)	Expression SQL qui limite les lignes auxquelles la règle attributaire est appliquée.	SQL Expression
Créer des séquences (Facultatif)	Indique si des séquences de base de données sont créées dans l’espace de travail spécifié. Activé : des séquences de base de données sont créées. Il s’agit de l’option par défaut. Désactivé : aucune séquence de base de données n’est créée.	Boolean
Type de définition (Facultatif)	Spécifie la méthode utilisée pour définir le format de l’ID. Générateur—Le format de l’ID est construit à l’aide du paramètre Générateur d’ID. Table—Le format de l’ID est défini à partir d’une table à l’aide du paramètre Table de définition d’ID. Valeurs précodées—Une séquence et une entrée de configuration sont générées pour chaque combinaison de valeurs précodées à partir des champs sélectionnés. Générateur—Le format de l’ID est construit à l’aide du paramètre id_builder. Table—Le format de l’ID est défini à partir d’une table à l’aide du paramètre id_table. Valeurs précodées—Une séquence et une entrée de configuration sont générées pour chaque combinaison de valeurs précodées à partir des champs sélectionnés.	String
Générateur d’ID (Facultatif)	Ensemble d’options de format qui définissent la règle attributaire. Il s’agit notamment d’une expression SQL qui permet d’appliquer différents formats et séquences par ressource, ainsi que des valeurs de marge intérieure, de préfixe et de suffixe. SQL de filtrage : expression SQL facultative qui permet de déterminer si la séquence est appliquée à la ligne. Description : description facultative de l’entrée qui est ajoutée aux paramètres dans la règle attributaire. Nom de séquence : nom attribué à la séquence de base de données. Pour les géodatabases d’entreprise, ce nom doit remplir les critères de nom de séquence définis pour la plateforme de base de données que vous utilisez et être unique dans la base de données. Pour les géodatabases fichier, ce nom doit également être propre à la géodatabase fichier. Valeur de départ : numéro de départ de la séquence. Si vous ne fournissez pas de numéro de départ, la séquence commence par le numéro 1. Si vous fournissez un numéro de départ, il doit être supérieur à 0. Valeur d’incrément : décrit la façon dont sont incrémentés les numéros de séquence. Par exemple, si la séquence commence à 10 et que la valeur d’incrément est 5, la prochaine valeur dans la séquence sera 15, et la suivante 20. Si vous ne spécifiez pas de valeur d’incrément, les valeurs de séquence sont incrémentées de 1. Préfixe : chaîne ou valeur facultative à insérer avant la valeur de séquence. Suffixe : chaîne ou valeur facultative à insérer après la valeur de séquence. Marge intérieure : nombre positif facultatif qui représente le nombre de chiffres, où zéro est utilisé pour compléter les chiffres inutilisés. Par exemple, la valeur 5 représente la valeur de séquence 1 sous la forme 00001. Séparateur : valeur facultative qui permet de joindre le préfixe, la séquence et le suffixe. Un aperçu de la chaîne s’affiche dans la fenêtre Géotraitement à partir des valeurs entrées dans les options de format.	Value Table
Table de définition de l’ID (Facultatif)	Table ou jeu d’enregistrements qui définit le format de l’ID. Il s’agit notamment de l’expression SQL qui permet d’appliquer différents formats et séquences par ressource, ainsi que des valeurs de marge intérieure, de préfixe et de suffixe. La table doit inclure les champs suivants : WhereClause : expression SQL facultative qui permet de déterminer si la séquence est appliquée à la ligne. Description : description facultative de l’entrée qui est ajoutée aux paramètres dans la règle attributaire. SequenceName : nom attribué à la séquence de base de données. Pour les géodatabases d’entreprise, ce nom doit remplir les critères de nom de séquence définis pour la plateforme de base de données que vous utilisez et être unique dans la base de données. Pour les géodatabases fichier, ce nom doit également être propre à la géodatabase fichier. StartingValue : numéro de départ de la séquence. Si vous ne fournissez pas de numéro de départ, la séquence commence par le numéro 1. S’il est spécifié, le numéro de départ doit être supérieur à 0. IncrementValue : décrit la façon dont sont incrémentés les numéros de séquence. Par exemple, si la séquence commence à 10 et que la valeur d’incrément est 5, la prochaine valeur dans la séquence sera 15, et la suivante 20. Si vous ne spécifiez pas de valeur d’incrément, les valeurs de séquence sont incrémentées de 1. Prefix : chaîne ou valeur facultative à insérer avant la valeur de séquence. Suffix : chaîne ou valeur facultative à insérer après la valeur de séquence. Padding : nombre positif facultatif qui représente le nombre de chiffres, où zéro est utilisé pour compléter les chiffres inutilisés. Par exemple, la valeur 5 représente la valeur de séquence 1 sous la forme 00001. Separator : valeur facultative qui permet de joindre le préfixe, la séquence et le suffixe.	Record Set
Champs de valeurs précodées (Facultatif)	Champs permettant de générer une expression SQL et une configuration pour un ID.	Field

Sortie obtenue

Étiquette	Explication	Type de données
CSV de règle en sortie	Fichier .csv en sortie qui contient une règle attributaire Arcade reposant sur les entrées fournies. Ce fichier permet d’importer la règle attributaire dans le jeu de données.	File
Table de définition de l’ID	Table de configurations de la définition de séquence. Ce fichier peut être mis à jour et réutilisé par l’outil à l’aide de l’option Table du paramètre Type de définition.	File
Script de séquence Python	Fichier de séquence Python en sortie. Le fichier peut être utilisé dans d’autres espaces de travail ou par quiconque dispose des autorisations nécessaires pour créer des séquences de base de données.	File

Python

arcpy.management.GenerateIDAttributeRule(in_table, out_folder, field, {where_clause}, {create_seq}, {definition_method}, {id_builder}, {id_table}, {id_coded_value})

Nom	Explication	Type de données
in_table	Jeu de données auquel la nouvelle règle est appliquée.	Table View
out_folder	Dossier dans lequel le fichier .csv en sortie est enregistré. Le nom du fichier provient de la valeur du paramètre in_table.	Folder
field	Nom du champ existant auquel la règle est appliquée.	Field
where_clause (Facultatif)	Expression SQL qui limite les lignes auxquelles la règle attributaire est appliquée.	SQL Expression
create_seq (Facultatif)	Indique si des séquences de base de données sont créées dans l’espace de travail spécifié. CREATE—Des séquences de base de données sont créées. Il s’agit de l’option par défaut. NO_CREATE—Aucune séquence de base de données n’est créée.	Boolean
definition_method (Facultatif)	Spécifie la méthode utilisée pour définir le format de l’ID.	String
id_builder [id_builder,...] (Facultatif)	Ensemble d’options de format qui définissent la règle attributaire. Il s’agit notamment d’une expression SQL qui permet d’appliquer différents formats et séquences par ressource, ainsi que des valeurs de marge intérieure, de préfixe et de suffixe. Filter SQL : expression SQL facultative qui permet de déterminer si la séquence est appliquée à la ligne. Description : description facultative de l’entrée qui est ajoutée aux paramètres dans la règle attributaire. Sequence Name : nom attribué à la séquence de base de données. Pour les géodatabases d’entreprise, ce nom doit remplir les critères de nom de séquence définis pour la plateforme de base de données que vous utilisez et être unique dans la base de données. Pour les géodatabases fichier, ce nom doit également être propre à la géodatabase fichier. Starting Value : numéro de départ de la séquence. Si vous ne fournissez pas de numéro de départ, la séquence commence par le numéro 1. Si vous fournissez un numéro de départ, il doit être supérieur à 0. Increment Value : décrit la façon dont sont incrémentés les numéros de séquence. Par exemple, si la séquence commence à 10 et que la valeur d’incrément est 5, la prochaine valeur dans la séquence sera 15, et la suivante 20. Si vous ne spécifiez pas de valeur d’incrément, les valeurs de séquence sont incrémentées de 1. Prefix : chaîne ou valeur facultative à insérer avant la valeur de séquence. Suffix : chaîne ou valeur facultative à insérer après la valeur de séquence. Padding : nombre positif facultatif qui représente le nombre de chiffres, où zéro est utilisé pour compléter les chiffres inutilisés. Par exemple, la valeur 5 représente la valeur de séquence 1 sous la forme 00001. Separator : valeur facultative qui permet de joindre le préfixe, la séquence et le suffixe.	Value Table
id_table (Facultatif)	Table ou jeu d’enregistrements qui définit le format de l’ID. Il s’agit notamment de l’expression SQL qui permet d’appliquer différents formats et séquences par ressource, ainsi que des valeurs de marge intérieure, de préfixe et de suffixe. La table doit inclure les champs suivants : WhereClause : expression SQL facultative qui permet de déterminer si la séquence est appliquée à la ligne. Description : description facultative de l’entrée qui est ajoutée aux paramètres dans la règle attributaire. SequenceName : nom attribué à la séquence de base de données. Pour les géodatabases d’entreprise, ce nom doit remplir les critères de nom de séquence définis pour la plateforme de base de données que vous utilisez et être unique dans la base de données. Pour les géodatabases fichier, ce nom doit également être propre à la géodatabase fichier. StartingValue : numéro de départ de la séquence. Si vous ne fournissez pas de numéro de départ, la séquence commence par le numéro 1. S’il est spécifié, le numéro de départ doit être supérieur à 0. IncrementValue : décrit la façon dont sont incrémentés les numéros de séquence. Par exemple, si la séquence commence à 10 et que la valeur d’incrément est 5, la prochaine valeur dans la séquence sera 15, et la suivante 20. Si vous ne spécifiez pas de valeur d’incrément, les valeurs de séquence sont incrémentées de 1. Prefix : chaîne ou valeur facultative à insérer avant la valeur de séquence. Suffix : chaîne ou valeur facultative à insérer après la valeur de séquence. Padding : nombre positif facultatif qui représente le nombre de chiffres, où zéro est utilisé pour compléter les chiffres inutilisés. Par exemple, la valeur 5 représente la valeur de séquence 1 sous la forme 00001. Separator : valeur facultative qui permet de joindre le préfixe, la séquence et le suffixe.	Record Set
id_coded_value [id_coded_value,...] (Facultatif)	Champs permettant de générer une expression SQL et une configuration pour un ID.	Field

Sortie obtenue

Nom	Explication	Type de données
out_rule_csv	Fichier .csv en sortie qui contient une règle attributaire Arcade reposant sur les entrées fournies. Ce fichier permet d’importer la règle attributaire dans le jeu de données.	File
out_id_file	Table de configurations de la définition de séquence. Ce fichier peut être mis à jour et réutilisé par l’outil à l’aide de l’option TABLE du paramètre definition_method.	File
out_seq_script	Fichier de séquence Python en sortie. Le fichier peut être utilisé dans d’autres espaces de travail ou par quiconque dispose des autorisations nécessaires pour créer des séquences de base de données.	File

Exemple de code

Exemple d’utilisation de la fonction GenerateIDAttributeRule (script autonome)

Le script autonome suivant est un exemple d’utilisation de la fonction GenerateIDAttributeRule dans un environnement d’écriture de scripts.

# Name: GenerateIDAttributeRule_Example.py
# Description: GenerateIDAttributeRule of a template attribute rule in a file geodatabase

# Import the system modules
import arcpy

# Set local variables
in_table = "C:/data/data.gdb"
out_folder = "C:/out/"
field = "ID"
where_clause = ""
create_seq = "CREATE"
definition_method = "BUILDER"
id_builder = "# # 2 2 # # # #"
id_table = r"in_memory\record_set1"
id_coded_value_fields = None

arcpy.management.GenerateIDAttributeRule(
   in_table,
   out_folder,
   field,
   where_clause,
   create_seq,
   definition_method,
   id_builder,
   id_table,
   coded_value_fields
)

Environnements

Cet outil n’utilise pas d’environnement de géotraitement.