sqlfupd data structure

This structure passes information about database configuration files and the database manager configuration file.

Table 1. Fields in the SQLFUPD Structure
Field Name Data Type Description
TOKEN UINT16 Specifies the configuration value to return or update.
PTRVALUE Pointer A pointer to an application allocated buffer that holds the data specified by TOKEN.
Valid data types for the token element are:
Uint16
Unsigned 2-byte integer
Sint16
Signed 2-byte integer
Uint32
Unsigned 4-byte integer
Sint32
Signed 4-byte integer
Uint64
Unsigned 8-byte integer
float
4-byte floating-point decimal
char(n)
String of length n (not including null termination).
Valid entries for the SQLFUPD token element are listed in the following table:
Table 2. Updatable Database Configuration Parameters
Parameter Name Token Token Value Data Type
alt_collate SQLF_DBTN_ALT_COLLATE 809 Uint32
app_ctl_heap_sz SQLF_DBTN_APP_CTL_HEAP_SZ 500 Uint16
appgroup_mem_sz SQLF_DBTN_APPGROUP_MEM_SZ 800 Uint32
applheapsz SQLF_DBTN_APPLHEAPSZ 51 Uint16
archretrydelay SQLF_DBTN_ARCHRETRYDELAY 828 Uint16
  • auto_maint
  • auto_db_backup
  • auto_tbl_maint
  • auto_runstats
  • auto_reorg
  • SQLF_DBTN_AUTO_MAINT
  • SQLF_DBTN_AUTO_DB_BACKUP
  • SQLF_DBTN_AUTO_TBL_MAINT
  • SQLF_DBTN_AUTO_RUNSTATS
  • SQLF_DBTN_AUTO_REORG
  • 831
  • 833
  • 835
  • 837
  • 841
