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 l'option --create, pg_restore restaure également le commentaire associé à la base de données, s'il a été défini, ainsi que toutes les variables de configuration spécifiques à cette base. Cela inclut notamment toutes les commandes ALTER DATABASE ... SET ... et ALTER ROLE ... IN DATABASE ... SET ... qui se réfèrent à cette base. Les droits d'accès (ACL) sur la base elle-même sont également restaurés, sauf si l'option --no-acl est spécifiée. L'option --create est requise lors de la restauration de plusieurs bases de données à partir d'une archive créée par pg_dumpall.

Quand cette option est utilisée, la base de données indiquée avec -d est utilisée uniquement pour exécuter les commandes DROP DATABASE et CREATE DATABASE initiales. Toutes les données sont restaurées dans la base dont le nom est indiqué 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.

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.

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 s'agir de l'une des valeurs suivantes :

Restaure uniquement les objets globaux (rôles et tablespaces), sans les bases de données.

Cette option n'est pertinente que lors de la restauration à partir d'une archive créée avec pg_dumpall.

Restaure uniquement la définition des index mentionnés. Plusieurs index peuvent être spécifié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-processeur. Cette option est ignorée lorsqu'un script est généré au lieu d'établir une connexion directe avec 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. Une bonne valeur de départ est le nombre de cœurs CPU du serveur, mais une valeur plus grande peut mener à des temps de restauration encore meilleurs dans de nombreux cas. Bien sûr, les valeurs trop hautes apporteront de moins bonnes performances.

Seuls les formats d'archive personnalisé et répertoire sont supportés avec cette option. Le fichier en entrée doit être un fichier ou un répertoire classique (et non, par exemple, un « pipe » ou l'entrée standard). De plus, plusieurs jobs ne peuvent pas être utilisés conjointement avec 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.

Ne restaure que les éléments présents dans le fichier fichier_liste, et les restaure dans l'ordre où ils apparaissent dans ce fichier. Notez que si des options de filtre telles que -n ou -t sont utilisées avec -L, elles restreindront encore davantage les é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 mises 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 mentionné. Plusieurs schémas peuvent être spécifié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 mentionné. Plusieurs schémas à exclure peuvent être spécifiés en utilisant autant de fois l'option -N.

Lorsqu'à la fois -n et -N sont spécifiés pour le même nom de schéma, c'est l'option -N qui prévaut et le schéma est exclu.

Ne génère pas les commandes permettant d'attribuer les objets restaurés à leur propriétaire d'origine. Par défaut, pg_restore génère des instructions ALTER OWNER ou SET SESSION AUTHORIZATION pour rétablir le propriétaire des éléments du schéma créés. Ces instructions échoueront sauf si la connexion initiale à la base de données est effectuée par un superutilisateur (ou par le même utilisateur que le propriétaire de tous les objets dans le script). Avec -O, n'importe quel nom d'utilisateur peut être utilisé pour la connexion initiale, et cet utilisateur deviendra propriétaire de tous les objets créés.

Restaure seulement la fonction mentionnée. Veillez à orthographier le nom de la fonction et ses arguments exactement comme ils apparaissent dans la table des matières de l'export. Plusieurs fonctions peuvent être spécifiées en utilisant autant de fois l'option -P. -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 soit présente dans l'archive.

Cette option ne peut pas être utilisée avec --data-only ou --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 mentionnée uniquement. Dans ce contexte, « table » inclut les vues, les vues matérialisées, les séquences et les tables distantes. Plusieurs tables peuvent être sélectionnées en utilisant autant de fois l'option -t. Cette option peut être combinée avec l'option -n pour sélectionner des tables d'un schéma particulier.

Restaure uniquement le trigger mentionné. Plusieurs triggers peuvent être spécifié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 de débogage supplémentaires 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).

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 pertinente que lors de la restauration du contenu d'une table disposant de la sécurité au niveau ligne (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.

Ne restaure pas les bases de données dont le nom correspond au motif. Plusieurs motifs peuvent être exclus en répétant plusieurs fois l'option --exclude-database. Le paramètre motif est interprété comme un motif selon les mêmes règles que les commandes \d de psql (voir Motifs). Il est donc possible d'exclure plusieurs bases de données en utilisant des jokers dans le motif. Dans ce cas, prenez soin d'encadrer le motif de guillemets simples si nécessaire, pour empêcher le shell de les interpréter.

Cette option n'est pertinente que lors de la restauration à partir d'une archive créée avec pg_dumpall.

