Class OracleBlob

constructor

• new OracleBlob(delegate: any): OracleBlob

  Parameters

  • delegate: any

  Returns OracleBlob

StaticLOB_READONLY

StaticLOB_READWRITE

close

• close(...args: any[]): void

  This method closes a previously opened BLOB.

  Parameters

  • ...args: any[]

  Returns void

freeTemporary

• freeTemporary(...args: any[]): void

  This method frees the temporary BLOB in the default temporary tablespace.

  Parameters

  • ...args: any[]

  Returns void

getChunkSize

• getChunkSize(...args: any[]): number

  When creating the table, you can specify the chunking factor, a multiple of tablespace blocks in bytes. This corresponds to the chunk size used by the BLOB data layer when accessing or modifying the BLOB value. Part of the chunk is used to store system-related information, and the rest stores the BLOB value. This method returns the amount of space used in the BLOB chunk to store the BLOB value.

  Parameters

  • ...args: any[]

  Returns number

getData

• getData(): Uint8Array

  Returns all the BLOB data as Uint8Array.

  For queries returning LOB columns, it can be more efficient to use fetchAsUint8Array, or fetchInfo instead of lob.getData().

  Returns Uint8Array

  Throws

  Error if blob is too large.

getDelegate

• getDelegate(): any

  Returns any

isOpen

• isOpen(...args: any[]): boolean

  This method checks to see if the BLOB was already opened using the input locator.

  Parameters

  • ...args: any[]

  Returns boolean

isOracleBlob

• isOracleBlob(): boolean

  Returns boolean

isTemporary

• isTemporary(...args: any[]): boolean

  This method determines whether a BLOB instance is temporary.

  Parameters

  • ...args: any[]

  Returns boolean

length

• length(...args: any[]): number

  This method gets the length of the specified BLOB. The length in bytes is returned.

  Parameters

  • ...args: any[]

  Returns number

open

• open(mode: number): void

  This method opens a BLOB in the indicated mode. Valid modes include read-only and read/write.

  Parameters

  • mode: number

  Returns void

read

• read(amount: number, offset: number): Uint8Array

  This method reads a piece of a BLOB, and returns the specified amount into the buffer parameter, starting from an absolute offset from the beginning of the BLOB. If the input offset points past the End of BLOB, a NO_DATA_FOUND exception is raised.

  Parameters

  • amount: number

    Number of bytes to read.

  • offset: number

    Offset in bytes from the start of the BLOB (origin: 1).

  Returns Uint8Array

  a Uint8Array that contains the bytes actually read.

write

• write(offset: number, buffer: Uint8Array): void

  This method writes data into an internal BLOB, starting from an absolute offset from the beginning of the BLOB. The data is written from the buffer parameter. WRITE replaces (overwrites) any data that already exists in the BLOB at the offset.

  Parameters

  • offset: number

    Offset in bytes from the start of the BLOB (origin: 1) for the write operation.

  • buffer: Uint8Array

    Data to write.

  Returns void

Staticcompare

• compare(
      lob1: OracleBlob,
      lob2: OracleBlob,
      optArgs?: CompareOptionalArguments,
  ): number

  This method compares two entire BLOBs or parts of two BLOBs.

  Parameters

  • lob1: OracleBlob

    First target for comparison.

  • lob2: OracleBlob

    Second target for comparison.

  • OptionaloptArgs: CompareOptionalArguments

    Optional arguments that specify amount and offsets.

  Returns number

  0 if the compared portions are equal, non-zero if not

  Throws

  Error if offset1 or offset2 is not a valid BLOB offset value.

StaticcreateTemporary

• createTemporary(cache: boolean): OracleBlob

  This constructor creates a temporary BLOB and its corresponding index in your default temporary tablespace. The temporary BLOB is created with SESSION duration.

  Parameters

  • cache: boolean

    Specifies if BLOB should be read into buffer cache or not.

  Returns OracleBlob