Uint16
autorestart SQLF_DBTN_AUTO_RESTART 25 Uint16
avg_appls SQLF_DBTN_AVG_APPLS 47 Uint16
blk_log_dsk_ful SQLF_DBTN_BLK_LOG_DSK_FUL 804 Uint16
catalogcache_sz SQLF_DBTN_CATALOGCACHE_SZ 56 Sint32
chngpgs_thresh SQLF_DBTN_CHNGPGS_THRESH 38 Uint16
database_memory SQLF_DBTN_DATABASE_MEMORY 803 Uint64
dbheap SQLF_DBTN_DB_HEAP 58 Uint64
db_mem_thresh SQLF_DBTN_DB_MEM_THRESH 849 Uint16
dft_degree SQLF_DBTN_DFT_DEGREE 301 Sint32
dft_extent_sz SQLF_DBTN_DFT_EXTENT_SZ 54 Uint32
dft_loadrec_ses SQLF_DBTN_DFT_LOADREC_SES 42 Sint16
dft_mttb_types SQLF_DBTN_DFT_MTTB_TYPES 843 Uint32
dft_prefetch_sz SQLF_DBTN_DFT_PREFETCH_SZ 40 Sint16
dft_queryopt SQLF_DBTN_DFT_QUERYOPT 57 Sint32
dft_refresh_age SQLF_DBTN_DFT_REFRESH_AGE 702 char(22)
dft_sqlmathwarn SQLF_DBTN_DFT_SQLMATHWARN 309 Sint16
dlchktime SQLF_DBTN_DLCHKTIME 9 Uint32
failarchpath SQLF_DBTN_FAILARCHPATH 826 char(243)
groupheap_ratio SQLF_DBTN_GROUPHEAP_RATIO 801 Uint16
hadr_local_host SQLF_DBTN_HADR_LOCAL_HOST 811 char(256)
hadr_local_svc SQLF_DBTN_HADR_LOCAL_SVC 812 char(41)
hadr_remote_host SQLF_DBTN_HADR_REMOTE_HOST 813 char(256)
hadr_remote_inst SQLF_DBTN_HADR_REMOTE_INST 815 char(9)
hadr_remote_svc SQLF_DBTN_HADR_REMOTE_SVC 814 char(41)
hadr_syncmode SQLF_DBTN_HADR_SYNCMODE 817 Uint32
hadr_timeout SQLF_DBTN_HADR_TIMEOUT 816 Sint32
indexrec SQLF_DBTN_INDEXREC 30 Uint16
locklist SQLF_DBTN_LOCK_LIST 704 Uint64
locktimeout SQLF_DBTN_LOCKTIMEOUT 34 Sint16
logarchmeth1 SQLF_DBTN_LOGARCHMETH1 822 Uint16
logarchmeth2 SQLF_DBTN_LOGARCHMETH2 823 Uint16
logarchopt1 SQLF_DBTN_LOGARCHOPT1 824 char(243)
logarchopt2 SQLF_DBTN_LOGARCHOPT2 825 char(243)
logbufsz SQLF_DBTN_LOGBUFSZ 33 Uint16
logfilsiz SQLF_DBTN_LOGFIL_SIZ 92 Uint32
logindexbuild SQLF_DBTN_LOGINDEXBUILD 818 Uint32
logprimary SQLF_DBTN_LOGPRIMARY 16 Uint16
logsecond SQLF_DBTN_LOGSECOND 17 Uint16
max_log SQLF_DBTN_MAX_LOG 807 Uint16
maxappls SQLF_DBTN_MAXAPPLS 6 Uint16
maxfilop SQLF_DBTN_MAXFILOP 3 Uint16
maxlocks SQLF_DBTN_MAXLOCKS 15 Uint16
max_log SQLF_DBTN_MAX_LOG 807 Uint16
mirrorlogpath SQLF_DBTN_MIRRORLOGPATH 806 char(242)
newlogpath SQLF_DBTN_NEWLOGPATH 20 char(242)
num_db_backups SQLF_DBTN_NUM_DB_BACKUPS 601 Uint16
num_freqvalues SQLF_DBTN_NUM_FREQVALUES 36 Uint16
num_iocleaners SQLF_DBTN_NUM_IOCLEANERS 37 Uint16
num_ioservers SQLF_DBTN_NUM_IOSERVERS 39 Uint16
num_log_span SQLF_DBTN_NUM_LOG_SPAN 808 Uint16
num_quantiles SQLF_DBTN_NUM_QUANTILES 48 Uint16
numarchretry SQLF_DBTN_NUMARCHRETRY 827 Uint16
overflowlogpath SQLF_DBTN_OVERFLOWLOGPATH 805 char(242)
pckcachesz SQLF_DBTN_PCKCACHE_SZ 505 Uint32
rec_his_retentn SQLF_DBTN_REC_HIS_RETENTN 43 Sint16
self_tuning_mem SQLF_DBTN_SELF_TUNING_MEM 848 Uint16
seqdetect SQLF_DBTN_SEQDETECT 41 Uint16
sheapthres_shr SQLF_DBTN_SHEAPTHRES_SHR 802 Uint32
softmax1 SQLF_DBTN_SOFTMAX 5 Uint16
sortheap SQLF_DBTN_SORT_HEAP 52 Uint32
stat_heap_sz SQLF_DBTN_STAT_HEAP_SZ 45 Uint32
stmtheap SQLF_DBTN_STMTHEAP 53 Uint16
trackmod SQLF_DBTN_TRACKMOD 703 Uint16
tsm_mgmtclass SQLF_DBTN_TSM_MGMTCLASS 307 char(30)
tsm_nodename SQLF_DBTN_TSM_NODENAME 306 char(64)
tsm_owner SQLF_DBTN_TSM_OWNER 305 char(64)
tsm_password SQLF_DBTN_TSM_PASSWORD 501 char(64)
util_heap_sz SQLF_DBTN_UTIL_HEAP_SZ 55 Uint32
vendoropt SQLF_DBTN_VENDOROPT 829 char(242)
  1. Important: The softmax database configuration parameter is deprecated and might be removed in a future release. For more information, see Some database configuration parameters are deprecated.
The bits of SQLF_DBTN_AUTONOMIC_SWITCHES indicate the default settings for a number of auto-maintenance configuration parameters. The individual bits making up this composite parameter are: 
Default => Bit 1 on  (xxxx xxxx xxxx xxx1): auto_maint
           Bit 2 off (xxxx xxxx xxxx xx0x): auto_db_backup
           Bit 3 on  (xxxx xxxx xxxx x1xx): auto_tbl_maint
           Bit 4 on  (xxxx xxxx xxxx 1xxx): auto_runstats
           Bit 5 off (xxxx xxxx xxx0 xxxx): auto_stats_prof
           Bit 6 off (xxxx xxxx xx0x xxxx): auto_prof_upd
           Bit 7 off (xxxx xxxx x0xx xxxx): auto_reorg
           Bit 8 off (xxxx xxxx 0xxx xxxx): auto_storage
           Bit 9 off (xxxx xxx0 xxxx xxxx): auto_stmt_stats
                        0    0    0    D
 
