• « pg_lo_truncate
  • pg_lo_write »
  • PHP Manual
  • Funções PostgreSQL
  • Exclui um objeto grande

pg_lo_unlink

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

pg_lo_unlink — Exclui um objeto grande

Descrição

pg_lo_unlink(PgSql\Connection $connection, int $oid): bool

pg_lo_unlink() exclui um objeto grande com o oid. Retorna true em caso de sucesso ou false em caso de falha.

Para usar a interface de objeto grande, é necessário incluí-la em um bloco de transação.

Nota:

Esta função costumava ser chamada de pg_lounlink().

Parâmetros

connection

Uma instância de PgSql\Connection. Quando o parâmetro connection não for especificado, a conexão padrão será usada. A conexão padrão é a última conexão feita por pg_connect() ou pg_pconnect().

Aviso

A partir do PHP 8.1.0, usar a conexão padrão foi descontinuado.

oid

O OID do objeto grande no banco de dados.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro connection agora espera uma instância de PgSql\Connection; anteriormente, um resource era esperado.

Exemplos

Exemplo #1 Exemplo depg_lo_unlink()

<?php
// OID do objeto grande a ser excluído
$doc_oid = 189762345;
$database = pg_connect("dbname=jacarta");
pg_query($database, "begin");
pg_lo_unlink($database, $doc_oid);
pg_query($database, "commit");
?>

Veja Também

  • pg_lo_create() - Cria um objeto grande
  • pg_lo_import() - Importa um objeto grande do arquivo