ITenantGroup properties

Inherits properties from IDataAdminElement and defines the properties listed in the following table.

Table 1. Multi-tenant Maintenance ITenantGroup interface properties
Property name Data type Access Description
DefaultAllocation CHARACTER Readable, Writeable Set to a preference that decides whether to allocate partitions when the tenant group is created, or when new multi-tenant indexes or LOB fields are created on the table of the group. This preference can have the following values:
  • "Immediate" — Allocate immediately using default areas. Allocates all partitions according to the defaults when the tenant group is created.
  • "Delayed" — Delay the physical allocation of the partitions. Sets the partitions' AllocateState properties to "Delayed", which allows them to be allocated by executing the Allocate( ) method on the ITenantGroup object.
  • "None" — No automatic allocation. Sets the partitions' AllocateState properties to "None", which means that the allocation can only be done on each individual partition by executing the Allocate( ) method on the IPartition object.
DefaultDataArea IArea Readable, Writeable Set to the default data area for new tenant group partitions.
DefaultIndexArea IArea Readable, Writeable Set to the default index area for new tenant group partitions.
DefaultLobArea IArea Readable, Writeable Set to the default LOB area for new tenant group partitions.
Description CHARACTER Readable, Writeable Set to a tenant group description of your choice.
Id INTEGER Read-only Returns the unique, internal tenant group identifier that is generated by the database.
Note: Dump and load generates a new value.
IsAllocated LOGICAL Read-only Returns TRUE if all tenant group partitions have a state of "Allocated" or "None".

Returns FALSE if any partition has a state of "Delayed".

Note: Use the Allocate( ) method to allocate delayed partitions.
Name CHARACTER Readable, Writeable Set to a unique tenant group name, with a maximum length 32 characters.
Partitions IPartitionMap Read-only Returns a collection of all partitions of the tenant group mapped by ISchemaElement (ITable, IIndex, and IField).
Table ITable Read-only Set to the table of the group.
Tenants ITenantSet Read-only Returns a collection all tenants (ITenant) that are members of the group.