Class IDbObjectClassAbstract

Interface for representing the named Oracle Database object or collection.

Since

Oracle 23.3

Hierarchy

  • IDbObjectClass

Properties

attributes? elementType? elementTypeClass? elementTypeName? fqn? isCollection? length? name? packageName? schema?

Methods

append? deleteElement? getElement? getFirstIndex? getKeys? getLastIndex? getNextIndex? getPrevIndex? getValues? hasElement? setElement? trim?

Properties

Optional attributes

attributes?: Record<string, IDbObjectAttributes>

List of attributes corresponding to the Oracle Database object attributes. The name of each attribute follows normal Oracle casing semantics.

Optional Readonly elementType

elementType?: number

When dbObject.isCollection is true, this will have a value corresponding to one of the Oracle Database Type Constants.

Optional Readonly elementTypeClass

elementTypeClass?: IDbObjectClass

When dbObject.isCollection is true and the elements in the collection refer to database objects, this property provides the type class information of the elements.

Since

Oracle 23.4

Optional Readonly elementTypeName

elementTypeName?: string

When dbObject.isCollection is true, this will have the name of the element type, such as “VARCHAR2” or “NUMBER”.

Optional Readonly fqn

fqn?: string

Fully qualified name of the Oracle Database object or collection.

Optional Readonly isCollection

isCollection?: boolean

True if the Oracle object is a collection, false otherwise.

Optional Readonly length

length?: number

When dbObject.isCollection is true, this will have the number of elements in the collection. It is undefined for non-collections.

Optional Readonly name

name?: string

Name of the Oracle Database object or collection.

Optional Readonly packageName

packageName?: string

String which identifies the name of the package, if the type refers to a PL/SQL type. Otherwise, it returns undefined. * *

Since

Oracle 23.4

Optional Readonly schema

schema?: string

Schema owning the Oracle Database object or collection.

Methods

Optional Abstract append

  • Adds the given value to the end of the collection.

    Parameters

    • value: any

    Returns void

Optional Abstract deleteElement

  • Deletes the value from the collection at the given index.

    Parameters

    • index: number

    Returns void

Optional Abstract getElement

  • Returns the value associated with the given index.

    Parameters

    • index: number

    Returns any

Optional Abstract getFirstIndex

  • Returns the first index for later use to obtain the value.

    Returns number

Optional Abstract getKeys

  • Returns a JavaScript array containing the ‘index’ keys.

    Returns number[]

Optional Abstract getLastIndex

  • Obtains the last index for later use to obtain a value.

    Returns number

Optional Abstract getNextIndex

  • Returns the next index value for later use to obtain a value.

    Parameters

    • index: number

    Returns any

Optional Abstract getPrevIndex

  • Returns the previous index for later use to obtain the value.

    Parameters

    • index: number

    Returns any

Optional Abstract getValues

  • Returns an array of element values as a JavaScript array in key order.

    Returns any[]

Optional Abstract hasElement

  • Returns true if an element exists in the collection at the given index. Returns false otherwise.

    Parameters

    • index: number

    Returns boolean

Optional Abstract setElement

  • To set the given value at the position of the given index.

    Parameters

    • index: number
    • value: any

    Returns void

Optional Abstract trim

  • Parameters

    • count: number

      : Trims the specified number of elements from the end of the collection.

    Returns IDbObjectClass

Settings

Member Visibility

Theme