• PHP Manual
  • Function Reference
  • Database Extensions
  • Vendor Specific Database Extensions
  • PostgreSQL
  • PostgreSQL Functions
  • pg_affected_rows
  • pg_cancel_query
  • pg_client_encoding
  • pg_close
  • pg_connect
  • pg_connect_poll
  • pg_connection_busy
  • pg_connection_reset
  • pg_connection_status
  • pg_consume_input
  • pg_convert
  • pg_copy_from
  • pg_copy_to
  • pg_dbname
  • pg_delete
  • pg_end_copy
  • pg_escape_bytea
  • pg_escape_identifier
  • pg_escape_literal
  • pg_escape_string
  • pg_execute
  • pg_fetch_all
  • pg_fetch_all_columns
  • pg_fetch_array
  • pg_fetch_assoc
  • pg_fetch_object
  • pg_fetch_result
  • pg_fetch_row
  • pg_field_is_null
  • pg_field_name
  • pg_field_num
  • pg_field_prtlen
  • pg_field_size
  • pg_field_table
  • pg_field_type
  • pg_field_type_oid
  • pg_flush
  • pg_free_result
  • pg_get_notify
  • pg_get_pid
  • pg_get_result
  • pg_host
  • pg_insert
  • pg_last_error
  • pg_last_notice
  • pg_last_oid
  • pg_lo_close
  • pg_lo_create
  • pg_lo_export
  • pg_lo_import
  • pg_lo_open
  • pg_lo_read
  • pg_lo_read_all
  • pg_lo_seek
  • pg_lo_tell
  • pg_lo_truncate
  • pg_lo_unlink
  • pg_lo_write
  • pg_meta_data
  • pg_num_fields
  • pg_num_rows
  • pg_options
  • pg_parameter_status
  • pg_pconnect
  • pg_ping
  • pg_port
  • pg_prepare
  • pg_put_line
  • pg_query
  • pg_query_params
  • pg_result_error
  • pg_result_error_field
  • pg_result_memory_size
  • pg_result_seek
  • pg_result_status
  • pg_select
  • pg_send_execute
  • pg_send_prepare
  • pg_send_query
  • pg_send_query_params
  • pg_set_chunked_rows_size
  • pg_set_client_encoding
  • pg_set_error_context_visibility
  • pg_set_error_verbosity
  • pg_socket
  • pg_trace
  • pg_transaction_status
  • pg_tty
  • pg_unescape_bytea
  • pg_untrace
  • pg_update
  • pg_version
pg_lo_truncate
pg_lo_write
PostgreSQL Functions
PHP Manual

pg_lo_unlink

Delete a large object

Description

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

pg_lo_unlink deletes a large object with the oid. Returns true on success or false on failure.

To use the large object interface, it is necessary to enclose it within a transaction block.

Note:

This function used to be called pg_lounlink.

Parameters

connection

An PgSql\Connection instance. When connection is unspecified, the default connection is used. The default connection is the last connection made by pg_connect or pg_pconnect.

Warning

As of PHP 8.1.0, using the default connection is deprecated.

oid

The OID of the large object in the database.

Return Values

Returns true on success or false on failure.

Changelog

Version Description
8.1.0 The connection parameter expects an PgSql\Connection instance now; previously, a resource was expected.

Examples

Example #1 pg_lo_unlink example

<?php
   // OID of the large object to delete
   $doc_oid = 189762345;
   $database = pg_connect("dbname=jacarta");
   pg_query($database, "begin");
   pg_lo_unlink($database, $doc_oid);
   pg_query($database, "commit");
?>

See Also

  • pg_lo_create
  • pg_lo_import