Especifica la ubicación del archivo de archivo (o directorio, para un archivo en formato de directorio) que se va a restaurar. Si no se especifica, se utiliza la entrada estándar.

Restaura solo los datos, no el esquema (definiciones de datos) ni las estadísticas. Se restauran los datos de las tablas, los objetos grandes (large objects) y los valores de las secuencias, si están presentes en el archivo.

Esta opción es similar a especificar --section=data, pero por razones históricas no es idéntica.

Antes de restaurar los objetos de la base de datos, emite comandos para eliminar (DROP) todos los objetos que se van a restaurar. Esta opción es útil para sobrescribir una base de datos existente. Si alguno de los objetos no existe en la base de datos de destino, se informarán mensajes de error ignorables, a menos que también se especifique --if-exists.

Crea la base de datos antes de restaurar en ella. Si también se especifica --clean, elimina y vuelve a crear la base de datos de destino antes de conectarse a ella.

Con --create, pg_restore también restaura el comentario de la base de datos, si lo hay, y cualquier configuración de variable de configuración específica de esta base de datos, es decir, cualquier comando ALTER DATABASE ... SET ... y ALTER ROLE ... IN DATABASE ... SET ... que mencione esta base de datos. También se restauran los privilegios de acceso para la propia base de datos, a menos que se especifique --no-acl.

Cuando se utiliza esta opción, la base de datos nombrada con -d se utiliza únicamente para emitir los comandos iniciales DROP DATABASE y CREATE DATABASE. Todos los datos se restauran en la base de datos cuyo nombre aparece en el archivo.

Se conecta a la base de datos dbname y restaura directamente en ella. El dbname puede ser una cadena de conexión. Si es así, los parámetros de la cadena de conexión anularán cualquier opción de línea de comandos en conflicto.

Termina si se encuentra un error al enviar comandos SQL a la base de datos. Por defecto se continúa y se muestra un recuento de errores al final de la restauración.

Especifica el archivo de salida para el script generado, o para el listado cuando se utiliza con -l. Utiliza - para la salida estándar (stdout).

Especifica el formato del archivo. No es necesario especificar el formato, ya que pg_restore lo determinará automáticamente. Si se especifica, puede ser uno de los siguientes:

Restaura únicamente la definición del índice nombrado. Se pueden especificar múltiples índices con múltiples opciones -I.

Ejecuta los pasos que consumen más tiempo de pg_restore (aquellos que cargan datos, crean índices o crean restricciones) de forma concurrente, utilizando hasta number-of-jobs sesiones concurrentes. Esta opción puede reducir drásticamente el tiempo para restaurar una base de datos grande en un servidor que se ejecuta en una máquina multiprocesador. Esta opción se ignora cuando se genera un script en lugar de conectarse directamente a un servidor de bases de datos.

Cada tarea (job) es un proceso o un hilo de ejecución (thread), dependiendo del sistema operativo, y utiliza una conexión independiente al servidor.

El valor óptimo para esta opción depende de la configuración de hardware del servidor, del cliente y de la red. Los factores incluyen el número de núcleos de CPU y la configuración del disco. Un buen punto de partida es el número de núcleos de CPU en el servidor, pero valores mayores que ese también pueden llevar a tiempos de restauración más rápidos en muchos casos. Por supuesto, valores demasiado altos llevarán a una disminución del rendimiento debido a la sobrecarga por paginación (thrashing).

Con esta opción solo se admiten los formatos de archivo personalizado y de directorio. La entrada debe ser un archivo regular o un directorio (no, por ejemplo, una tubería o la entrada estándar). Además, no se pueden utilizar múltiples tareas junto con la opción --single-transaction.

Muestra la tabla de contenidos (TOC) del archivo. La salida de esta operación se puede utilizar como entrada para la opción -L. Ten en cuenta que si se utilizan opciones de filtrado como -n o -t con -l, estas restringirán los elementos listados.

Restaura únicamente los elementos del archivo que están listados en el list-file, y los restaura en el orden en que aparecen en el archivo. Ten en cuenta que si se utilizan opciones de filtrado como -n o -t con -L, estas restringirán aún más los elementos restaurados.

