SysIndexDetails in Miscellaneous

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	SysIndexDetails/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.0"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

Attributes

Name	Description	First Included in Instance
RecId		Miscellaneous/SysIndexDetails
SchemaName		Miscellaneous/SysIndexDetails
TableName		Miscellaneous/SysIndexDetails
IndexName		Miscellaneous/SysIndexDetails
TableIdNumber		Miscellaneous/SysIndexDetails
IndexIdNumber		Miscellaneous/SysIndexDetails
IndexType		Miscellaneous/SysIndexDetails
IndexTypeDescription		Miscellaneous/SysIndexDetails
IndexLevel		Miscellaneous/SysIndexDetails
AllowPageLocks		Miscellaneous/SysIndexDetails
PartitionNumber		Miscellaneous/SysIndexDetails
RecordCount		Miscellaneous/SysIndexDetails

RecId

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	SysIndexDetails/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

SchemaName

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the SchemaName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TableName

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
displayName	Table name
dataFormat	string
isNullable	true

Traits

List of traits for the TableName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Table name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

IndexName

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
displayName	Index name
dataFormat	string
isNullable	true

Traits

List of traits for the IndexName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Index name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

TableIdNumber

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TableIdNumber attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

IndexIdNumber

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the IndexIdNumber attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

IndexType

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the IndexType attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

IndexTypeDescription

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
displayName	Index type description
dataFormat	string
isNullable	true

Traits

List of traits for the IndexTypeDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Index type description	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

IndexLevel

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
displayName	Current level of the index
dataFormat	string
isNullable	true

Traits

List of traits for the IndexLevel attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Current level of the index	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

AllowPageLocks

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
displayName	Allow page lock
dataFormat	int32
isNullable	true

Traits

List of traits for the AllowPageLocks attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Allow page lock	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

PartitionNumber

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
displayName	1-based partition number within the owning index
dataFormat	int32
isNullable	true

Traits

List of traits for the PartitionNumber attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en 1-based partition number within the owning index	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

RecordCount

First included in: Miscellaneous/SysIndexDetails (this entity)

Properties

Name	Value
displayName	Total number of records
dataFormat	int64
isNullable	true

Traits

List of traits for the RecordCount attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Total number of records	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big