Maximum => Bit 1 on  (xxxx xxxx xxxx xxx1): auto_maint
           Bit 2 off (xxxx xxxx xxxx xx1x): auto_db_backup
           Bit 3 on  (xxxx xxxx xxxx x1xx): auto_tbl_maint
           Bit 4 on  (xxxx xxxx xxxx 1xxx): auto_runstats
           Bit 5 off (xxxx xxxx xxx1 xxxx): auto_stats_prof
           Bit 6 off (xxxx xxxx xx1x xxxx): auto_prof_upd
           Bit 7 off (xxxx xxxx x1xx xxxx): auto_reorg
           Bit 8 off (xxxx xxxx 1xxx xxxx): auto_storage
           Bit 9 off (xxxx xxx1 xxxx xxxx): auto_stmt_stats
                        0    1    F    F
Note: The auto_stats_prof and auto_prof_upd parameters are discontinued in version 10.5.
Valid values for indexrec (defined in sqlutil.h):
  • SQLF_INX_REC_SYSTEM (0)
  • SQLF_INX_REC_REFERENCE (1)
  • SQLF_INX_REC_RESTART (2)
Table 3. Non-updatable Database Configuration Parameters
Parameter Name Token Token Value Data Type
backup_pending SQLF_DBTN_BACKUP_PENDING 112 Uint16
codepage SQLF_DBTN_CODEPAGE 101 Uint16
codeset SQLF_DBTN_CODESET 120 char(9) (see following note 1)
collate_info SQLF_DBTN_COLLATE_INFO 44 char(260)
country/region SQLF_DBTN_COUNTRY 100 Uint16
database_consistent SQLF_DBTN_CONSISTENT 111 Uint16
database_level SQLF_DBTN_DATABASE_LEVEL 124 Uint16
log_retain_status SQLF_DBTN_LOG_RETAIN_STATUS 114 Uint16
loghead SQLF_DBTN_LOGHEAD 105 char(12)
logpath SQLF_DBTN_LOGPATH 103 char(242)
multipage_alloc SQLF_DBTN_MULTIPAGE_ALLOC 506 Uint16
numsegs SQLF_DBTN_NUMSEGS 122 Uint16
release SQLF_DBTN_RELEASE 102 Uint16
restore_pending SQLF_DBTN_RESTORE_PENDING 503 Uint16
rollfwd_pending SQLF_DBTN_ROLLFWD_PENDING 113 Uint16
territory SQLF_DBTN_TERRITORY 121 char(5) (see following note 2)
user_exit_status SQLF_DBTN_USER_EXIT_STATUS 115 Uint16
Note:
  1. char(17) on Linux® operating systems.
  2. char(33) on Linux operating systems.