El list-file se crea normalmente editando la salida de una operación -l anterior. Las líneas se pueden mover o eliminar, y también se pueden comentar colocando un punto y coma (;) al principio de la línea. Véanse los ejemplos más abajo.

Restaura únicamente los objetos que están en el esquema nombrado. Se pueden especificar múltiples esquemas con múltiples opciones -n. Esto se puede combinar con la opción -t para restaurar solo una tabla específica.

No restaura los objetos que están en el esquema nombrado. Se pueden especificar múltiples esquemas a excluir con múltiples opciones -N.

Cuando se proporcionan tanto -n como -N para el mismo nombre de esquema, la opción -N prevalece y el esquema es excluido.

No genera comandos para establecer la propiedad de los objetos de modo que coincida con la base de datos original. Por defecto, pg_restore emite sentencias ALTER OWNER o SET SESSION AUTHORIZATION para establecer la propiedad de los elementos de esquema creados. Estas sentencias fallarán a menos que la conexión inicial a la base de datos la realice un superusuario (o el mismo usuario que es propietario de todos los objetos en el script). Con -O, se puede usar cualquier nombre de usuario para la conexión inicial, y este usuario será el propietario de todos los objetos creados.

Restaura únicamente la función nombrada. Asegúrate de escribir el nombre de la función y los argumentos exactamente como aparecen en la tabla de contenidos del archivo de exportación. Se pueden especificar múltiples funciones con múltiples opciones -P.

Esta opción está obsoleta pero aún se acepta por compatibilidad hacia atrás.

Restaura únicamente el esquema (definiciones de datos), no los datos, en la medida en que las entradas del esquema estén presentes en el archivo.

Esta opción no se puede usar con --data-only ni con --statistics-only. Es similar a especificar --section=pre-data --section=post-data --no-statistics, pero por razones históricas no es idéntica.

(No confundas esto con la opción --schema, que utiliza la palabra “esquema” con un significado diferente).

Especifica el nombre de usuario del superusuario a utilizar al desactivar los disparadores. Esto solo es relevante si se utiliza --disable-triggers.

Restaura la definición y/o los datos de únicamente la tabla nombrada. Para este propósito, “tabla” incluye vistas, vistas materializadas, secuencias y tablas extranjeras. Se pueden seleccionar múltiples tablas escribiendo múltiples opciones -t. Esta opción se puede combinar con la opción -n para especificar tablas en un esquema particular.

Restaura únicamente el disparador (trigger) nombrado. Se pueden especificar múltiples disparadores con múltiples opciones -T.

Activa el modo detallado. Esto hará que pg_restore escriba comentarios detallados de los objetos y tiempos de inicio/finalización en el archivo de salida, y mensajes de progreso en la salida de error estándar. Repetir la opción hace que aparezcan mensajes adicionales de nivel de depuración (debug) en la salida de error estándar.

Muestra la versión de pg_restore y termina.

Evita la restauración de privilegios de acceso (comandos grant/revoke).

Ejecuta la restauración como una única transacción (es decir, envuelve los comandos emitidos en BEGIN/COMMIT). Esto asegura que o bien todos los comandos se completen con éxito, o no se aplique ningún cambio. Esta opción implica --exit-on-error.

Esta opción solo es relevante cuando se realiza una restauración sin esquema. Indica a pg_restore que ejecute comandos para desactivar temporalmente los disparadores (triggers) en las tablas de destino mientras se restauran los datos. Utiliza esto si tienes comprobaciones de integridad referencial u otros disparadores en las tablas que no deseas invocar durante la restauración de datos.

Actualmente, los comandos emitidos para --disable-triggers deben realizarse como superusuario. Por lo tanto, también deberías especificar un nombre de superusuario con -S o, preferiblemente, ejecutar pg_restore como superusuario de PostgreSQL.

