Funciones PostgreSQL

Introducción

La base de datos PostgreSQL es un producto Open Source y disponible sin costo. Postgres, desarrollado originalmente en el Deportamento de Ciencias de Computación de UC Berkeley, fue pionero en muchos de los conceptos de objetos y relacionales que ahora están apareciendo en algunas bases de datos comerciales. Provee soporte para lenguajes SQL92/SQL99, transacciones, integridad referencial, procedimientos almacenados y extensibilidad de tipos. PostgreSQL es un descendiente de código abierto de su código original de Berkeley.

Requisitos

Para hacer uso del soporte PostgreSQL, necesita PostgreSQL 6.5 o posterior, PostgreSQL 8.0 o posterior para habilitar todas las características del módulo. PostgreSQL soporta varias codificaciones de caracteres, incluyendo codificación de caracteres multibyte. Su versión actual, asi como más información sobre PostgreSQL se encuentra disponible en » http://www.postgresql.org/ y la » Documentación de PostgreSQL.

Instalación

Para habilitar el soporte de PostgreSQL, se requiere la opción --with-pgsql[=DIR] cuando se compila PHP. DIR es el directorio de instalación base de PostgreSQL, su valor predeterminado es /usr/local/pgsql. Si se encuentra disponible un objeto módulo compartido, el módulo PostgreSQL puede ser cargado usando la directiva extension en php.ini o con la función dl().

Configuración en tiempo de ejecución

El comportamiento de estas funciones está afectado por los valores definidos en php.ini.

**Opciones de configuración de PostgreSQL**
Nombre	Predeterminado	Modificable	Cambios
pgsql.allow_persistent	"1"	PHP_INI_SYSTEM
pgsql.max_persistent	"-1"	PHP_INI_SYSTEM
pgsql.max_links	"-1"	PHP_INI_SYSTEM
pgsql.auto_reset_persistent	"0"	PHP_INI_SYSTEM	Disponible desde PHP 4.2.0.
pgsql.ignore_notice	"0"	PHP_INI_ALL	Disponible desde PHP 4.3.0.
pgsql.log_notice	"0"	PHP_INI_ALL	Disponible desde PHP 4.3.0.

For further details and definitions of the PHP_INI_* constants, see the Directivas de php.ini.

A continuación se presenta una corta explicación de las directivas de configuración.

pgsql.allow_persistent boolean: Indica si se permiten conexiones Postgres persistentes.
pgsql.max_persistent integer: El máximo número de conexiones Postgres persistentes por proceso.
pgsql.max_links integer: El máximo número de conexiones Postgres por proceso, incluyendo conexiones persistentes.
pgsql.auto_reset_persistent integer: Detectar enlaces persistentes rotos con pg_pconnect(). Necesita un poco de carga extra.
pgsql.ignore_notice integer: Indica si se ignoran o no las noticias desde PostgreSQL.
pgsql.log_notice integer: Indica si se registran o no las noticias desde PostgreSQL. La directiva de PHP pgsql.ignore_notice debe estar deshabilitada para registrar mensajes tipo noticia.

Tipos de recursos

Existen dos tipos de recurso usados en el módulo PostgreSQL. El primero es el identificador de enlace para una conexión de base de datos, el segundo es un recurso que contiene el resultado de una consulta.

Constantes predefinidas

Estas constantes están definidas por esta extensión y estarán disponibles solamente cuando la extensión ha sido o bien compilada dentro de PHP o grabada dinámicamente en tiempo de ejecución.