Valid entries for the SQLFUPD token element are listed in the following table:
Table 4. Updatable Database Manager Configuration Parameters
Parameter Name Token Token Value Data Type
agent_stack_sz SQLF_KTN_AGENT_STACK_SZ 61 Uint16
agentpri SQLF_KTN_AGENTPRI 26 Sint16
alternate_auth_enc SQLF_KTN_ALTERNATE_AUTH_ENC 938 Uint16
aslheapsz SQLF_KTN_ASLHEAPSZ 15 Uint32
audit_buf_sz SQLF_KTN_AUDIT_BUF_SZ 312 Sint32
authentication SQLF_KTN_AUTHENTICATION 78 Uint16
catalog_noauth SQLF_KTN_CATALOG_NOAUTH 314 Uint16
clnt_krb_plugin SQLF_KTN_CLNT_KRB_PLUGIN 812 char(33)
clnt_pw_plugin SQLF_KTN_CLNT_PW_PLUGIN 811 char(33)
comm_bandwidth SQLF_KTN_COMM_BANDWIDTH 307 float
conn_elapse SQLF_KTN_CONN_ELAPSE 508 Uint16
cpuspeed SQLF_KTN_CPUSPEED 42 float
dft_account_str SQLF_KTN_DFT_ACCOUNT_STR 28 char(25)
dft_monswitches SQLF_KTN_DFT_MONSWITCHES 29 Uint16
dft_mon_bufpool SQLF_KTN_DFT_MON_BUFPOOL 33 Uint16
dft_mon_lock SQLF_KTN_DFT_MON_LOCK 34 Uint16
dft_mon_sort SQLF_KTN_DFT_MON_SORT 35 Uint16
dft_mon_stmt SQLF_KTN_DFT_MON_STMT 31 Uint16
dft_mon_table SQLF_KTN_DFT_MON_TABLE 32 Uint16
dft_mon_timestamp SQLF_KTN_DFT_MON_ TIMESTAMP 36 Uint16
dft_mon_uow SQLF_KTN_DFT_MON_UOW 30 Uint16
dftdbpath SQLF_KTN_DFTDBPATH 27 char(215)
diaglevel SQLF_KTN_DIAGLEVEL 64 Uint16
diagpath SQLF_KTN_DIAGPATH 65 char(215)
dir_cache SQLF_KTN_DIR_CACHE 40 Uint16
fcm_num_buffers SQLF_KTN_FCM_NUM_BUFFERS 503 Uint32
fcm_num_channels SQLF_KTN_FCM_NUM_CHANNELS 902 Uint32
fed_noauth SQLF_KTN_FED_NOAUTH 806 Uint16
federated SQLF_KTN_FEDERATED 604 Sint16
federated_async SQLF_KTN_FEDERATED_ASYNC 849 Sint32
fenced_pool SQLF_KTN_FENCED_POOL 80 Sint32
group_plugin SQLF_KTN_GROUP_PLUGIN 810 char(33)
health_mon SQLF_KTN_HEALTH_MON 804 Uint16
indexrec SQLF_KTN_INDEXREC 20 Uint16
instance_memory SQLF_KTN_INSTANCE_MEMORY 803 Uint64
intra_parallel SQLF_KTN_INTRA_PARALLEL 306 Sint16
java_heap_sz SQLF_KTN_JAVA_HEAP_SZ 310 Sint32
jdk_path SQLF_KTN_JDK_PATH 311 char(255)
keepfenced SQLF_KTN_KEEPFENCED 81 Uint16
local_gssplugin SQLF_KTN_LOCAL_GSSPLUGIN 816 char(33)
max_connections SQLF_DBTN_MAX_CONNECTIONS 802 Sint32
max_connretries SQLF_KTN_MAX_CONNRETRIES 509 Uint16
max_coordagents SQLF_KTN_MAX_COORDAGENTS 501 Sint32
max_querydegree SQLF_KTN_MAX_QUERYDEGREE 303 Sint32
max_time_diff SQLF_KTN_MAX_TIME_DIFF 510 Uint16
mon_heap_sz SQLF_KTN_MON_HEAP_SZ 79 Uint16
notifylevel SQLF_KTN_NOTIFYLEVEL 605 Sint16
num_initagents SQLF_KTN_NUM_INITAGENTS 500 Uint32
num_initfenced SQLF_KTN_NUM_INITFENCED 601 Sint32
num_poolagents SQLF_KTN_NUM_POOLAGENTS 502 Sint32
numdb SQLF_KTN_NUMDB 6 Uint16
query_heap_sz SQLF_KTN_QUERY_HEAP_SZ 49 Sint32
resync_interval SQLF_KTN_RESYNC_INTERVAL 68 Uint16
rqrioblk SQLF_KTN_RQRIOBLK 1 Uint16
sheapthres SQLF_KTN_SHEAPTHRES 21 Uint32
spm_log_file_sz SQLF_KTN_SPM_LOG_FILE_SZ 90 Sint32
spm_log_path SQLF_KTN_SPM_LOG_PATH 313 char(226)
spm_max_resync SQLF_KTN_SPM_MAX_RESYNC 91 Sint32
spm_name SQLF_KTN_SPM_NAME 92 char(8)
srvcon_auth SQLF_KTN_SRVCON_AUTH 815 Uint16
srvcon_gssplugin_list SQLF_KTN_SRVCON_GSSPLUGIN_ LIST 814 char(256)
srv_plugin_mode SQLF_KTN_SRV_PLUGIN_MODE 809 Uint16
srvcon_pw_plugin SQLF_KTN_SRVCON_PW_PLUGIN 813 char(33)
ssl_cipherspecs SQLF_KTN_SSL_CIPHERSPECS 934 char(255)
ssl_clnt_keydb SQLF_KTN_SSL_CLNT_KEYDB 936 char(1023)
ssl_clnt_stash SQLF_KTN_SSL_CLNT_STASH 937 char(1023)
ssl_svcename SQLF_KTN_SSL_SVCENAME 933 char(14)
ssl_svr_keydb SQLF_KTN_SSL_SVR_KEYDB 930 char(1023)
ssl_svr_label SQLF_KTN_SSL_SVR_LABEL 932 char(1023)
ssl_svr_stash SQLF_KTN_SSL_SVR_STASH 931 char(1023)
ssl_versions SQLF_KTN_SSL_VERSIONS 935 char(255)
start_stop_time SQLF_KTN_START_STOP_TIME 511 Uint16
svcename SQLF_KTN_SVCENAME 24 char(14)
sysadm_group SQLF_KTN_SYSADM_GROUP 39 char(16)
sysctrl_group SQLF_KTN_SYSCTRL_GROUP 63 char(16)
sysmaint_group SQLF_KTN_SYSMAINT_GROUP 62 char(16)
sysmon_group SQLF_KTN_SYSMON_GROUP 808 char(30)
tm_database SQLF_KTN_TM_DATABASE 67 char(8)
tp_mon_name SQLF_KTN_TP_MON_NAME 66 char(19)
trust_allclnts SQLF_KTN_TRUST_ALLCLNTS 301 Uint16
trust_clntauth SQLF_KTN_TRUST_CLNTAUTH 302 Uint16
util_impact_lim SQLF_KTN_UTIL_IMPACT_LIM 807 Uint32
Note: The configuration parameters maxagents and maxcagents are deprecated. In a future release, these configuration parameters may be removed completely.
Valid values for alternate_auth_enc (defined in sqlenv.h):
  • SQL_ALTERNATE_AUTH_ENC_AES (0)
  • SQL_ALTERNATE_AUTH_ENC_AES_CMP (1)
  • SQL_ALTERNATE_AUTH_ENC_NOTSPEC (255)
