<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.pdo-pgsql.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'pdo-pgsql.lobunlink.php',
    1 => 'Pdo\\Pgsql::lobUnlink',
    2 => 'Deletes the large object',
  ),
  'up' => 
  array (
    0 => 'class.pdo-pgsql.php',
    1 => 'Pdo\\Pgsql',
  ),
  'prev' => 
  array (
    0 => 'pdo-pgsql.lobopen.php',
    1 => 'Pdo\\Pgsql::lobOpen',
  ),
  'next' => 
  array (
    0 => 'pdo-pgsql.setnoticecallback.php',
    1 => 'Pdo\\Pgsql::setNoticeCallback',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/pdo_pgsql/pdo/pgsql/lobunlink.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="pdo-pgsql.lobunlink" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Pdo\Pgsql::lobUnlink</h1>
  <p class="verinfo">(PHP 8 &gt;= 8.4.0)</p><p class="refpurpose"><span class="refname">Pdo\Pgsql::lobUnlink</span> &mdash; <span class="dc-title">Deletes the large object</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-pdo-pgsql.lobunlink-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Pdo\Pgsql::lobUnlink</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$oid</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Deletes a large object from the database identified by OID.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    This function, and all manipulations of the large object,
    must be called and carried out within a transaction.
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-pdo-pgsql.lobunlink-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">oid</code></dt>
    <dd>
     <span class="simpara">
      A large object identifier.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-pdo-pgsql.lobunlink-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-pdo-pgsql.lobunlink-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="pdo-pgsql.lobunlink.example.basic">
   <p><strong>Example #1 <span class="methodname"><strong>Pdo\Pgsql::lobUnlink()</strong></span> example</strong></p>
   <div class="example-contents"><p>
    This example unlinks a large object from the database prior to deleting
    the row that references it from the blobs table are used in the examples of
    <span class="methodname"><a href="pdo-pgsql.lobcreate.php" class="methodname">Pdo\Pgsql::lobCreate()</a></span> and
    <span class="methodname"><a href="pdo-pgsql.lobopen.php" class="methodname">Pdo\Pgsql::lobOpen()</a></span>.
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$db </span><span style="color: #007700">= new </span><span style="color: #0000BB">PDO</span><span style="color: #007700">(</span><span style="color: #DD0000">'pgsql:dbname=test host=localhost'</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$pass</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setAttribute</span><span style="color: #007700">(</span><span style="color: #0000BB">PDO</span><span style="color: #007700">::</span><span style="color: #0000BB">ATTR_ERRMODE</span><span style="color: #007700">, </span><span style="color: #0000BB">PDO</span><span style="color: #007700">::</span><span style="color: #0000BB">ERRMODE_EXCEPTION</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">beginTransaction</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">pgsqlLOBUnlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$oid</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">prepare</span><span style="color: #007700">(</span><span style="color: #DD0000">"DELETE FROM BLOBS where ident = ?"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">(array(</span><span style="color: #0000BB">$some_id</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">commit</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-pdo-pgsql.lobunlink-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="pdo-pgsql.lobcreate.php" class="methodname" rel="rdfs-seeAlso">Pdo\Pgsql::lobCreate()</a> - Creates a new large object</span></li>
   <li><span class="methodname"><a href="pdo-pgsql.lobopen.php" class="methodname" rel="rdfs-seeAlso">Pdo\Pgsql::lobOpen()</a> - Opens an existing large object stream</span></li>
   <li><span class="function"><a href="function.pg-lo-create.php" class="function" rel="rdfs-seeAlso">pg_lo_create()</a> - Create a large object</span></li>
   <li><span class="function"><a href="function.pg-lo-open.php" class="function" rel="rdfs-seeAlso">pg_lo_open()</a> - Open a large object</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>