LOB Objects

System Message: INFO/1 (<string>, line 7)

No role entry for "ref" in module "docutils.parsers.rst.languages.en". Trying "ref" as canonical role name.

System Message: ERROR/3 (<string>, line 7); backlink

Unknown interpreted text role "ref".

System Message: INFO/1 (<string>, line 15)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 15)

Unknown directive type "method".

.. method:: LOB.close()

    Close the LOB. Call this when writing is completed so that the indexes
    associated with the LOB can be updated -- but only if :meth:`~LOB.open()`
    was called first.

System Message: INFO/1 (<string>, line 22)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 22)

Unknown directive type "method".

.. method:: LOB.fileexists()

    Return a boolean indicating if the file referenced by the BFILE type LOB
    exists.

System Message: INFO/1 (<string>, line 28)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 28)

Unknown directive type "method".

.. method:: LOB.getchunksize()

    Return the chunk size for the internal LOB. Reading and writing to the LOB
    in chunks of multiples of this size will improve performance.

System Message: INFO/1 (<string>, line 34)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 34)

Unknown directive type "method".

.. method:: LOB.getfilename()

    Return a two-tuple consisting of the directory alias and file name for a
    BFILE type LOB.

System Message: INFO/1 (<string>, line 40)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 40)

Unknown directive type "method".

.. method:: LOB.isopen()

    Return a boolean indicating if the LOB has been opened using the method
    :meth:`~LOB.open()`.

System Message: INFO/1 (<string>, line 46)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 46)

Unknown directive type "method".

.. method:: LOB.open()

    Open the LOB for writing. This will improve performance when writing to a
    LOB in chunks and there are functional or extensible indexes associated
    with the LOB. If this method is not called, each write will perform an open
    internally followed by a close after the write has been completed.

System Message: INFO/1 (<string>, line 54)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 54)

Unknown directive type "method".

.. method:: LOB.read([offset=1, [amount]])

    Return a portion (or all) of the data in the LOB object. Note that the
    amount and offset are in bytes for BLOB and BFILE type LOBs and in UCS-2
    code points for CLOB and NCLOB type LOBs. UCS-2 code points are equivalent
    to characters for all but supplemental characters. If supplemental
    characters are in the LOB, the offset and amount will have to be chosen
    carefully to avoid splitting a character.

System Message: INFO/1 (<string>, line 64)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 64)

Unknown directive type "method".

.. method:: LOB.setfilename(dirAlias, name)

    Set the directory alias and name of the BFILE type LOB.

System Message: INFO/1 (<string>, line 69)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 69)

Unknown directive type "method".

.. method:: LOB.size()

    Returns the size of the data in the LOB object. For BLOB and BFILE type
    LOBs this is the number of bytes. For CLOB and NCLOB type LOBs this is the
    number of UCS-2 code points. UCS-2 code points are equivalent to characters
    for all but supplemental characters.

System Message: INFO/1 (<string>, line 77)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 77)

Unknown directive type "method".

.. method:: LOB.trim([newSize=0])

    Trim the LOB to the new size.

System Message: INFO/1 (<string>, line 82)

No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.

System Message: ERROR/3 (<string>, line 82)

Unknown directive type "attribute".

.. attribute:: LOB.type

    This read-only attribute returns the type of the LOB as one of the
    :ref:`database type constants <dbtypes>`.

    .. versionadded:: 8.0

System Message: INFO/1 (<string>, line 90)

No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.

System Message: ERROR/3 (<string>, line 90)

Unknown directive type "method".

.. method:: LOB.write(data, [offset=1])

    Write the data to the LOB object at the given offset. The offset is in
    bytes for BLOB type LOBs and in UCS-2 code points for CLOB and NCLOB type
    LOBs. UCS-2 code points are equivalent to characters for all but
    supplemental characters. If supplemental characters are in the LOB, the
    offset will have to be chosen carefully to avoid splitting a character.
    Note that if you want to make the LOB value smaller, you must use the
    :meth:`~LOB.trim()` function.