The IN_DB_UTIL_SP_SESSION_SET_ATTRIBUTES stored procedure is used to set the session attributes (parameters) of the IN_DB_UTIL framework during session initialization for the specified identifier(s).
It is called by the IN_DB_UTIL_SP_SESSION_SETUP procedure when initializing a session within the IN_DB_UTIL framework.
The IN_DB_UTIL_SP_SESSION_SET_ATTRIBUTES procedure should never need to be manually executed.
The IN_DB_UTIL_SP_SESSION_SET_ATTRIBUTES procedure is responsible for updating the IN_DB_UTIL_SESSION_ATTRIBUTES table for the specified identifier(s).
The MAX_TIMESTAMP property is set by this procedure if not already defined by a previous procedure in the current call stack for the session. The MAX_TIMESTAMP parameter is derived from the MAX_MINUTES session parameter if provided during session initialization.
The IN_DB_UTIL_SP_SESSION_SET_ATTRIBUTES stored procedure will set the following session attributes:
STATUS, CALLER, CALLER_HIST, START_TIME, MAX_TIME, OBJECT, SUBOBJECT, FILEGROUP, MAX_MINUTES, MAX_DOP, FILL_FACTOR, BATCH_SIZE, SCHEMA_TARGET, SCHEMA_VERSION, SCHEMA_BASE, SCHEMA_TYPE, DATATYPE, DATABASE_EDITION, IS_SYNC_UPGRADE, SPID, DEBUG.
| Parameter | Description | |
|---|---|---|
| SESSION_PARAMETERS | Type: | INPUT |
| Datatype: | IN_DB_UTIL_TY_SESSION_ATTR | |
| Default Value: | NULL | |
| Description | User-defined table type variable used to pass the values of all the
supported attributes for the IN_DB_UTIL framework. See the IN_DB_UTIL_TY_SESSION_ATTR definition above for more details. |
|
| V_RETURN_VAL | Type: | RETURN |
| Datatype: | INTEGER | |
| Default Value: | 0 | |
| Description | Specifies whether the execution of the procedure was successful or
not. 0 = SUCCESS 1 = ERROR |
|
Examples
The following example shows the @V_SESSION_PARAMETERS table variable, containing all the session attributes (parameters), being passed into IN_DB_UTIL_SP_SESSION_SET_ATTRIBUTES procedure to update the session attributes in the IN_DB_UTIL_SESSION_ATTRIBUTES table.
The V_RETURN_VAL parameter is being recorded into the V_CALL_RETURN variable and if a value of one is returned, signifying an error, then the procedure will exit with an error.
EXEC @V_CALL_RETURN = IN_DB_UTIL_SP_SESSION_SET_ATTRIBUTES @V_SESSION_PARAMETERS; IF @V_CALL_RETURN = 1 GOTO ERROR_EXIT;