Inheritance diagram for IndexDefinition:

[legend]

Collaboration diagram for IndexDefinition:

[legend]

Public Attributes
	Abstract
	Specifies that this index should be abstract. More...

	Condition
	In the case of a conditional index, specifies the condition that must be met for an entry to be included in the index. More...

	CoshardWith
	Specifies the name of the class this class is cosharded with. More...

	Data
	Specifies a list of properties whose values are to be stored within this index. More...

	Deprecated
	True if this index is deprecated. More...

	Description
	Specifies a description of the index. More...

	Extent
	An extent index is used to keep track of which object instances belong to a subclass. More...

	IdKey
	Specifies that the property or properties defined for this index will be used to form the Object Identity value for this object. More...

	Internal
	If true, then do not display this item in automatic documentation. More...

	Name
	The name of the index. More...

	Parameters
	Parameter. More...

	PrimaryKey
	Specifies that this index should be reported, via SQL, as being the Primary Key for this class. More...

	Properties
	Specifies a list of properties used to build this index. More...

	SequenceNumber
	SequenceNumber. More...

	ShardKey
	If true then this index defines the components of the shard key. More...

	SqlName
	Defines an alternate name for this index when referred to via SQL. More...

	Type
	Specifies the type of the index. More...

	TypeClass
	Specifies the FunctionalIndex class used to provide the implementation of the functional index interface. More...

	Unique
	Specifies whether this is a unique index. More...

	parent
	Pointer to the containing parent object. More...

Additional Inherited Members
Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Member Data Documentation

◆ Abstract

Abstract

Specifies that this index should be abstract.

Not projected to SQL, holds no data.

◆ Condition

Condition

In the case of a conditional index, specifies the condition that must be met for an entry to be included in the index.

◆ CoshardWith

CoshardWith

Specifies the name of the class this class is cosharded with.

◆ Data

Data

Specifies a list of properties whose values are to be stored within this index.

◆ Deprecated

Deprecated

True if this index is deprecated.

◆ Description

Description

Specifies a description of the index.

◆ Extent

Extent

An extent index is used to keep track of which object instances belong to a subclass.

When using bitmap indices, then an extent index is automatically maintained and there is no need to define one.

◆ IdKey

IdKey

Specifies that the property or properties defined for this index will be used to form the Object Identity value for this object.

This value is used to uniquely locate persistent object instances.

◆ Internal

Internal

If true, then do not display this item in automatic documentation.

◆ Name

Name

The name of the index.

◆ Parameters

Parameters

Parameter.

◆ PrimaryKey

PrimaryKey

Specifies that this index should be reported, via SQL, as being the Primary Key for this class.

◆ Properties

Properties

Specifies a list of properties used to build this index.

May also include a collation specification for each property.

◆ SequenceNumber

SequenceNumber

SequenceNumber.

◆ ShardKey

ShardKey

If true then this index defines the components of the shard key.

◆ SqlName

SqlName

Defines an alternate name for this index when referred to via SQL.

◆ Type

Type

Specifies the type of the index.

Type 'key' is deprecated.

◆ TypeClass

TypeClass

Specifies the FunctionalIndex class used to provide the implementation of the functional index interface.

◆ Unique

Unique

Specifies whether this is a unique index.

The property or properties indexed by a unique index are constrained to have unique values. This means that no two instances can have the same collated value within the extent among the set of all objects of the class that defines the index.

◆ parent

parent

Pointer to the containing parent object.

Public Attributes

Additional Inherited Members