Class IOracleClob

constructor

• new IOracleClob(): IOracleClob

  Returns IOracleClob

StaticLOB_READONLY

StaticLOB_READWRITE

close

• close(): any

  This method closes a previously opened CLOB.

  Returns any

freeTemporary

• freeTemporary(): any

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

  Returns any

getChunkSize

• getChunkSize(): number

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

  Returns number

getData

• getData(): string

  Returns all the CLOB/NCLOB data as string.

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

  Returns string

isOpen

• isOpen(): boolean

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

  Returns boolean

isTemporary

• isTemporary(): boolean

  This method determines whether a CLOB instance is temporary.

  Returns boolean

length

• length(): number

  This method gets the length of the specified CLOB. The length in characters is returned.

  Returns number

open

• open(mode: number): any

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

  Parameters

  • mode: number

  Returns any

read

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

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

  Parameters

  • amount: number

    Number of characters to read.

  • offset: number

    Offset in characters from the start of the CLOB (origin: 1).

  Returns string

  a string that contains the characters actually read.

write

• write(offset: number, buffer: string): any

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

  Parameters

  • offset: number

    Offset in characters from the start of the CLOB (origin: 1) for the write operation.

  • buffer: string

    Data to write.

  Returns any

Staticcompare

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

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

  Parameters

  • lob1: IOracleClob

    First target for comparison.

  • lob2: IOracleClob

    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 CLOB offset value.

StaticcreateTemporary

• createTemporary(cache: boolean, isNClob?: boolean): any

  createTemporary creates a temporary CLOB and its corresponding index in your default temporary tablespace. The temporary CLOB is created with SESSION duration.

  Parameters

  • cache: boolean

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

  • OptionalisNClob: boolean

    If set to true will create a temporary NCLOB instead of regular CLOB.

  Returns any