PGSQL_ASSOC (integer): Pasada a pg_fetch_array(). Devolver una matriz asociativa de nombres y valores de campo.
PGSQL_NUM (integer): Pasada a pg_fetch_array(). Devolver una matriz indexada numéricamente con nombres y valores de campo.
PGSQL_BOTH (integer): Pasada a pg_fetch_array(). Devolver una matriz de valores de campo que sea indexada numéricamente (por número de campo) y asociativamente (por nombre de campo).
PGSQL_CONNECT_FORCE_NEW (integer): Pasada a pg_connect() para forzar la creación de una nueva conexión, en lugar de re-usar una conexión existente idéntica.
PGSQL_CONNECTION_BAD (integer): Devuelta por pg_connection_status() indicando que la conexión de base de datos está en un estado inválido.
PGSQL_CONNECTION_OK (integer): Devuelta por pg_connection_status() indicando que la conexión de base de datos está en un estado válido.
PGSQL_SEEK_SET (integer): Pasada a pg_lo_seek(). La operación de búsqueda ha de comenzar desde el inicio del objeto.
PGSQL_SEEK_CUR (integer): Pasada a pg_lo_seek(). La operación de búsqueda ha de comenzar desde la posición actual.
PGSQL_SEEK_END (integer): Pasada a pg_lo_seek(). La operación de búsqueda ha de comenzar desde el final del objeto.
PGSQL_EMPTY_QUERY (integer): Devuelta por pg_result_status(). La cadena enviada al servidor era vacía.
PGSQL_COMMAND_OK (integer): Devuelta por pg_result_status(). Culminación exitosa de un comando que no devuelve datos.
PGSQL_TUPLES_OK (integer): Devuelta por pg_result_status(). Culminación exitosa de un comando que devuelve datos (como SELECT o SHOW).
PGSQL_COPY_OUT (integer): Devuelta por pg_result_status(). Transferencia de datos de copia hacia afuera (desde el servidor) ha iniciado.
PGSQL_COPY_IN (integer): Devuelta por pg_result_status(). Transferencia de datos de copia hacia adentro (al servidor) ha iniciado.
PGSQL_BAD_RESPONSE (integer): Devuelta por pg_result_status(). La respuesta del servidor no fue entendida.
PGSQL_NONFATAL_ERROR (integer): Devuelta por pg_result_status(). Ocurrió un error no-fatal (una noticia o una advertencia).
PGSQL_FATAL_ERROR (integer): Devuelta por pg_result_status(). Ocurrió un error fatal.
PGSQL_TRANSACTION_IDLE (integer): Devuelta por pg_transaction_status(). La conexión está en espera actualmente, no en una transacción.
PGSQL_TRANSACTION_ACTIVE (integer): Devuelta por pg_transaction_status(). Un comando está en progreso en la conexión. Una consulta ha sido enviada a través de la conexión y no se ha completado aun.
PGSQL_TRANSACTION_INTRANS (integer): Devuelta por pg_transaction_status(). La conexión se encuentra en espera, en un bloque de transacción.
PGSQL_TRANSACTION_INERROR (integer): Devuelta por pg_transaction_status(). La conexión está en espera, en un bloque fallido de transacción.
PGSQL_TRANSACTION_UNKNOWN (integer): Devuelta por pg_transaction_status(). La conexión está mal.
PGSQL_DIAG_SEVERITY (integer): Pasada a pg_result_error_field(). La severidad; los contenidos del campo son ERROR, FATAL, o PANIC (en un mensaje de error), o WARNING, NOTICE, DEBUG, INFO, o LOG (en un mensaje de noticia), o una traducción localizada de uno de éstos. Siempre presente.
PGSQL_DIAG_SQLSTATE (integer): Pasada a pg_result_error_field(). El código SQLSTATE del error. El código SQLSTATE identifica el tipo de error que ha ocurrido; puede usarse por aplicaciones cliente para realizar operaciones específicas (tales como manejo de errores) en respuesta a un error de base de datos particular. Este campo no es localizable, y está siempre presente.
PGSQL_DIAG_MESSAGE_PRIMARY (integer): Pasada a pg_result_error_field(). El mensaje de error principalmente legible para humanos (típicamente una línea). Siempre presente.
PGSQL_DIAG_MESSAGE_DETAIL (integer): Pasada a pg_result_error_field(). Detalle: un mensaje de error opcional secundario que lleva más detalles sobre el problema. Puede extenderse a múltiples líneas.
PGSQL_DIAG_MESSAGE_HINT (integer): Pasada a pg_result_error_field(). Pista: una sugerencia adicional sobre qué hacer acerca del problema. Se espera que este valor difiera del detalle en tanto que ofrece consejos (potencialmente inapropriados) en lugar de meros hechos. Puede extenderse por múltiples líneas.
PGSQL_DIAG_STATEMENT_POSITION (integer): Pasada a pg_result_error_field(). Una cadena que contiene un entero decimal indicando la posición de un cursor de error como un índice en la cadena de sentencia original. El primer caracter tiene el índice 1, y las posiciones son medidas en caracteres, no bytes.
PGSQL_DIAG_INTERNAL_POSITION (integer): Pasada a pg_result_error_field(). Este valor es definido igual que el campo PG_DIAG_STATEMENT_POSITION, pero es usado cuando la posición del cursor se refiere a un comando generado internamente en lugar de uno enviado por el cliente. El campo PG_DIAG_INTERNAL_QUERY siempre aparecerá cuando este campo aparece.
PGSQL_DIAG_INTERNAL_QUERY (integer): Pasada a pg_result_error_field(). El texto de un comando fallido generado internamente. Éste puede ser, por ejemplo, una consulta SQL remitida por una función PL/pgSQL.
PGSQL_DIAG_CONTEXT (integer): Pasada a pg_result_error_field(). Una indicación del contexto en el que ocurrió el error. Actualmente esto incluye una pila de llamadas hacia atrás de funciones de lenguaje procedimental activas y consulta generadas internamente. El rastreo es una entrada por línea, la más reciente primero.
PGSQL_DIAG_SOURCE_FILE (integer): Pasada a pg_result_error_field(). El nombre de archivo del código fuente de PostgreSQL en donde el error fue reportado.
PGSQL_DIAG_SOURCE_LINE (integer): Pasada a pg_result_error_field(). El número de línea del código fuente de PostgreSQL en donde se reportó el error.
PGSQL_DIAG_SOURCE_FUNCTION (integer): Pasada a pg_result_error_field(). El nombre de la función en el código fuente de PostgreSQL en donde se reportó el error.
PGSQL_ERRORS_TERSE (integer): Pasada a pg_set_error_verbosity(). Especifica que los mensajes retornados incluyen severidad, texto primario, y posición solamente; esto por lo general cabe en una línea sencilla.
PGSQL_ERRORS_DEFAULT (integer): Pasada a pg_set_error_verbosity(). El modo predeterminado produce mensajes que incluyen lo anterior más cualquier detalle, pista, o campos de contexto (éstos pueden ocupar múltiples líneas).
PGSQL_ERRORS_VERBOSE (integer): Pasada a pg_set_error_verbosity(). Este modo incluye todos los campos disponibles.
PGSQL_STATUS_LONG (integer): Pasada a pg_result_status(). Indica que se desea un código de resultado numérico.
PGSQL_STATUS_STRING (integer): Pasada a pg_result_status(). Indica que se desea una etiqueta de comando textual como resultado.
PGSQL_CONV_IGNORE_DEFAULT (integer): Pasada a pg_convert(). Ignorar valores predeterminados en la tabla durante la conversión.
PGSQL_CONV_FORCE_NULL (integer): Pasada a pg_convert(). Usar el valor SQL NULL en lugar de un valor string vacío.
PGSQL_CONV_IGNORE_DEFAULT (integer): Pasada a pg_convert(). Ignorar la conversión de NULL en columnas SQL NOT NULL.