Valid values for authentication (defined in sqlenv.h):
  • SQL_AUTHENTICATION_SERVER (0)
  • SQL_AUTHENTICATION_CLIENT (1)
  • SQL_AUTHENTICATION_DCS (2)
  • SQL_AUTHENTICATION_DCE (3)
  • SQL_AUTHENTICATION_SVR_ENCRYPT (4)
  • SQL_AUTHENTICATION_DCS_ENCRYPT (5)
  • SQL_AUTHENTICATION_DCE_SVR_ENC (6)
  • SQL_AUTHENTICATION_KERBEROS (7)
  • SQL_AUTHENTICATION_KRB_SVR_ENC (8)
  • SQL_AUTHENTICATION_GSSPLUGIN (9)
  • SQL_AUTHENTICATION_GSS_SVR_ENC (10)
  • SQL_AUTHENTICATION_DATAENC (11)
  • SQL_AUTHENTICATION_DATAENC_CMP (12)
  • SQL_AUTHENTICATION_NOT_SPEC (255)
SQLF_KTN_DFT_MONSWITCHES is a Uint16 parameter, the bits of which indicate the default monitor switch settings. This allows for the specification of a number of parameters at once. The individual bits making up this composite parameter are:
  • Bit 1 (xxxx xxx1): dft_mon_uow
  • Bit 2 (xxxx xx1x): dft_mon_stmt
  • Bit 3 (xxxx x1xx): dft_mon_table
  • Bit 4 (xxxx 1xxx): dft_mon_buffpool
  • Bit 5 (xxx1 xxxx): dft_mon_lock
  • Bit 6 (xx1x xxxx): dft_mon_sort
  • Bit 7 (x1xx xxxx): dft_mon_timestamp
Valid values for indexrec (defined in sqlutil.h):
  • SQLF_INX_REC_SYSTEM (0)
  • SQLF_INX_REC_REFERENCE (1)
  • SQLF_INX_REC_RESTART (2)
Valid values for trust_allclnts (defined in sqlutil.h):
  • SQLF_TRUST_ALLCLNTS_NO (0)
  • SQLF_TRUST_ALLCLNTS_YES (1)
  • SQLF_TRUST_ALLCLNTS_DRDAONLY (2)
Table 5. Non-updatable Database Manager Configuration Parameters
Parameter Name Token Token Value Data Type
nodetype SQLF_KTN_NODETYPE 100 Uint16
release SQLF_KTN_RELEASE 101 Uint16
Valid values for nodetype (defined in sqlutil.h):
  • SQLF_NT_STANDALONE (0)
  • SQLF_NT_SERVER (1)
  • SQLF_NT_REQUESTOR (2)
  • SQLF_NT_STAND_REQ (3)
  • SQLF_NT_MPP (4)
  • SQLF_NT_SATELLITE (5)

API and data structure syntax

SQL_STRUCTURE sqlfupd
{
   unsigned short  token;
   char *ptrvalue;
};

COBOL Structure


* File: sqlutil.cbl
01 SQL-FUPD.
    05 SQL-TOKEN              PIC 9(4) COMP-5.
    05 FILLER                 PIC X(2).
    05 SQL-VALUE-PTR          USAGE IS POINTER.
*