Esta opción solo es relevante al restaurar el contenido de una tabla que tiene seguridad a nivel de fila (row security). Por defecto, pg_restore establecerá row_security en off, para asegurar que todos los datos se restauren en la tabla. Si el usuario no tiene privilegios suficientes para omitir la seguridad a nivel de fila, se produce un error. Este parámetro indica a pg_restore que establezca row_security en on en su lugar, permitiendo al usuario intentar restaurar el contenido de la tabla con la seguridad a nivel de fila habilitada. Esto podría fallar de todos modos si el usuario no tiene el derecho de insertar las filas de la copia de seguridad en la tabla.

Ten en cuenta que esta opción actualmente también requiere que la copia de seguridad esté en formato INSERT, ya que COPY FROM no admite seguridad a nivel de fila.

Especifica un nombre de archivo del cual leer patrones para objetos excluidos o incluidos en la restauración. Los patrones se interpretan de acuerdo con las mismas reglas que -n/--schema para incluir objetos en esquemas, -N/--exclude-schema para excluir objetos en esquemas, -P/--function para restaurar funciones nombradas, -I/--index para restaurar índices nombrados, -t/--table para restaurar tablas nombradas o -T/--trigger para restaurar disparadores. Para leer desde la entrada estándar (STDIN), utiliza - como nombre de archivo. La opción --filter se puede especificar en conjunción con las opciones enumeradas anteriormente para incluir o excluir objetos, y también se puede especificar más de una vez para múltiples archivos de filtro.

El archivo enumera un patrón de base de datos por fila, con el siguiente formato:

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

La primera palabra clave especifica si los objetos que coinciden con el patrón deben incluirse o excluirse. La segunda palabra clave especifica el tipo de objeto que se va a filtrar mediante el patrón:

Las líneas que comienzan con # se consideran comentarios y se ignoran. También se pueden colocar comentarios después de una fila de patrón de objeto. Las líneas en blanco también se ignoran. Véase Patterns para saber cómo realizar el entrecomillado en los patrones.

Utiliza comandos DROP ... IF EXISTS para eliminar objetos en el modo --clean. Esto suprime los errores de “no existe” que de otro modo podrían reportarse. Esta opción no es válida a menos que también se especifique --clean.

No genera comandos para restaurar comentarios, incluso si el archivo los contiene.

No genera comandos para restaurar datos, incluso si el archivo los contiene.

Por defecto, los datos de las tablas se restauran incluso si el comando de creación de la tabla falló (por ejemplo, porque ya existe). Con esta opción, se omiten los datos de dicha tabla. Este comportamiento es útil si la base de datos de destino ya contiene el contenido deseado de la tabla. Por ejemplo, las tablas auxiliares para extensiones de PostgreSQL como PostGIS ya podrían estar cargadas en la base de datos de destino; especificar esta opción evita que se carguen datos duplicados u obsoletos en ellas.

Esta opción solo es efectiva cuando se restaura directamente en una base de datos, no cuando se genera una salida de script SQL.

No genera comandos para restaurar políticas de seguridad a nivel de fila, incluso si el archivo las contiene.

No genera comandos para restaurar publicaciones, incluso si el archivo los contiene.

No genera comandos para restaurar el esquema (definiciones de datos), incluso si el archivo los contiene.

No genera comandos para restaurar etiquetas de seguridad, incluso si el archivo las contiene.

No genera comandos para restaurar estadísticas, incluso si el archivo las contiene.

No genera comandos para restaurar suscripciones, incluso si el archivo las contiene.

No genera comandos para seleccionar métodos de acceso a tablas. Con esta opción, todos los objetos se crearán con cualquier método de acceso a tablas que sea el predeterminado durante la restauración.

No genera comandos para seleccionar tablespaces. Con esta opción, todos los objetes se crearán en cualquier tablespace que sea el predeterminado durante la restauración.

Utiliza la cadena proporcionada como la clave \restrict de psql en la salida de la copia de seguridad. Esto solo se puede especificar para la salida de script SQL, es decir, cuando se utiliza la opción --file. Si no se especifica ninguna clave de restricción, pg_restore generará una aleatoria según sea necesario. Las claves pueden contener únicamente caracteres alfanuméricos.

Esta opción está destinada principalmente a fines de prueba y otros escenarios que requieren una salida repetible (por ejemplo, comparar archivos de copia de seguridad). No se recomienda para uso general, ya que un servidor malicioso con conocimiento previo de la clave podría inyectar código arbitrario que se ejecutará en la máquina que ejecuta psql con la salida de la copia de seguridad.