Notes

Note: No todas las funciones están soportadas por todas las versiones compiladas de PHP. Depende de la versión de libpq (la biblioteca cliente en C de PostgreSQL) y la forma en que ésta haya sido compilada. Si hacen falta extensiones de PostreSQL en PHP, ha de ser porque su versión de libpq no las soporta.

Note: La mayoría de funciones de PostgreSQL aceptan conexion como el primer parámetro opcional. Si éste no es definido, es usada la última conexión abierta. Si no existe, las funciones devuelven FALSE.

Note: PostgreSQL convierte automáticamente todos los identificadores (p.ej. nombres de tablas/columnas) a valores en minúsculas al momento de crear objetos y al momento de hacer consultas. Para forzar el uso de identificadores en mayúsculas o estilo mixto, es necesario escapar el identificador usando comillas dobles ("").

Note: PostgreSQL no cuenta con comandos especiales para recuperar información de esquemas de bases de datos (p.ej. todas las tablas en la base de datos actual). En su lugar, existe un esquema estándar llamado information_schema en PostgreSQL 7.4 y versiones posteriores, que contiene vistas de sistema con toda la información necesaria, en un formato de fácil consulta. Vea la » Documentación de PostgreSQL para más detalles.

Ejemplos

Este sencillo ejemplo muestra cómo conectarse, ejecutar una consulta, imprimer las filas de resultado y desconectarse de una base de datos PostgreSQL.

Example#1 Ejemplo de vista general de la extensión PostgreSQL


<?php
// Conexion, seleccion de base de datos
$conexion_bd = pg_connect("host=localhost dbname=publicaciones user=www password=foo")
    or die('No pudo conectarse: ' . pg_last_error());

// Realizar una consulta SQL
$consulta = 'SELECT * FROM autores';
$resultado = pg_query($consulta) or die('Consulta fallida: ' . pg_last_error());

// Impresion de resultados en HTML
echo "<table>\n";
while ($linea = pg_fetch_array($resultado, null, PGSQL_ASSOC)) {
    echo "\t<tr>\n";
    foreach ($linea as $valor_col) {
        echo "\t\t<td>$valor_col</td>\n";
    }
    echo "\t</tr>\n";
}
echo "</table>\n";

