Spécifie l'emplacement du fichier d'archive (ou du répertoire pour une archive au format « directory ») à restaurer. S'il n'est pas spécifié, l'entrée standard est utilisée.

Restaure seulement les données, pas les schémas (définitions des données) ou les statistiques. Les données des tables, les Large Objects, et les valeurs des séquences sont restaurées si elles sont présentes dans l'archive.

Cette option est similaire à --section=data mais, pour des raisons historiques, elle n'est pas identique.

Avant de restaurer les objets de la base, lance des commandes SQL DROP pour supprimer tous les objets à restaurer. Cette option est utile pour surcharger une base existante. Si un des objets n'existe pas dans la base de destination, des messages d'erreurs, à ignorer, seront renvoyées sauf si l'option --if-exists est aussi indiquée.

Crée la base de données avant de la restaurer. Si l'option --clean est aussi indiquée, supprime puis crée de nouveau la base de données cible avant de s'y connecter.

Avec --create, pg_restore restaure aussi le commentaire de la base de données, s'il a été configuré, et toutes variables de configuration spécifiques à cette base, autrement dit toutes les commandes ALTER DATABASE ... SET ... et ALTER ROLE ... IN DATABASE ... SET ... qui mentionnent cette base. Les droits d'accès à la base elle-même sont aussi restaurés sauf si --no-acl est spécifié. --create is required when restoring multiple databases from an archive created by pg_dumpall.

Quand cette option est utilisée, la base de données nommée via l'option -d est utilisée seulement pour exécuter les commandes DROP DATABASE et CREATE DATABASE. Toutes les données sont restaurées dans la base dont le nom se trouve dans l'archive.

Se connecte à la base de données nom_base et restaure directement dans la base de données. Ce nom de base peut être remplacé par une chaîne de connexion. Dans ce cas, les paramètres de la chaîne de connexion surchargeront toutes les options en ligne de commande conflictuelles.

Do not restore databases whose name matches pattern. Multiple patterns can be excluded by writing multiple --exclude-database switches. The pattern parameter is interpreted as a pattern according to the same rules used by psql's \d commands (see Motifs), so multiple databases can also be excluded by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent shell wildcard expansion.

This option is only relevant when restoring from an archive made using pg_dumpall.

Quitte si une erreur est rencontrée lors de l'envoi des commandes SQL à la base de données. La valeur par défaut est de continuer et d'afficher le nombre d'erreurs à la fin de la restauration.

Spécifie le fichier en sortie pour le script généré ou pour la liste lorsqu'elle est utilisée avec -l. Utilisez - pour stdout.

Indique un nom de fichier à partir duquel lire les motifs des objets exclus ou inclus d'une restauration. Les motifs sont interprétés suivant les mêmes règles que -n/--schema pour inclure les objets dans les schémas, -N/--exclude-schema pour exclure les objets dans les schémas, -P/--function pour restaurer les fonctions nommées, -I/--index pour restaurer les index nommés, -t/--table pour restaurer les tables nommés ou -T/--trigger pour restaurer les triggers. Pour lire à partir de STDIN, utilisez - comme nom de fichier. L'option --filter peut être utilisé en même temps que les options listées ci-dessus pour inclure ou exclure des objets, et peut aussi être utilisée plus d'une fois pour prendre en compte plusieurs fichiers de filtre.

Le fichier liste un motif de base par ligne en respectant le format suivant :

{ include | exclude } { function | index | schema | table | trigger } MOTIF

Le premier mot clé indique si les objets correspondant aux motifs doivent être inclus ou exclus. Le deuxième mot clé précise le type d'objet à filtrer suivant le motif :

Les lignes commençant avec # sont considérées comme des commentaires et, de ce fait, sont ignorées. Les commentaires peuvent aussi être placés après une ligne de motif d'objet. Les lignes blanches sont elles-aussi ignorées. Voir Motifs pour savoir comment réaliser l'échappement dans les motifs.

Spécifie le format de l'archive. Il n'est pas nécessaire de le spécifier car pg_restore détermine le format automatiquement. Si spécifié, il peut être un des suivants :

Restore only global objects (roles and tablespaces), no databases.