Restaura únicamente la sección nombrada. El nombre de la sección puede ser pre-data, data o post-data. Esta opción se puede especificar más de una vez para seleccionar múltiples secciones. Por defecto se restauran todas las secciones.

La sección data contiene los datos reales de las tablas así como las definiciones de objetos grandes (large objects). Los elementos post-data consisten en definiciones de índices, disparadores (triggers), reglas y restricciones que no sean restricciones de verificación (check constraints) validadas. Los elementos pre-data consisten en todos los demás elementos de definición de datos.

Genera comandos para restaurar estadísticas, si el archivo las contiene. Este es el comportamiento por defecto.

Restaura únicamente las estadísticas, no el esquema (definiciones de datos) ni los datos.

Requiere que cada calificador de esquema (-n/--schema) y tabla (-t/--table) coincida al menos con un esquema/tabla en el archivo a restaurar.

Ejecuta la restauración como una serie de transacciones, procesando cada una hasta N objetos de la base de datos. Esta opción implica --exit-on-error.

--transaction-size ofrece una opción intermedia entre el comportamiento predeterminado (una transacción por comando SQL) y -1/--single-transaction (una transacción para todos los objetos restaurados). Mientras que --single-transaction tiene la menor sobrecarga, puede ser poco práctico para bases de datos grandes porque la transacción tomará un bloqueo en cada objeto restaurado, posiblemente agotando el espacio de la tabla de bloqueos del servidor. Usar --transaction-size con un tamaño de unos pocos miles de objetos ofrece casi los mismos beneficios de rendimiento mientras que limita la cantidad de espacio necesario en la tabla de bloqueos.

Genera comandos estándar de SQL SET SESSION AUTHORIZATION en lugar de comandos ALTER OWNER para determinar la propiedad del objeto. Esto hace que la exportación sea más compatible con los estándares, pero dependiendo de la historia de los objetos en la exportación, podría no restaurarse correctamente.

Muestra la ayuda sobre los argumentos de línea de comandos de pg_restore y termina.

Especifica el nombre de host de la máquina en la que se está ejecutando el servidor. Si el valor comienza con una barra diagonal, se utiliza como el directorio para el socket de dominio Unix. El valor predeterminado se toma de la variable de entorno PGHOST, si está establecida; de lo contrario, se intenta una conexión por socket de dominio Unix.

Especifica el puerto TCP o la extensión del archivo de socket de dominio Unix local en el que el servidor está escuchando conexiones. El valor por defecto es el de la variable de entorno PGPORT, si está establecida, o un valor predeterminado en tiempo de compilación.

Nombre de usuario con el que conectarse.

Nunca solicita una contraseña. Si el servidor requiere autenticación por contraseña y no hay una contraseña disponible por otros medios, como un archivo .pgpass, el intento de conexión fallará. Esta opción puede ser útil en tareas por lotes (batch) y scripts donde no hay ningún usuario presente para introducir una contraseña.

Fuerza a pg_restore a solicitar una contraseña antes de conectarse a una base de datos.

Esta opción nunca es imprescindible, ya que pg_restore solicitará automáticamente una contraseña si el servidor exige autenticación por contraseña. Sin embargo, pg_restore desperdiciará un intento de conexión para descubrir que el servidor requiere una contraseña. En algunos casos, vale la pena escribir -W para evitar el intento de conexión adicional.

Especifica un nombre de rol a utilizar para realizar la restauración. Esta opción hace que pg_restore emita un comando SET ROLE rolename después de conectarse a la base de datos. Es útil cuando el usuario autenticado (especificado por -U) carece de los privilegios necesarios para pg_restore, pero puede cambiar a un rol con los derechos requeridos. Algunas instalaciones tienen una política en contra de iniciar sesión directamente como superusuario, y el uso de esta opción permite realizar restauraciones sin violar dicha política.

Parámetros de conexión predeterminados

Especifica si se debe usar color en los mensajes de diagnóstico. Los valores posibles son always, auto y never.