DB-LIST attribute

A comma-separated list of logical database names that is stored in the client-principal object for all OpenEdge multi-tenant databases for which a connection identity has been set in one or more ABL sessions using this object. A given logical database name is stored in the client-principal object whenever a user authentication or single-sign-on operation using this object sets the multi-tenant database connection identity. You can use a database name from this list as input to the TENANT-ID( ) and TENANT-NAME( ) methods in order to retrieve the corresponding tenant name and tenant ID that has been stored along with it.

Note:

The list returned by this function omits the names of all non-multi-tenant databases for which the connection identity has been set using this client-principal object.

Data type:

CHARACTER

Access:

Read-only

Applies to:

Client-principal object handle

This attribute returns the:

Unknown value (?) — If the client-principal object is not sealed

Blank ("") value — If the client-principal object is sealed but has not yet been used to set identity for any OpenEdge database connections

Tenant information is stored in the client-principal for each database connection whose identity is established by a user authentication or single sign-on (SSO) operation using this object (see the CONNECT statement, SET-DB-CLIENT function, SET-CLIENT( ) method, and SETUSERID function entries). Once stored in the client-principal, the tenant information for a given database never changes, regardless of how many ABL sessions use the object to set connection identity and regardless of the status of database connections in the current ABL session. Therefore, the existing tenant information is carried with the object as it is used to set additional database connection identities and as it is exported (using the EXPORT-PRINCIPAL( ) method) from one ABL session to another. This information can be removed only if the client-principal object is deleted or is re-initialized (using the INITIALIZE( ) method).

ABL raises ERROR if you attempt to assign a value to this attribute.