This option is only relevant when restoring from an archive made using pg_dumpall.

Restaure uniquement la définition des index nommés. Plusieurs index peuvent être donnés en utilisant autant de fois l'option -I.

Exécute les parties les plus consommatrices en temps de pg_restore -- celles des chargements de données, créations d'index et créations de contraintes -- en parallèle, utilisant jusqu'à nombre-de-jobs sessions parallèles. Cette option peut réduire de beaucoup le temps pour restaurer une grosse base de données pour un serveur fonctionnant sur une machine multi-processus. Cette option est ignorée lors de la création d'un script, plutôt que lors d'une connexion directe à un serveur de bases de données.

Chaque job est un processus ou un thread, suivant le système d'exploitation, et utilise une connexion séparée au serveur.

La valeur optimale pour cette option dépend de la configuration matérielle du serveur, du client et du réseau. Les facteurs incluent le nombre de cœurs CPU et la configuration disque. Un bon moyen pour commencer est le nombre de cœurs CPU du serveur, mais une valeur plus grande que ça peut amener des temps de restauration encore meilleurs dans de nombreux cas. Bien sûr, les valeurs trop hautes apporteront des performances en baisse.

Seuls les formats d'archivage personnalisé et répertoire sont supportés avec cette option. Le fichier en entrée doit être un fichier standard (pas un tube, pas l'entrée standard). De plus, plusieurs jobs ne peuvent pas être utilisés ensemble si vous voulez l'option --single-transaction.

Liste le contenu de l'archive. Le résultat de cette opération peut être utilisé en entrée de l'option -L. Notez que, si vous utilisez des options de filtre telles que -n ou -t avec l'option -l, elles restreignent les éléments listés.

Restaure seulement les objets qui sont listés dans le fichier fichier_liste, et les restaure dans l'ordre où elles apparaissent dans le fichier. Notez que, si des options de filtre comme -n et -t sont utilisées avec -L, elles ajouteront cette restriction aux éléments restaurés.

fichier_liste est normalement créé en éditant la sortie d'une précédente opération -l. Les lignes peuvent être déplacées ou supprimées, et peuvent aussi être mise en commentaire en ajoutant un point-virgule (;) au début de la ligne. Voir ci-dessous pour des exemples.

Restaure seulement les objets qui sont dans le schéma nommé. Plusieurs schémas peuvent être donnés en utilisant autant de fois l'option -n. Elle peut être combinée avec l'option -t pour ne restaurer qu'une seule table.

Ne pas restaurer les objets qui sont dans le schéma nommé. Plusieurs schémas à exclure peuvent être spécifiés grâce à de multiples commutateurs -N.

Si les commutateurs -n et -N sont tous deux présents pour le même schéma, le commutateur -N sera prépondérant et le schéma exclu.

Ne pas donner les commandes initialisant les propriétaires des objets pour correspondre à la base de données originale. Par défaut, pg_restore lance des instructions ALTER OWNER ou SET SESSION AUTHORIZATION pour configurer le propriétaire des éléments du schéma créé. Ces instructions échouent sauf si la connexion initiale à la base de données est réalisée par un superutilisateur (ou le même utilisateur que le propriétaire des objets du script). Avec -O, tout nom d'utilisateur peut être utilisé pour la connexion initiale et cet utilisateur est le propriétaire des objets créés.

Restaure seulement la fonction nommée. Faites attention à épeler le nom de la fonction et les arguments exactement comme ils apparaissent dans la table des matières du fichier de sauvegarde. Plusieurs fonctions peuvent être données en utilisant autant de fois l'option -P.

Cette option est obsolète mais est toujours acceptée pour des raisons de compatibilité ascendante.

Restaure seulement le schéma (autrement dit, la définition des données), mais pas les données, à condition que cette définition est présente dans l'archive.

This option cannot be used with --data-only or --statistics-only. Elle est similaire, mais pas identique (pour des raisons historiques), à --section=pre-data --section=post-data --no-statistics.

