Files
2025-03-02 21:46:47 -03:00

117 lines
3.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: 02b075821852f44e97742ba6f586cc2fa3272806 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xml:id="pdo-pgsql.lobcreate" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Pdo\Pgsql::lobCreate</refname>
<refpurpose>Cria um novo objeto grande</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Pdo\\Pgsql">
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Pdo\Pgsql::lobCreate</methodname>
<void/>
</methodsynopsis>
<simpara>
<methodname>Pdo\Pgsql::lobCreate</methodname> cria um objeto grande
e retorna o OID que se refere a ele.
Ele pode ser aberto para ler ou gravar dados
com <methodname>Pdo\Pgsql::lobOpen</methodname>.
</simpara>
<simpara>
O OID pode ser armazenado em colunas do tipo OID e usado para fazer referência
ao objeto grande, sem fazer com que a linha cresça arbitrariamente.
O objeto grande continuará no banco de dados até ser removido
chamando <methodname>Pdo\Pgsql::lobUnlink</methodname>.
</simpara>
<simpara>
Objetos grandes são complicados de usar.
Na verdade, é necessário que <methodname>Pdo\Pgsql::lobUnlink</methodname>
seja chamado antes de excluir a última linha que faz referência ao OID em todo o banco de dados;
caso contrário, objetos grandes não referenciados permanecerão no servidor indefinidamente.
Além disso, objetos grandes não possuem controles de acesso.
Uma alternativa é o tipo de coluna bytea, que pode ter até 1 GB de tamanho,
e esse tipo de coluna gerencia de forma transparente o armazenamento para obter o tamanho de linha ideal.
</simpara>
<note>
<simpara>
Esta função e todas as manipulações de objeto grande
devem ser chamadas e executadas dentro de uma transação.
</simpara>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Retorna o OID do objeto grande recém-criado em caso de sucesso,
&return.falseforfailure;.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="pdo-pgsql.lobcreate.example.basic">
<title>Exemplo de <methodname>Pdo\Pgsql::lobCreate</methodname></title>
<simpara>
Este exemplo cria um novo objeto grande e copia nele o
conteúdo de um arquivo.
O OID é então armazenado em uma tabela.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
$db = new Pdo\Pgsql('pgsql:dbname=test host=localhost', $user, $pass);
$db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
$db->beginTransaction();
$oid = $db->lobCreate();
$stream = $db->lobOpen($oid, 'w');
$local = fopen($filename, 'rb');
stream_copy_to_stream($local, $stream);
$local = null;
$stream = null;
$stmt = $db->prepare("INSERT INTO BLOBS (ident, oid) VALUES (?, ?)");
$stmt->execute([$some_id, $oid]);
$db->commit();
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Pdo\Pgsql::lobOpen</methodname></member>
<member><methodname>Pdo\Pgsql::lobUnlink</methodname></member>
<member><function>pg_lo_create</function></member>
<member><function>pg_lo_open</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->