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

Résumé

Crée une règle attributaire destinée à générer la valeur unique d’un champ à partir d’une requête.

L’outil crée un fichier .csv contenant une règle attributaire ArcGIS Arcade qui repose 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 Output Folder (Dossier en sortie) spécifie 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 Input Table (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 de règles attributaires
Lorsque vous définissez le paramètre ID Builder (Générateur d’ID) sur la valeur Sequence by lookup (Séquence par recherche), une séquence de base de données est générée pour chaque valeur distincte dans le champ Sequence by lookup du jeu de données d’intersection présent lors de la création de la règle attributaire. Les entités créées après l’écriture de la règle doivent être incluses manuellement.
Si un ID est requis pour une entité cible, configurez le champ d’ID pour interdire les valeurs nulles.

Etiqueter	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 Input Table (Table en entrée).	Folder
Champ	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écoché—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 ID Builder (Générateur d’ID). Tableau—Le format de l’ID est défini à partir d’une table à l’aide du paramètre ID Definition Table (Table de définition de l’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.	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. Un aperçu de la chaîne s’affiche dans la fenêtre Geoprocessing (Géotraitement) à partir des valeurs saisies dans les options de format. Colonnes de la table de valeurs : Filter SQL—An optional SQL expression that will be used to determine whether the sequence will be applied to the row. Description—An optional description of the entry that will be added to the rule settings in the attribute rule. Sequence Name—The name that will be assigned to the database sequence. For enterprise geodatabases, the name must meet sequence name requirements for the database platform you're using and must be unique in the database. For file geodatabases, the name must be unique to the file geodatabase. Starting Value—The starting number of the sequence. If you do not provide a starting number, the sequence will start at 1. If you do provide a starting number, it must be greater than 0. Increment Value—Describes how the sequence numbers will be incremented. For example, if the sequence starts at 10 and the increment value is 5, the next value in the sequence is 15, and the next value after that is 20. If you do not specify an increment value, sequence values will increment by 1. Prefix—An optional string or value that will be placed before the sequence value. Suffix—An optional string or value that will be placed after the sequence value. Padding—An optional positive number that represents the number of digits in which zeros will be used to fill the unused digits. For example, a value of 5 will represent the sequence value of 1 as 00001. Separator—An optional value that will be used to join the prefix, sequence, and suffix. Sequence by lookup—An optional value that will be used to create unique sequences for each distinct value in the field.	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. Si vous fournissez un numéro de départ, il 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 positions inutilisées. 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. `IntersectClass`—Valeur facultative contenant le chemin complet d’un jeu de données d’intersection. `ClassIDField`—Valeur de champ facultative à utiliser pour créer des séquences uniques pour chaque valeur distincte du champ. `ClassFilter`—Expression SQL facultative permettant de déterminer si la séquence est appliquée à la ligne dans le jeu de données d’intersection.	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
Séquence par intersection (Facultatif)	Entités du jeu de données d’intersection utilisées pour générer des valeurs d’ID uniques dans les entités en entrée. La valeur de champ facultative du jeu de données d’intersection est utilisée pour la valeur de la séquence par recherche. Colonnes de la table de valeurs : Intersect Class—The features from the intersecting dataset that will be used to generate unique ID values in the input features. Row ID Field—The optional field value from the intersecting dataset will be used for the sequence by lookup value.	Value Table

Sortie dérivée

Etiqueter	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 Definition Type (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

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

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. `BUILDER`—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`. `CODED_VALUES`—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
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. Colonnes de la table de valeurs : `Filter SQL`—An optional SQL expression that will be used to determine whether the sequence will be applied to the row. `Description`—An optional description of the entry that will be added to the rule settings in the attribute rule. `Sequence Name`—The name that will be assigned to the database sequence. For enterprise geodatabases, the name must meet sequence name requirements for the database platform you're using and must be unique in the database. For file geodatabases, the name must be unique to the file geodatabase. `Starting Value`—The starting number of the sequence. If you do not provide a starting number, the sequence will start at 1. If you do provide a starting number, it must be greater than 0. `Increment Value`—Describes how the sequence numbers will be incremented. For example, if the sequence starts at 10 and the increment value is 5, the next value in the sequence is 15, and the next value after that is 20. If you do not specify an increment value, sequence values will increment by 1. `Prefix`—An optional string or value that will be placed before the sequence value. `Suffix`—An optional string or value that will be placed after the sequence value. `Padding`—An optional positive number that represents the number of digits in which zeros will be used to fill the unused digits. For example, a value of 5 will represent the sequence value of 1 as 00001. `Separator`—An optional value that will be used to join the prefix, sequence, and suffix. `Sequence by lookup`—An optional value that will be used to create unique sequences for each distinct value in the field.	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. Si vous fournissez un numéro de départ, il 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 positions inutilisées. 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. `IntersectClass`—Valeur facultative contenant le chemin complet d’un jeu de données d’intersection. `ClassIDField`—Valeur de champ facultative à utiliser pour créer des séquences uniques pour chaque valeur distincte du champ. `ClassFilter`—Expression SQL facultative permettant de déterminer si la séquence est appliquée à la ligne dans le jeu de données d’intersection.	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
intersect_class_field [intersect_class_field,...] (Facultatif)	Entités du jeu de données d’intersection utilisées pour générer des valeurs d’ID uniques dans les entités en entrée. La valeur de champ facultative du jeu de données d’intersection est utilisée pour la valeur de la séquence par recherche. Colonnes de la table de valeurs : `Intersect Class`—The features from the intersecting dataset that will be used to generate unique ID values in the input features. `Row ID Field`—The optional field value from the intersecting dataset will be used for the sequence by lookup value.	Value Table

Sortie dérivée

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 de scripts.

# Name: GenerateIDAttributeRule_Example.py

# Import the system modules
import arcpy

# Set local variables
in_table = "C:/data/data.gdb/target_class"
out_folder = "C:/out/"
field = "genID"
where_clause = ""
create_seq = "CREATE"
definition_method = "BUILDER"
id_builder = "# # sequence_name 2 # # # # poly_class::lookup"
id_table = ""
id_coded_value_fields = None
intersect_class_field = "\path\to\gdb.gdb\intersecting_class lookup"

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

Environnements

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

Informations de licence

Basic: Non
Standard: Oui
Advanced: Oui

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

Résumé

Utilisation

Paramètres

Sortie dérivée

Environnements

Informations de licence

Rubriques connexes