(Ne pas la confondre avec l'option --schema qui utilise le mot « schema » dans un contexte différent.)

Spécifie le nom d'utilisateur du superutilisateur à utiliser pour désactiver les triggers. Ceci est seulement nécessaire si --disable-triggers est utilisé.

Restaure la définition et/ou les données de la table nommée uniquement. Dans ce cadre, « table » inclut les vues, les vues matérialisées, les séquences et les tables distantes. Plusieurs tables peuvent être sélectionnées en ajoutant plusieurs options -t. Cette option peut être combinée avec l'option -n pour indiquer les tables d'un schéma particulier.

Restaure uniquement le trigger nommé. Plusieurs triggers peuvent être donnés en utilisant autant de fois l'option -T..

Spécifie le mode verbeux. Ceci aura pour conséquence que pg_restore affichera des commentaires détaillés sur les objets, ainsi que les heures de début et de fin dans le fichier en sortie, et des messages de progression sur la sortie des erreurs. Répéter cette option cause l'apparition de messages supplémentaires de débuggage sur la sortie des erreurs.

Affiche la version de pg_restore, puis quitte.

Empêche la restauration des droits d'accès (commandes grant/revoke).

Restore only the statistics, not schema (data definitions) or data.

Exécute la restauration en une seule transaction (autrement dit, toutes les commandes de restauration sont placées entre un BEGIN et un COMMIT). Ceci assure l'utilisateur que soit toutes les commandes réussissent, soit aucun changement n'est appliqué. Cette option implique --exit-on-error.

Cette option n'est pertinente que lors d'une restauration sans schéma. Elle demande à pg_restore d'exécuter des commandes pour désactiver temporairement les triggers sur les tables cibles pendant que les données sont rechargées. Utilisez ceci si vous avez des vérifications d'intégrité référentielle sur les tables que vous ne voulez pas appeler lors du rechargement des données.

Actuellement, les commandes émises pour --disable-triggers doivent être exécutées par un superutilisateur. Donc, vous devriez aussi spécifier un nom de superutilisateur avec -S ou, de préférence, lancer pg_restore en tant que superutilisateur PostgreSQL.

Cette option n'est adéquate que lors de la restauration du contenu du table disposant de l'option RLS. Par défaut, pg_restore configurera row_security à off, pour s'assurer que toutes les données sont restaurées dans la table. Si l'utilisateur n'a pas les droits nécessaires pour contourner la sécurité au niveau ligne, alors une erreur est levée. Ce paramètre demande à pg_restore de configurer row_security à on, permettant à l'utilisateur d'essayer de restaurer le contenu de la table avec la sécurité au niveau ligne activée. Ceci pourrait échouer si l'utilisateur n'a pas le droit d'insérer des lignes dans la table.

Notez que cette option requiert aussi actuellement que la sauvegarde soit au format INSERT car COPY FROM n'est pas supportée par la sécurité au niveau ligne.

Utilise des commandes DROP ... IF EXISTS pour supprimer des objets dans le mode --clean. Cela permet de supprimer les erreurs « does not exist » qui seraient sinon renvoyées. Cette option n'est pas valide sauf si --clean est aussi indiquée.

Ne génère pas les commande de restauration des commentaires même si l'archive les contient.

Do not output commands to restore data, even if the archive contains them.

Par défaut, les données de la table sont restaurées même si la commande de création de cette table a échoué (par exemple parce qu'elle existe déjà). Avec cette option, les données de cette table seront ignorées. Ce comportement est utile si la base cible contient déjà des données pour cette table. Par exemple, les tables supplémentaires des extensions de PostgreSQL comme PostGIS pourraient avoir déjà été créées et remplies sur la base cible ; indiquer cette option empêche l'ajout de données dupliquées ou obsolètes.

Cette option est seulement efficace lors de la restauration directe d'une base, pas lors de la réalisation d'une sortie de script SQL.

Do not output commands to restore row security policies, even if the archive contains them.

Ne pas afficher les commandes pour restaurer les publications, même si l'archive les contient.

Do not output commands to restore schema (data definitions), even if the archive contains them.

Ne récupère pas les commandes de restauration des labels de sécurité, même si l'archive les contient.

Do not output commands to restore statistics, even if the archive contains them.

Ne pas afficher les commandes pour restaurer les souscriptions, même si l'archive les contient.

Ne pas afficher les commandes pour sélectionner les méthodes d'accès aux tables. Avec cette option, tous les objets seront créés avec la méthode d'accès de table par défaut lors de la restauration.

Ne sélectionne pas les tablespaces. Avec cette option, tous les objets seront créés dans le tablespace par défaut lors de la restauration.

Dump data. This is the default.

Dump schema (data definitions). This is the default.

Dump statistics. This is the default.

Restaure seulement la section nommée. Le nom de la section peut être pre-data, data ou post-data. Cette option peut être spécifiée plus d'une fois pour sélectionner plusieurs sections. La valeur par défaut est toutes les sections.

La section data contient toutes les données des tables ainsi que la définition des Large Objects. Les éléments post-data consistent en la définition des index, triggers, règles et contraintes (autres que les contraintes de vérification). Les éléments pre-data consistent en tous les autres éléments de définition.

Requiert que chaque qualificateur de schéma (-n / --schema) et table (-t / --table) correspond à au moins un schéma/table dans le fichier de sauvegarde.

Exécute la restauration dans une série de transactions, chacune traitant jusqu'à N objets de la base. Cette option implique --exit-on-error.

--transaction-size propose un choix intermédiaire entre le comportement par défaut (une transaction par commande SQL) et l'option -1/--single-transaction (une transaction pour tous les objets restaurés). Alors que --single-transaction a la surcharge la moins importante, cela pourrait se révéler peu pratique pour les grosses bases de données du fait du verrou pris sur la transaction sur chaque objet restauré, possiblement en récupérant tout l'espace mémoire du serveur pour les verrous. Utiliser --transaction-size avec une taille de quelques milliers d'objets offre pratiquement les mêmes bénéfices de performance tout en limitant la quantité de mémoire nécessaire pour les verrous.

Affiche les commandes SET SESSION AUTHORIZATION du standard SQL à la place des commandes ALTER OWNER pour déterminer le propriétaire de l'objet. Ceci rend la sauvegarde plus compatible avec les standards mais, suivant l'historique des objets dans la sauvegarde, pourrait ne pas restaurer correctement.

Affiche l'aide sur les arguments en ligne de commande de pg_restore, puis quitte.

Spécifie le nom d'hôte de la machine sur lequel le serveur est en cours d'exécution. Si la valeur commence par un slash, elle est utilisée comme répertoire du socket de domaine Unix. La valeur par défaut est prise dans la variable d'environnement PGHOST, si elle est initialisée, sinon une connexion socket de domaine Unix est tentée.

Spécifie le port TCP ou l'extension du fichier socket de domaine Unix sur lequel le serveur écoute les connexions. Par défaut, l'outil utilise la variable d'environnement PGPORT, si elle est configurée, sinon il utilise la valeur indiquée à la compilation.

Se connecte en tant que cet utilisateur

Ne demande jamais un mot de passe. Si le serveur en réclame un pour l'authentification et qu'un mot de passe n'est pas disponible d'une autre façon (par exemple avec le fichier .pgpass), la tentative de connexion échouera. Cette option peut être utile pour les scripts où aucun utilisateur n'est présent pour saisir un mot de passe.

Force pg_restore à demander un mot de passe avant la connexion à une base de données.

Cette option n'est jamais obligatoire car pg_restore demandera automatiquement un mot de passe si le serveur exige une authentification par mot de passe. Néanmoins, pg_restore perdra une tentative de connexion pour trouver que le serveur veut un mot de passe. Dans certains cas, il est préférable d'ajouter l'option -W pour éviter la tentative de connexion.

Indique un nom de rôle utilisé pour la restauration. Cette option fait que pg_restore exécute un SET ROLE nom_rôle après connexion à la base de données. C'est utile quand l'utilisateur authentifié (indiqué par l'option -U) n'a pas les droits demandés par pg_restore, mais peut devenir le rôle qui a les droits requis. Certaines installations ont une politique contre la connexion en superutilisateur directement, et utilisent cette option pour permettre aux restaurations de se faire sans violer cette règle.

Paramètres de connexion par défaut

Indique s'il faut utiliser les couleurs dans les messages de diagnostic. Les valeurs possibles sont always, auto, never.