// Liberar conjunto de resultados
pg_free_result($resultado);

// Cerrar conexion
pg_close($conexion_bd);

?>

pg_affected_rows — Returns number of affected records (tuples)
pg_cancel_query — Cancel an asynchronous query
pg_client_encoding — Gets the client encoding
pg_Close — Cierra una conexión PostgreSQL
pg_Connect — Abre una conexión
pg_connection_busy — Get connection is busy or not
pg_connection_reset — Reset connection (reconnect)
pg_connection_status — Get connection status
pg_convert — Convert associative array values into suitable for SQL statement
pg_copy_from — Insert records into a table from an array
pg_copy_to — Copy a table to an array
pg_DBname — Nombre de la base de datos
pg_delete — Deletes records
pg_end_copy — Sync with PostgreSQL backend
pg_escape_bytea — Escape a string for insertion into a bytea field
pg_escape_string — Escape a string for insertion into a text field
pg_execute — Sends a request to execute a prepared statement with given parameters, and waits for the result.
pg_fetch_all_columns — Fetches all rows in a particular result column as an array
pg_fetch_all — Fetches all rows from a result as an array
pg_Fetch_Array — obtiene una fila en la forma de un array
pg_fetch_assoc — Fetch a row as an associative array
pg_Fetch_Object — obtener una fila en forma de objeto
pg_fetch_result — Returns values from a result resource
pg_Fetch_Row — obtiene la fila como un array enumerado
pg_field_is_null — Test if a field is SQL NULL
pg_field_name — Returns the name of a field
pg_field_num — Returns the field number of the named field
pg_field_prtlen — Returns the printed length
pg_field_size — Returns the internal storage size of the named field
pg_field_table — Returns the name or oid of the tables field
pg_field_type_oid — Returns the type ID (OID) for the corresponding field number
pg_field_type — Returns the type name for the corresponding field number
pg_free_result — Free result memory
pg_get_notify — Gets SQL NOTIFY message
pg_get_pid — Gets the backend's process ID
pg_get_result — Get asynchronous query result
pg_Host — Devuelve el nombre del host
pg_insert — Insert array into table
pg_last_error — Get the last error message string of a connection
pg_last_notice — Returns the last notice message from PostgreSQL server
pg_last_oid — Returns the last row's OID
pg_lo_close — Close a large object
pg_lo_create — Create a large object
pg_lo_export — Export a large object to file
pg_lo_import — Import a large object from file
pg_lo_open — Open a large object
pg_lo_read_all — Reads an entire large object and send straight to browser
pg_lo_read — Read a large object
pg_lo_seek — Seeks position within a large object
pg_lo_tell — Returns current seek position a of large object
pg_lo_unlink — Delete a large object
pg_lo_write — Write to a large object
pg_meta_data — Get meta data for table
pg_num_fields — Returns the number of fields in a result
pg_num_rows — Returns the number of rows in a result
pg_Options — Devuelve opciones
pg_parameter_status — Looks up a current parameter setting of the server.
pg_pConnect — Crea una conexión persistente con una base de datos
pg_ping — Ping database connection
pg_Port — Devuelve el número de puerto
pg_prepare — Submits a request to create a prepared statement with the given parameters, and waits for completion.
pg_put_line — Send a NULL-terminated string to PostgreSQL backend
pg_query_params — Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.
pg_query — Execute a query
pg_result_error_field — Returns an individual field of an error report.
pg_result_error — Get error message associated with result
pg_result_seek — Set internal row offset in result resource
pg_result_status — Get status of query result
pg_select — Select records
pg_send_execute — Sends a request to execute a prepared statement with given parameters, without waiting for the result(s).
pg_send_prepare — Sends a request to create a prepared statement with the given parameters, without waiting for completion.
pg_send_query_params — Submits a command and separate parameters to the server without waiting for the result(s).
pg_send_query — Sends asynchronous query
pg_set_client_encoding — Set the client encoding
pg_set_error_verbosity — Determines the verbosity of messages returned by pg_last_error and pg_result_error.
pg_trace — Enable tracing a PostgreSQL connection
pg_transaction_status — Returns the current in-transaction status of the server.
pg_tty — Devuelve el nombre del tty
pg_unescape_bytea — Unescape binary for bytea type
pg_untrace — Disable tracing of a PostgreSQL connection
pg_update — Update table
pg_version — Returns an array with client, protocol and server version (when available)