Returns the tenant ID of the effective tenant as an integer.

Syntax

GET-EFFECTIVE-TENANT-ID( [database-name] )
database-name
A character expression that evaluates to a logical database name or database alias. If no database is specified and more than one database is connected, the AVM raises an error. If the database name is not a valid name for a connected database, the AVM raises an error.

Notes

  • If a super tenant executes this function and they have already executed the SET-EFFECTIVE-TENANT function, this function returns the tenant ID of any effective tenant that is in scope. If they have not executed the SET-EFFECTIVE-TENANT function or there is no effective tenant in scope, this function returns the default tenant ID (0).
  • If a regular-tenant user executes this function, it returns the tenant ID associated with the user's tenancy.

See also

GET-EFFECTIVE-TENANT-NAME function, SET-EFFECTIVE-TENANT function, TENANT-ID function