gpf_vector_to_db.utils.vector_to_db module

Main utils module for vector to db.

gpf_vector_to_db.utils.vector_to_db.drop_temp_schema(database_utils: DatabaseUtils, temp_schema_name: str) → Status

Supprime le schéma temporaire.

Paramètres:

• database_utils (DatabaseUtils) – objet de manipulation de la base de données

• temp_schema_name (str) – nom du schéma temporaire

Renvoie:

statut de la suppression

Type renvoyé:

Status

gpf_vector_to_db.utils.vector_to_db.get_delete_from_parameters(parameters: GpfOrchestratorParameters) → bool

Retourne le paramètre delete des paramètres d’exécution.

Paramètres:

parameters (GpfOrchestratorParameters) – les paramètres

Renvoie:

le paramètre delete sous la forme de booléen

gpf_vector_to_db.utils.vector_to_db.get_dest_srs_from_parameters(parameters: GpfOrchestratorParameters) → str

Retourne le SRS des paramètres d’exécution.

Paramètres:

parameters (GpfOrchestratorParameters) – les paramètres

Renvoie:

le SRS sous la forme « ESPG:1234 » ou None si non trouvé ou non conforme

Type renvoyé:

str

gpf_vector_to_db.utils.vector_to_db.get_process_extent_from_parameters(parameters: GpfOrchestratorParameters) → bool

Retourne le paramètre process_extent des paramètres d’exécution.

Paramètres:

parameters (GpfOrchestratorParameters) – les paramètres

Renvoie:

le paramètre process_extent sous la forme de booléen

gpf_vector_to_db.utils.vector_to_db.get_update_from_parameters(parameters: GpfOrchestratorParameters) → bool

Retourne le paramètre update des paramètres d’exécution.

Paramètres:

parameters (GpfOrchestratorParameters) – les paramètres

Renvoie:

le paramètre update sous la forme de booléen

gpf_vector_to_db.utils.vector_to_db.integrate_vector_files(database_utils: DatabaseUtils, vector_files: dict, schema_name: str, schema_name_to_update: str, src_srs: str = 'EPSG:4326', dest_srs: str = 'EPSG:4326') → Status

Intègre les données vectorielles dans le schéma schema_name.

Paramètres:

• database_utils (DatabaseUtils) – objet de manipulation de la base de données

• vector_files (dict) – dictionnaire contenant les fichiers de données vectorielles

• schema_name (str) – nom du schéma

• schema_name_to_update (str) – nom du schéma à mettre à jour

• src_srs (str, optional) – code EPSG des données en entrée. Defaults to « EPSG:4326 ».

• dest_srs (str, optional) – code EPSG des données en sortie. Defaults to « EPSG:4326 ».

Renvoie:

statut de l’intégration

Type renvoyé:

Status

gpf_vector_to_db.utils.vector_to_db.rebase_on_schema(database_utils: DatabaseUtils, vector_files: dict, temp_schema_name: str, schema_name: str, run_delete: bool = False, run_update: bool = False) → Status

Mise à jour de la donnée du schéma temporaire dans le schéma souhaité.

Paramètres:

• database_utils (DatabaseUtils) – objet de manipulation de la base de données

• vector_files (dict) – dictionnaire des fichiers de données vectorielles

• temp_schema_name (str) – nom du schéma temporaire

• schema_name (str) – nom du schéma à mettre à jour

• run_delete (bool, optional) – option pour exécuter les opérations de mise à jour. Defaults to False.

• run_update (bool, optional) – option pour exécuter les opérations de suppression. Defaults to False.

Renvoie:

statut de la mise à jour

Type renvoyé:

Status

gpf_vector_to_db.utils.vector_to_db.update_table(database_utils: DatabaseUtils, temp_schema_name: str, schema_name: str, table_name: str, file_path: str, gdal_open_options: list[str], src_srs: str = 'EPSG:4326', dest_srs: str = 'EPSG:4326', force_multigeom: bool = False) → Status

Mode de mise à jour d’une table.

On copie la table d’origine “schema_name.`table_name` dans temp_schema_name.`table_name`. On insère le vecteur file_path avec vector_to_database dans une table temporaire et l’on ajoute les données dans la table temp_schema_name.`table_name`. La table d’origine doit impérativement avoir une clef primaire.

Paramètres:

• database_utils (DatabaseUtils) – objet de manipulation de la base de données

• temp_schema_name (str) – schéma temporaire

• schema_name (str) – nom du schéma d’origine

• table_name (str) – nom de la table d’origine utilisé également pour le nouveau schéma

• file_path (str) – chemin vers le fichier vecteur à insérer dans la table.

• gdal_open_options (list[str], optional) – options d’ouverture de GDAL. Defaults to [« « ].

• src_srs (str, optional) – code EPSG des données en entrée. Defaults to « EPSG:4326 ».

• dest_srs (str, optional) – code EPSG des données en sortie. Defaults to « EPSG:4326 ».

• force_multigeom (bool, optional) – permet de forcer l’insertion de géométries multiples

Renvoie:

statut de la mise à jour

Type renvoyé:

Status

gpf_vector_to_db.utils.vector_to_db.vector_to_database(database: PgDatabase, temp_schema_name: str, new_layer_name: str, table_name: str, vector_file: str | Path, gdal_open_options: list[str] = [''], layer_creation_options: list[str] = [''], src_srs: str = 'EPSG:4326', dest_srs: str = 'EPSG:4326', force_multigeom: bool = False) → Status

Copie du fichier vectoriel vector_file dans le schema schema_name de la base

database. GDAL (Vector Translate) est utilisée pour copier la table table_name dont le nom sera new_layer_name dans le schema temp_schema_name.

Paramètres:

• database (PgDatabase) – base de données dans laquelle copier les données

• temp_schema_name (str) – schéma temporaire

• new_layer_name (str) – nom de la table de destination dans le schéma temporaire

• table_name (str) – nom de la table en entrée

• vector_file (str | Path) – chemin vers le fichier de données vectorielles à importer

• gdal_open_options (list[str], optional) – options d’ouverture de GDAL. Defaults to [« « ].

• layer_creation_options (list[str], optional) – options d’écriture de GDAL. Defaults to [« « ].

• src_srs (str, optional) – code EPSG des données en entrée. Defaults to « EPSG:4326 ».

• dest_srs (str, optional) – code EPSG des données en sortie. Defaults to « EPSG:4326 ».

• force_multigeom (bool, optional) – permet de forcer l’insertion de géométries multiples

Renvoie:

statut de la copie

Type renvoyé:

Status