Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DatabaseParameterSummary

A summary of the database parameter.

Properties

Optional allowedValues

A list of allowed values for this parameter.

Optional category

category: undefined | string

The parameter category.

Optional constraint

constraint: Constraint

Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases. A {@code UNIQUE} parameter is one which is unique to each Oracle Real Application Clusters (Oracle RAC) instance. For example, the parameter {@code INSTANCE_NUMBER} must have different values in each instance. An {@code IDENTICAL} parameter must have the same value for every instance. For example, the parameter {@code DB_BLOCK_SIZE} must have the same value in all instances.

Optional containerId

containerId: undefined | number

The ID of the database container to which the data pertains. Possible values include:

  • {@code 0}: This value is used for data that pertain to the entire CDB. This value is also used for data in non-CDBs.
  • {@code 1}: This value is used for data that pertain to only the root container.
  • {@code n}: Where n is the applicable container ID for the data. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional description

description: undefined | string

The description of the parameter.

displayValue

displayValue: string

The parameter value in a user-friendly format. For example, if the {@code value} property shows the value 262144 for a big integer parameter, then the {@code displayValue} property will show the value 256K.

Optional isAdjusted

isAdjusted: undefined | false | true

Indicates whether Oracle adjusted the input value to a more suitable value.

Optional isBasic

isBasic: undefined | false | true

Indicates whether the parameter is a basic parameter ({@code TRUE}) or not ({@code FALSE}).

Optional isDefault

isDefault: undefined | false | true

Indicates whether the parameter is set to the default value ({@code TRUE}) or the parameter value was specified in the parameter file ({@code FALSE}).

Optional isDeprecated

isDeprecated: undefined | false | true

Indicates whether the parameter has been deprecated ({@code TRUE}) or not ({@code FALSE}).

Optional isInstanceModifiable

isInstanceModifiable: undefined | false | true

For parameters that can be changed with {@code ALTER SYSTEM}, indicates whether the value of the parameter can be different for every instance ({@code TRUE}) or whether the parameter must have the same value for all Real Application Clusters instances ({@code FALSE}). For other parameters, this is always {@code FALSE}.

Optional isModified

isModified: IsModified

Indicates how the parameter was modified. If an {@code ALTER SYSTEM} was performed, the value will be {@code MODIFIED}.

Optional isPdbModifiable

isPdbModifiable: undefined | false | true

Indicates whether the parameter can be modified on a per-PDB basis ({@code TRUE}) or not ({@code FALSE}). In a non-CDB, the value of this property is {@code null}.

Optional isSessionModifiable

isSessionModifiable: undefined | false | true

Indicates whether the parameter can be changed with {@code ALTER SESSION} ({@code TRUE}) or not ({@code FALSE})

Optional isSpecified

isSpecified: undefined | false | true

Indicates whether the parameter was specified in the server parameter file ({@code TRUE}) or not ({@code FALSE}). Applicable only when the parameter source is {@code SPFILE}.

Optional isSystemModifiable

isSystemModifiable: IsSystemModifiable

Indicates whether the parameter can be changed with {@code ALTER SYSTEM} and when the change takes effect:

  • IMMEDIATE: Parameter can be changed with {@code ALTER SYSTEM} regardless of the type of parameter file used to start the instance. The change takes effect immediately.
  • DEFERRED: Parameter can be changed with {@code ALTER SYSTEM} regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions.
  • FALSE: Parameter cannot be changed with {@code ALTER SYSTEM} unless a server parameter file was used to start the instance. The change takes effect in subsequent instances.

name

name: string

The parameter name.

Optional number

number: undefined | number

The parameter number. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional ordinal

ordinal: undefined | number

The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sid

sid: undefined | string

The database instance SID for which the parameter is defined.

type

type: Type

The parameter type.

Optional updateComment

updateComment: undefined | string

The comments associated with the most recent update.

value

value: string

The parameter value.

Functions

getDeserializedJsonObj

getJsonObj