RetroSearch Browse

Showing content from https://python-oracledb.readthedocs.io/en/latest/api_manual/lob.html below:

12. API: LOB Objects 12.1. LOB Class

class oracledb.LOB

A LOB object should be created with Connection.createlob().

This object is returned by default whenever Oracle CLOB, BLOB, and BFILE columns are fetched.

This type object is the Python type of DB_TYPE_BLOB, DB_TYPE_BFILE, DB_TYPE_CLOB and DB_TYPE_NCLOB data that is returned from cursors.

This object is an extension to the DB API definition.

See Using CLOB, BLOB, NCLOB, and BFILE Data for more information about using LOBs.

12.2. LOB Methods

LOB.close() → None: Closes the LOB. Call this when writing is completed so that the indexes associated with the LOB can be updated -– but only if open() was called first.

LOB.fileexists() → bool: Returns a boolean indicating if the file referenced by a BFILE type LOB exists.

LOB.getchunksize() → int: Returns the chunk size for the LOB. Reading and writing to the LOB in chunks of multiples of this size will improve performance.

LOB.getfilename() → tuple: Returns a two-tuple consisting of the directory alias and file name for a BFILE type LOB.

LOB.isopen() → bool: Returns a boolean indicating if the LOB has been opened using the method open().

LOB.open() → None: Opens the LOB for writing. This will improve performance when writing to the 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.

LOB.read(offset: int = 1, amount: int | None = None) → str | bytes: Returns a portion (or all) of the data in the LOB. 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.

LOB.setfilename(dir_alias: str, name: str) → None: Sets the directory alias and name of a BFILE type LOB.

LOB.size() → int: Returns the size of the data in the LOB. 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.

LOB.trim(new_size: int = 0, *, newSize: int | None = None) → None: Trims the LOB to the new size (the second parameter is deprecated and should not be used).

LOB.write(data: str | bytes, offset: int = 1) → None: Writes the data to the LOB 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 trim() function.

12.3. LOB Attributes

property LOB.type: DbType

This read-only attribute returns the type of the LOB as one of the database type constants.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4