Spécifie un nom de fichier à partir duquel lire les motifs des objets à exclure ou à inclure lors de la restauration. Les motifs sont interprétés selon 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 mentionnées, -I/--index pour restaurer les index mentionnés, -t/--table pour restaurer les tables mentionnées ou -T/--trigger pour restaurer les triggers. Pour lire depuis STDIN, utilisez - comme nom de fichier. L'option --filter peut être utilisée en même temps que les options listées ci-dessus pour inclure ou exclure des objets, et peut aussi être spécifiée plusieurs fois pour utiliser plusieurs fichiers de filtres.

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

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

Le premier mot clé indique si les objets correspondant au motif doivent être inclus ou exclus. Le deuxième mot clé précise le type d'objet à filtrer à l'aide du 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 à la suite d'une ligne de motif d'objet. Les lignes vides sont elles-aussi ignorées. Voir Motifs pour savoir comment réaliser l'échappement dans les motifs.

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 spécifiée.

Ne génère pas les commandes pour restaurer les commentaires, même si l'archive en contient.

Ne génère pas les commandes pour restaurer les données, même si l'archive en contient.

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.

Ne génère pas les commandes pour restaurer les politiques de sécurité au niveau ligne, même si l'archive en contient.

Ne génère pas les commandes pour restaurer les publications, même si l'archive en contient.

Ne génère pas les commandes pour restaurer le schéma (définitions des données), même si l'archive en contient.

Ne génère pas les commandes pour restaurer les labels de sécurité, même si l'archive en contient.

Ne génère pas les commandes pour restaurer les statistiques, même si l'archive en contient.

Ne génère pas les commandes pour restaurer les souscriptions, même si l'archive en contient.

Ne génère pas 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 aux tables 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.

Restaure seulement la section mentionné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.

Restaure uniquement les statistiques, sans le schéma (définitions des données) ni les données.

Requiert que chaque qualificateur de schéma (-n / --schema) et table (-t / --table) corresponde à au moins un schéma ou une table présent dans le fichier à restaurer.

Exécute la restauration sous forme d'une série de transactions, chacune traitant jusqu'à N objets de la base de données. 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 seule 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 par la transaction sur chaque objet restauré, risquant d'épuiser tout l'espace mémoire du serveur disponible pour les verrous. Utiliser --transaction-size avec une taille de quelques milliers d'objets offre quasiment les mêmes avantages en termes de performance tout en limitant la quantité de mémoire nécessaire pour les verrous.

Génère des commandes SET SESSION AUTHORIZATION conformes au standard SQL au lieu des commandes ALTER OWNER pour définir le propriétaire des objets. Cela rend l'export plus conforme aux standards, mais selon l'historique des objets contenus dans l'archive, la restauration pourrait ne pas s'effectuer correctement.

Génère les commandes pour restaurer les données, si l'archive en contient. C'est le comportement par défaut.

Génère les commandes pour restaurer le schéma (définitions des données), si l'archive en contient. C'est le comportement par défaut.

Génère les commandes pour restaurer les statistiques, si l'archive en contient. C'est le comportement par défaut.

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 laquelle le serveur de bases de données est en cours d'exécution. Si la valeur commence par une barre oblique (/), elle est interprétée comme le répertoire du socket de domaine Unix. Par défaut, la valeur est tirée de la variable d'environnement PGHOST, si elle est définie ; sinon, une connexion via 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. La valeur par défaut est celle de la variable d'environnement PGPORT, si elle est définie. Dans le cas contraire, il s'agit de la valeur fournie à la compilation.

Spécifie le nom d'utilisateur utilisé pour la connexion.

Ne jamais demander de mot de passe. Si le serveur requiert une authentification par mot de passe et qu'aucun mot de passe n'est disponible par un autre moyen (par exemple via le fichier .pgpass), la tentative de connexion échouera. Cette option peut être utile dans les scripts ou les traitements de type batch, 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 indispensable car pg_restore demande automatiquement un mot de passe si le serveur exige une authentification par mot de passe. Néanmoins, pg_restore perd une tentative de connexion pour tester si le serveur requiert un mot de passe. Dans certains cas, il est préférable d'ajouter l'option -W pour éviter cette tentative de connexion supplémentaire.

Spécifie un rôle à utiliser pour la restauration. Avec cette option, pg_restore émet une commande SET ROLE nom_rôle après s'être connecté à la base de données. C'est utile quand l'utilisateur authentifié (indiqué par -U) n'a pas les droits dont pg_restore a besoin, mais peut basculer vers un rôle qui les a. Certaines installations ont une politique qui est contre se connecter directement en tant que superutilisateur, et l'utilisation de cette option permet aux restaurations de se faire sans violer cette politique.

Paramètres de connexion par défaut.

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