Try OpenEdge Now
skip to main content
Programming Interfaces
Database Administration Entity Interface Reference : ITenant interface : ITenant properties
 

ITenant properties

Inherits properties from IDataAdminElement and defines the properties listed in the following table.
Table 113. Multi-tenant Maintenance ITenant 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 is created, when tables are multi-tenant enabled, or new multi-tenant tables, indexes, or LOB fields are created. This preference can have the following values:
*"Immediate" — Allocate immediately using default areas. Allocates all partitions according to the defaults when the tenant 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 ITenant 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.
Note: If you intend to make a tenant a member of a tenant group, set this property to "Delayed" so no storage is allocated to the tenant before you have allocated storage to the group.
DefaultDataArea
IArea
Readable, Writeable
Set to the default data area for new tenant partitions.
DefaultIndexArea
IArea
Readable, Writeable
Set to the default index area for new tenant partitions.
DefaultLobArea
IArea
Readable, Writeable
Set to the default LOB area for new tenant partitions.
Description
CHARACTER
Readable, Writeable
Set to a tenant description of your choice.
Domains
IDomainSet
Read-only
Returns a collection of all domains (IDomain) configured for the tenant.
ExternalId
CHARACTER
Readable, Writeable
Set to an external tenant identifier of your choice, with no requirement for a GUID.
Id
INTEGER
Read-only
Returns the unique, internal tenant identifier that is generated by the database.
Note: Dump and load generates a new value.
IsAllocated
LOGICAL
Read-only
Returns TRUE if all tenant partitions have a state of "Allocated" or "None".Returns FALSE if any tenant partition has a state of "Delayed".
Note: Use the Allocate( ) method on ITenant to allocate delayed partitions for a tenant.
IsDataEnabled
LOGICAL
Readable, Writeable
Set to TRUE (the default) allows access to tenant data.Set to FALSE in order to prevent access to tenant data. This setting leaves only shared data accessible to the tenant.
Name
CHARACTER
Readable, Writeable
Set to a unique tenant name, with a maximum length 32 characters.
Partitions
IPartitionMap
Read-only
Returns a collection of all partitions of the tenant mapped by ISchemaElement (ITable, IIndex, and IField).
SequenceValues
ISequenceValueMap
Read-only
Returns a collection of multi-tenant sequence values, consisting of ISequenceValue elements mapped by ISequence elements for the tenant.
TenantGroups
ITenantGroupSet
Read-only
Returns a collection all tenant groups (ITenantGroup) to which the tenant belongs.
Type
CHARACTER
Readable, Writeable
Set to the tenant type, which can have the following valid values: "Regular" (for a regular tenant) and "Super" (for a super tenant).
Users
IUserSet
Read-only
Returns a collection of all OpenEdge users (IUser) defined for the tenant.
Note: You can also access OpenEdge tenant users through the IDomain objects returned by the Domains property.