List of connection properties

Connection properties are available for each connection to an SAP Sybase IQ database. Connection property names are case insensitive.

Connection properties

Property name Description
allow_nulls_by_default

Returns a value indicating whether columns created without specifying either NULL or NOT NULL are allowed to contain NULL values.

allow_read_client_file

Returns a value indicating whether the database server allows the reading of files on a client computer.

allow_snapshot_isolation

Returns a value indicating whether snapshot isolation is enabled or disabled.

allow_write_client_file

Returns a value indicating whether the database server allows the writing of files to a client computer.

ansi_blanks

Returns a value indicating when character data is truncated at the client side.

ansi_close_cursors_on_rollback

Returns a value indicating whether cursors opened WITH HOLD are closed when a ROLLBACK is performed.

ansi_permissions

Returns a value indicating whether privileges are checked for DELETE and UPDATE statements.

ansi_substring

Returns a value indicating how the SUBSTRING (SUBSTR) function behaves when negative values are provided for the start or length parameters.

ansi_update_constraints

Returns a value indicating the range of updates that are permitted.

ansinull

Returns a value that indicates how NULL values are interpreted.

AppInfo

Returns information about the client that made the connection. For HTTP connections, this includes information about the browser. For connections using older versions of jConnect or Sybase Open Client, the information may be incomplete.

The API value can be DBLIB, ODBC, OLEDB, ADO.NET, iAnywhereJDBC, PHP, PerlDBD, or DBEXPRESS.

ApproximateCPUTime

Returns an estimate of the amount of CPU time accumulated by a given connection, in seconds. The value returned may differ from the actual value by as much as 50%, although typical variations are in the 5-10% range. On multi-processor computers, each CPU (or hyperthread or core) accumulates time, so the sum of accumulated times for all connections may be greater than the elapsed time. This property is supported on Windows and Linux.

auditing

Returns On if the PUBLIC.auditing option is set to On. Otherwise, returns Off.

If the auditing option is set to On, and the conn_auditing option is set to Off, the auditing connection property still returns On, even though the current connection is not being audited.

auditing_options

This property is reserved for system use. Do not change the setting of this option.

Authenticated

Returns Yes if the application has sent a valid connection authentication string. Returns No if the application has not sent a valid connection authentication string.

AuthType

Returns the type of authentication used when connecting. The value returned is one of Standard, Integrated, Kerberos, LDAPUA, or an empty string. An empty string is returned for internal connections and connections for HTTP services that use AUTHORIZATION OFF.

auto_commit_on_create_local_temp_index

Returns the setting of the auto_commit_on_create_local_temp_index option.

background_priority

This property is deprecated. Returns a value indicating how much impact the current connection has on the performance of other connections.

BlockedOn

Returns zero if the current connection isn't blocked, or if it is blocked, the connection number on which the connection is blocked because of a locking conflict.

blocking

Returns a value indicating the database server's behavior in response to locking conflicts.

blocking_others_timeout

Returns the length of time that another connection can block on the current connection's row and table locks before the current connection is rolled back.

blocking_timeout

Returns the length of time, in milliseconds, a transaction waits to obtain a lock.

BytesReceived

Returns the number of bytes received during client/server communications. This value is updated for HTTP and HTTPS connections.

BytesReceivedUncomp

Returns the number of bytes that would have been received during client/server communications if compression was disabled. This value is the same as the value for BytesReceived if compression is disabled.

BytesSent

Returns the number of bytes sent during client/server communications. This value is updated for HTTP and HTTPS connections.

BytesSentUncomp

Returns the number of bytes that would have been sent during client/server communications if compression was disabled. This value is the same as the value for BytesSent if compression is disabled.

CacheHits

Returns the number of successful reads of the cache.

CacheRead

Returns the number of database pages that have been looked up in the cache.

CacheReadIndInt

Returns the number of index internal-node pages that have been read from the cache.

CacheReadIndLeaf

Returns the number of index leaf pages that have been read from the cache.

CacheReadTable

Returns the number of table pages that have been read from the cache.

CacheReadWorkTable

Returns the number of cache work table reads.

CarverHeapPages

Returns the number of heap pages used for short-term purposes such as query optimization.

chained

Returns the transaction mode used in the absence of a BEGIN TRANSACTION statement.

CharSet

Returns the CHAR character set used by the connection. This property has extensions that you can specify when querying the property value.

checkpoint_time

Returns the maximum time, in minutes, that the database server runs without doing a checkpoint.

cis_option

Returns 7 if debugging information for remote data access appears in the database server messages window and 0 if the debugging information for remote data access does not appear in the database server messages window.

cis_rowset_size

Returns the number of rows that are returned from remote servers for each fetch.

ClientLibrary

Returns jConnect for jConnect connections; CT_Library for Sybase Open Client connections; None for HTTP connections, and CmdSeq for ODBC, embedded SQL, OLE DB, ADO.NET, and SAP Sybase IQ JDBC driver connections.

ClientNodeAddress

Returns the node for the client in a client/server connection. When the client and server are both on the same computer, an empty string is returned. This is a synonym for the NodeAddress property.

This property returns NA if the request that is currently executing is part of an event handler.

ClientPort

Returns the client's TCP/IP port number or 0 if the connection isn't a TCP/IP connection.

ClientStmtCacheHits

Returns the number of prepares that were not required for this connection because of the client statement cache. This is the number of additional prepares that would be required if client statement caching was disabled.

ClientStmtCacheMisses

Returns the number of statements in the client statement cache for this connection that were prepared again. This is the number of times a cached statement was considered for reuse, but could not be reused because of a schema change, a database option setting, or a DROP VARIABLE statement.

close_on_endtrans

Returns On or Off to indicate whether cursors are closed at the end of a transaction.

collect_statistics_on_dml_updates

Returns On or Off to indicate whether statistics are gathered during the execution of data-altering DML statements such as INSERT, DELETE, and UPDATE.

Commit

Returns the number of Commit requests that have been handled.

CommLink

Returns the communication link for the connection. This is one of the network protocols supported by SAP Sybase IQ, or local for a same-computer connection.

This property returns NA if the request that is currently executing is part of an event handler.

CommNetworkLink

Returns the communication link for the connection. This is one of the network protocols supported by SAP Sybase IQ. Values include SharedMemory and TCPIP. The CommNetworkLink property always returns the name of the link, regardless of whether it is same-computer or not.

This property returns NA if the request that is currently executing is part of an event handler.

CommProtocol

Returns TDS for Sybase Open Client and jConnect connections, HTTP for HTTP connections, HTTPS for HTTPS connections, and CmdSeq for ODBC, embedded SQL, OLE DB, ADO.NET, and SAP Sybase IQ JDBC driver connections.

Compression

Returns On or Off to indicate whether communication compression is enabled on the connection.

This property returns NA if the request that is currently executing is part of an event handler.

conn_auditing

Returns On if auditing is enabled for the connection, even if the auditing option is set to Off.

ConnectedTime

Returns the total length of time, in seconds, that a connection has been connected.

connection_authentication

Returns the string used to authenticate the client. Authentication is required before the database can be modified.

continue_after_raiserror

Returns On or Off to indicate whether execution of a procedure or trigger is stopped whenever the RAISERROR statement is encountered.

conversion_error

Returns On or Off to indicate data type conversion failures are reported when fetching information from the database.

cooperative_commit_timeout

Returns the time, in milliseconds, that the database server waits for other connections to fill a page of the log before writing to disk.

cooperative_commits

Returns On or Off to indicate when commits are written to disk.

CurrentLineNumber

Returns the current line number of the procedure or compound statement a connection is executing. The procedure can be identified using the CurrentProcedure property. If the line is part of a compound statement from the client, an empty string is returned.

CurrentProcedure

Returns the name of the procedure that a connection is currently executing. If the connection is executing nested procedure calls, the name is the name of the current procedure. If there is no procedure executing, an empty string is returned.

Cursor

Returns the number of declared cursors that are currently being maintained by the database server.

CursorOpen

Returns the number of open cursors that are currently being maintained by the database server.

database_authentication

Returns the string used to authenticate the database. Authentication is required for authenticated database servers before the database can be modified.

date_format

Returns a string indicating the format for dates retrieved from the database.

date_order

Returns a string indicating how dates are formatted.

db_publisher

Returns the user ID of the database publisher.

DBNumber

Returns the ID number of the database.

debug_messages

Returns On or Off to indicate whether MESSAGE statements that include a DEBUG ONLY clause are executed.

dedicated_task

Returns On or Off to indicate whether a request handling task is dedicated exclusively to handling requests for the connection.

default_dbspace

Returns the name of the default dbspace, or an empty string if the default dbspace has not been specified.

default_timestamp_increment

Returns a value, in microseconds, that is added to a column of type TIMESTAMP to keep values in the column unique.

delayed_commit_timeout

Returns the time, in milliseconds, that the database server waits to return control to an application following a COMMIT.

delayed_commits

Returns On or Off to indicate when the database server returns control to an application following a COMMIT.

disk_sandbox

Returns On or Off to indicate whether the read-write file operations of the database are restricted to the directory where the main database file is located.

DiskRead

Returns the number of pages that have been read from disk.

DiskReadHint

Returns the number of disk read hints.

DiskReadHintPages

Returns the number of disk read hint pages.

DiskReadIndInt

Returns the number of index internal-node pages that have been read from disk.

DiskReadIndLeaf

Returns the number of index leaf pages that have been read from disk.

DiskReadTable

Returns the number of table pages that have been read from disk.

DiskReadWorkTable

Returns the number of disk work table reads.

DiskSyncRead

Returns the number of disk reads issued synchronously.

DiskSyncWrite

Returns the number of writes issued synchronously.

DiskWaitRead

Returns the number of times the database server waited for an asynchronous read.

DiskWaitWrite

Returns the number of times the database server waited for an asynchronous write.

DiskWrite

Returns the number of modified pages that have been written to disk.

DiskWriteHint

Returns the number of disk write hints.

DiskWriteHintPages

Returns the number of disk write hint pages.

divide_by_zero_error

Returns On if division by zero results in an error and Off if division by zero is not an error.

Encryption

Returns a value that indicates whether the connection is encrypted.

escape_character

This property is reserved for system use. Do not change the setting of this option.

EventName

Returns the name of the associated event if the connection is running an event handler. Otherwise, an empty string is returned.

exclude_operators

This property is reserved for system use. Do not change the setting of this option.

ExprCacheAbandons

Returns the number of times that the expression cache was abandoned because the hit rate was too low.

ExprCacheDropsToReadOnly

Returns the number of times that the expression cache dropped to read-only status because the hit rate was low.

ExprCacheEvicts

Returns the number of evictions from the expression cache.

ExprCacheHits

Returns the number of hits in the expression cache.

ExprCacheInserts

Returns the number of values inserted into the expression cache.

ExprCacheLookups

Returns the number of lookups done in the expression cache.

ExprCacheResumesOfReadWrite

Returns the number of times that the expression cache resumed read-write status because the hit rate increased.

ExprCacheStarts

Returns the number of times that the expression cache was started.

extended_join_syntax

Returns On if queries with duplicate correlation name syntax for multi-table joins are allowed, Off if they are reported as an error.

extern_login_credentials

Returns whether the remote connections are attempted using the logged in user's external login credentials or the effective user's external login credentials.

fire_triggers

Returns On if triggers are fired in the database, otherwise, returns Off.

first_day_of_week

Returns the number that is used for the first day of the week, where 7=Sunday and 1=Monday.

for_xml_null_treatment

Returns Omit if elements and attributes that contain NULL values are omitted from the result and Empty if empty elements or attributes are generated for NULL values when the FOR XML clause is used in a query.

force_view_creation

This property is reserved for system use. Do not change the setting of this option.

FullCompare

Returns the number of comparisons that have been performed beyond the hash value in an index.

GetData

Returns the number of GETDATA requests.

global_database_id

Returns the starting value used for columns created with DEFAULT GLOBAL AUTOINCREMENT.

HashForcedPartitions

Returns the number of times that a hash operator was forced to partition because of competition for memory.

HashRowsFiltered

Returns the number of probe rows rejected by bit-vector filters.

HashRowsPartitioned

Returns the number of rows written to hash work tables.

HashWorkTables

Returns the number of work tables created for hash-based operations.

HeapsCarver

Returns the number of heaps used for short-term purposes such as query optimization.

HeapsLocked

Returns number of relocatable heaps currently locked in the cache.

HeapsQuery

Returns the number of heaps used for query processing (hash and sort operations).

HeapsRelocatable

Returns the number of relocatable heaps.

http_connection_pool_basesize

Returns the nominal threshold size of database connections.

http_connection_pool_timeout

Returns the maximum length of time that unused connections are stored in the connection pool.

http_session_timeout

Returns the current HTTP session timeout, in minutes.

HttpServiceName

Returns the service name entry point for the current HTTP request. This property is useful for error reporting and control flow. An empty string is returned when this property is selected from a stored procedure that did not originate from an HTTP request or if the connection is currently inactive or waiting to continue an HTTP session.

IdleTimeout

Returns the idle timeout value of the connection.

This property returns NA if the request that is currently executing is part of an event handler.

IndAdd

Returns the number of entries that have been added to indexes.

IndLookup

Returns the number of entries that have been looked up in indexes.

integrated_server_name

Returns the name of the Domain Controller server used for looking up Windows user group membership for integrated logins.

IsDebugger

Returns Yes or No to distinguish connections that are being used to run the SAP Sybase IQ debugger. The value is Yes if the current connection number corresponds to the connection number of a debugger connection, and No otherwise.

isolation_level

Returns the isolation level of the connection (0, 1, 2, 3, Snapshot, Statement-snapshot, or Readonly-statement-snapshot).

java_class_path

Returns a list of additional directories or JAR files that are searched for classes.

java_location

Returns the path of the Java VM for the database if one has been specified.

java_main_userid

This property is deprecated.

java_vm_options

Returns the command line options that the database server uses when it launches the Java VM.

Language

Returns the locale language.

LastCommitRedoPos

Returns the redo log position after the last COMMIT operation was written to the transaction log by the connection.

LastIdle

Returns the number of ticks between requests.

LastPlanText

Returns the long text plan of the last query executed on the connection. You control the remembering of the last plan by setting the RememberLastPlan option of the sa_server_option system procedure, or using the -zp server option.

LastReqTime

Returns the time at which the last request for the specified connection started. This property can return an empty string for internal connections, such as events.

LastStatement

Returns the most recently prepared SQL statement for the current connection.

The LastStatement value is set when a statement is prepared, and is cleared when a statement is dropped. Only one statement string is remembered for each connection.

If sa_conn_activity reports a non-empty value for a connection, it is most likely the statement that the connection is currently executing. If the statement had completed, it would likely have been dropped and the property value would have been cleared. If an application prepares multiple statements and retains their statement handles, then the LastStatement value does not reflect what a connection is currently doing.

When client statement caching is enabled, and a cached statement is reused, this property returns an empty string.

LivenessTimeout

Returns the liveness timeout period for the current connection.

This property returns NA if the request that is currently executing is part of an event handler.

lock_rejected_rows

This property is reserved for system use. Do not change the setting of this option.

LockCount

Returns the number of locks held by the connection.

LockIndexID

Returns the identifier of the locked index.

LockName

Returns a 64-bit unsigned integer value representing the lock for which a connection is waiting.

LockRowID

Returns the identifier of the locked row.

LockTableOID

Returns zero if the connection isn't blocked, or if the connection is on a different database than the connection calling CONNECTION_PROPERTY. Otherwise, this is the object ID of the table for the lock on which this connection is waiting. The object ID can be used to look up table information using the SYSTAB system view.

log_deadlocks

Returns On if deadlock information is reported; otherwise, returns Off.

LogFreeCommit

Returns the number of redo free commits. A redo free commit occurs when a commit of the transaction log is requested but the log has already been written (so the commit was done for free.)

login_mode

Returns one or more of Standard, Integrated, Kerberos, or LDAPUA to indicate the type of logins that are supported.

login_procedure

Returns the name of the stored procedure used to set compatibility options at startup.

LoginTime

Returns the date and time the connection was established.

LogWrite

Returns the number of pages that have been written to the transaction log.

materialized_view_optimization

Returns a value indicating whether materialized views are used during query optimization:

  • Disabled
  • Fresh
  • Stale
  • N Minute[s]
  • N Hour[s]
  • N Day[s]
  • N Week[s]
  • N Month[s]
max_client_statements_cached

Returns the number of statements cached by the client.

max_cursor_count

Returns a value specifying the maximum number of cursors that a connection can use at once.

max_hash_size

This property is deprecated.

max_plans_cached

Returns a value specifying the maximum number of execution plans to be stored in a cache.

max_priority

Returns a value indicating the maximum priority level a connection can have.

max_query_tasks

Returns the maximum number of requests that the database server can use to process a query.

max_recursive_iterations

Returns a value specifying the maximum number of iterations a recursive common table expression can make.

max_statement_count

Returns a value specifying the maximum number of prepared statements that a connection can use simultaneously.

max_temp_space

Returns a value indicating the maximum amount of temporary file space available for a connection.

MessageReceived

Returns the string that was generated by the MESSAGE statement that caused the WAITFOR statement to be interrupted. Otherwise, an empty string is returned.

min_password_length

Returns the minimum length for new passwords in the database.

min_role_admins

Returns the minimum number of administrators required for a role.

Name

Returns the name of the current connection.

You can specify a connection name using the ConnectionName (CON) connection parameter.

The following names are used for temporary connections created by the database server:

  • INT:ApplyRecovery
  • INT:BackupDB
  • INT:Checkpoint
  • INT:Cleaner
  • INT:CloseDB
  • INT:CreateDB
  • INT:CreateMirror
  • INT:DelayedCommit
  • INT:DiagRcvr
  • INT:DropDB
  • INT:EncryptDB
  • INT:Exchange
  • INT:FlushMirrorLog
  • INT:FlushStats
  • INT:HTTPReq
  • INT:PromoteMirror
  • INT:PurgeSnapshot
  • INT:ReconnectMirror
  • INT:RecoverMirror
  • INT:RedoCheckpoint
  • INT:RefreshIndex
  • INT:ReloadTrigger
  • INT:RenameMirror
  • INT:RestoreDB
  • INT:StartDB
  • INT:VSS
NcharCharSet

Returns the NCHAR character set used by the connection. This property has extensions that you can specify when querying the property value.

nearest_century

Returns a value that indicates how two-digit years are interpreted in string-to-date conversions.

NodeAddress

Returns the node for the client in a client/server connection. When the client and server are both on the same computer, an empty string is returned.

non_keywords

Returns a list of keywords, if any, that are turned off so they can be used as identifiers.

Number

Returns the connection ID (a number) for the current connection.

NumLocalTempTables

Returns the number of local temporary tables in use by the connection. When a local temporary table is dropped or goes out of scope, it is still considered to be in use until the next COMMIT.

odbc_describe_binary_as_varbinary

Returns Off if the SAP Sybase IQ ODBC driver describes both BINARY and VARBINARY columns as SQL_BINARY and returns On if the ODBC driver describes BINARY and VARBINARY columns as SQL_VARBINARY.

odbc_distinguish_char_and_varchar

Returns Off if CHAR columns are described as SQL_VARCHAR, and On if CHAR columns are described as SQL_CHAR.

oem_string

Returns the string stored in the header page of the database file.

on_charset_conversion_failure

Returns one of Ignore, Warning, or Error to indicate the behavior when an error is encountered during character set conversion.

on_tsql_error

Returns one of Stop, Conditional, or Continue to indicate the behavior when an error is encountered while executing a stored procedure or T-SQL batch.

optimization_goal

Returns one of First-row or All-rows to indicate how query processing is optimized.

optimization_level

Returns a value between 0 and 15. This number is used to control the level of effort made by the SAP Sybase IQ query optimizer to find an access plan for a SQL statement.

optimization_workload

Returns a value indicating the level of effort made by the SAP Sybase IQ query optimizer to find an access plan for a SQL statement.

OSUser

Returns the operating system user name associated with the client process. If the client process is impersonating another user (or the set ID bit is set on Unix), the impersonated user name is returned. An empty string is returned for version 10.0.1 and earlier clients, and for HTTP and TDS clients.

PacketSize

Returns the packet size used by the connection, in bytes.

This property returns NA if the request that is currently executing is part of an event handler.

PacketsReceived

Returns the number of client/server communication packets received. This value is not updated for HTTP or HTTPS connections.

PacketsReceivedUncomp

Returns the number of packets that would have been received during client/server communications if compression was disabled. (This value is the same as the value for PacketsReceived if compression is disabled.)

PacketsSent

Returns the number of client/server communication packets sent. This value is not updated for HTTP or HTTPS connections.

PacketsSentUncomp

Returns the number of packets that would have been sent during client/server communications if compression was disabled. (This value is the same as the value for PacketsSent if compression is disabled.)

ParentConnection

Returns the connection ID of the connection that created a temporary connection to perform a database operation (such as performing a backup or creating a database). For other types of connections, this property returns NULL.

pinned_cursor_percent_of_cache

Returns the percentage of the cache that can be used for pinning cursors.

post_login_procedure

Returns the name of the procedure whose result set contains messages that should be displayed by applications when a user connects.

precision

Returns the decimal and numeric precision setting.

prefetch

Returns Off if no prefetching is done, Conditional if prefetching occurs unless the cursor type is SENSITIVE or the query includes a proxy table, or Always if prefetching is done even for SENSITIVE cursor types and cursors that involve a proxy table.

Prepares

Returns the number of statement preparations performed for the connection.

PrepStmt

Returns the number of prepared statements currently being maintained by the database server.

preserve_source_format

Returns On if the original source definition of procedures, triggers, views, and event handlers is saved in system tables, otherwise, returns Off.

prevent_article_pkey_update

Returns On if updates are not allowed to the primary key columns of tables involved in publications, otherwise returns Off.

priority

Returns a value indicating the priority level of a connection.

Progress

Returns information about how long a query has been running. For example:

43% (9728 of 22230 pages) complete after 00:00:05; estimated 00:00:06
remaining

This property has extensions that you can specify when querying the property value.

progress_messages

Returns the value of the progress_messages option.

query_mem_timeout

Returns the value of the query_mem_timeout option.

QueryBypassed

Returns the number of requests optimized by the optimizer bypass.

QueryBypassedCosted

Returns the number of requests processed by the optimizer bypass using costing.

QueryBypassedHeuristic

Returns the number of requests processed by the optimizer bypass using heuristics.

QueryBypassedOptimized

Returns the number of requests initially processed by the optimizer bypass and subsequently fully optimized by the SAP Sybase IQ optimizer.

QueryCachedPlans

Returns the number of query execution plans currently cached for the connection.

QueryCachePages

Returns the number of cache pages used to cache execution plans.

QueryDescribedBypass

Returns the number of describe requests processed by the optimizer bypass.

QueryDescribedOptimizer

Returns the number of describe requests processed by the optimizer.

QueryHeapPages

Returns the number of cache pages used for query processing (hash and sort operations).

QueryJHToJNLOptUsed

Returns the number of times a hash join was converted to a nested loops join.

QueryLowMemoryStrategy

Returns the number of times the server changed its execution plan during execution as a result of low memory conditions. The strategy can change because less memory is currently available than the optimizer estimated, or because the execution plan required more memory than the optimizer estimated.

QueryMemActiveCurr

Returns the number of requests actively using query memory.

QueryMemGrantFailed

Returns the total number of times a request waited for query memory, but failed to get it.

QueryMemGrantGranted

Returns the number of pages currently granted to requests.

QueryMemGrantRequested

Returns the total number of times any request attempted to acquire query memory.

QueryMemGrantWaited

Returns the total number of times any request waited for query memory.

QueryMemGrantWaiting

Returns the current number of requests waiting for query memory.

QueryOpened

Returns the number of OPEN requests for execution.

QueryOptimized

Returns the number of requests fully optimized.

QueryReused

Returns the number of requests that have been reused from the plan cache.

QueryRowsFetched

Returns the number of rows that have been read from base tables, either by a sequential scan or an index scan, for this connection.

QueryRowsMaterialized

Returns the number of rows that are written to work tables during query processing.

quoted_identifier

Returns On if strings enclosed in double quotes are interpreted as identifiers, or Off if they are interpreted as literal strings.

read_past_deleted

Returns On if sequential scans at isolation levels 1 and 2 skip uncommitted deleted rows, and Off if sequential scans block on uncommitted deleted rows at isolation levels 1 and 2.

recovery_time

Returns the maximum length of time, in minutes, that the database server will take to recover from system failure.

RecursiveIterations

Returns the number of iterations for recursive unions.

RecursiveIterationsHash

Returns the number of times recursive hash join used a hash strategy.

RecursiveIterationsNested

Returns the number of times recursive hash join used a nested loops strategy.

RecursiveJNLMisses

Returns the number of index probe cache misses for recursive hash join.

RecursiveJNLProbes

Returns the number of times recursive hash join attempted an index probe.

remote_idle_timeout

Returns the time, in seconds, of inactivity that web service client procedures and functions will tolerate.

replicate_all

For internal use only.

ReqCountActive

Returns the number of requests processed, or NULL if the RequestTiming server property is set to Off.

ReqCountBlockContention

Returns the number of times the connection waited for atomic access, or NULL if the -zt option was not specified.

ReqCountBlockIO

Returns the number of times the connection waited for I/O to complete, or NULL if the -zt option was not specified.

ReqCountBlockLock

Returns the number of times the connection waited for a lock, or NULL if the -zt option was not specified.

ReqCountUnscheduled

Returns the number of times the connection waited for scheduling, or NULL if the -zt option was not specified.

ReqStatus

Returns the status of the request. It can be one of the following values:

  • Idle – The connection is not currently processing a request.
  • Unscheduled* – The connection has work to do and is waiting for an available database server worker.
  • BlockedIO* – The connection is blocked waiting for an I/O.
  • BlockedContention* – The connection is blocked waiting for access to shared database server data structures.
  • BlockedLock – The connection is blocked waiting for a locked object.
  • Executing – The connection is executing a request.

The values marked with an asterisk (*) are only returned when logging of request timing information has been turned on for the database server using the -zt server option. If request timing information is not being logged (the default), the values are reported as Executing.

ReqTimeActive

Returns the amount of time, in seconds, spent processing requests, or NULL if the -zt option was not specified.

ReqTimeBlockContention

Returns the amount of time, in seconds, spent waiting for atomic access, or NULL if the RequestTiming server property is set to Off.

ReqTimeBlockIO

Returns the amount of time, in seconds, spent waiting for I/O to complete, or NULL if the -zt option was not specified.

ReqTimeBlockLock

Returns the amount of time, in seconds, spent waiting for a lock, or NULL if the -zt option was not specified.

ReqTimeUnscheduled

Returns the amount of unscheduled time, or NULL if the -zt option was not specified.

ReqType

Returns the type of the last request. If a connection has been cached by connection pooling, its ReqType value is CONNECT_POOL_CACHE.

request_timeout

Returns the maximum time a single request can run.

RequestsReceived

Returns the number of client/server communication requests or round trips. It is different from PacketsReceived in that multi-packet requests count as one request, and liveness packets are not included.

reserved_keywords

Returns a list of non-default reserved keywords that are enabled for the database.

return_date_time_as_string

Returns On if DATE, TIME, and TIMESTAMP values are returned to applications as a string, and Off if they are returned as a DATE or TIME data type.

Rlbk

The number of rollback requests that have been handled.

rollback_on_deadlock

Returns After when referential integrity actions are executed after the UPDATE or DELETE, and Before if they are executed before the UPDATE or DELETE.

RollbackLogPages

Returns the number of pages in the rollback log.

row_counts

Returns On if the row count is always accurate, and Off if the row count is usually an estimate.

scale

Returns the decimal and numeric scale for the connection.

secure_feature_key

Stores the key that is used to enable and disable features for a database server. Selecting the value of this property always returns an empty string.

ServerNodeAddress

Returns the node for the server in a client/server connection. When the client and server are both on the same computer, an empty string is returned.

This property returns NA if the request that is currently executing is part of an event handler.

ServerPort

Returns the database server's TCP/IP port number or 0.

SessionCreateTime

Returns the time the HTTP session was created.

SessionID

Returns the session ID for the connection if it exists, otherwise, returns an empty string.

SessionLastTime

Returns the time of the last request for the HTTP session.

SessionTimeout

Returns the time, in minutes, the HTTP session persists during inactivity.

SnapshotCount

Returns the number of snapshots associated with the connection.

sort_collation

Returns Internal if the ORDER BY clause remains unchanged, otherwise the collation name or collation ID is returned.

SortMergePasses

Returns the number of merge passes used during sorting.

SortRowsMaterialized

Returns the number of rows written to sort work tables.

SortRunsWritten

Returns the number of sorted runs written during sorting.

SortSortedRuns

Returns the number of sorted runs created during run formation.

SortWorkTables

Returns the number of work tables created for sorting.

sql_flagger_error_level

Returns one of the following values to indicate which SQL that is not part of a specified set of SQL/2003 is flagged as an error:

  • E – Flag syntax that is not entry-level SQL/2003 syntax
  • I – Flag syntax that is not intermediate-level SQL/2003 syntax
  • F – Flag syntax that is not full-SQL/2003 syntax
  • W – Allow all supported syntax
sql_flagger_warning_level

Returns one of the following values to indicate which SQL that is not part of a specified set of SQL/2003 is flagged as a warning:

  • E – Flag syntax that is not entry-level SQL/2003 syntax
  • I – Flag syntax that is not intermediate-level SQL/2003 syntax
  • F – Flag syntax that is not full-SQL/2003 syntax
  • W – Allow all supported syntax
st_geometry_asbinary_format

Returns a value that indicates how spatial values are converted from a geometry to a binary format.

st_geometry_astext_format

Returns a value that indicates how spatial values are converted from a geometry to text.

st_geometry_asxml_format

Returns a value that indicates how spatial values are converted from a geometry to xml.

st_geometry_describe_type

Returns a value that indicates spatial values are described.

st_geometry_interpolation

Returns the interpolation setting for ST_CircularString geometries.

st_geometry_on_invalid

Returns a value that indicates the behavior when a geometry fails surface validation.

StatementDescribes

Returns the total number of statements processed by DESCRIBE requests.

StatementPostAnnotates

Returns the number of statements processed by the semantic query transformation phase.

StatementPostAnnotatesSimple

Returns the number of statements processed by the semantic query transformation phase, but that skipped some of the semantic transformations.

StatementPostAnnotatesSkipped

Returns the number of statements that have completely skipped the semantic query transformation phase.

string_rtruncation

Returns On if an error is raised when a string is truncated, and returns Off if an error is not raised and the character string is silently truncated.

subsume_row_locks

Returns On if the database server acquires individual row locks for a table, otherwise, returns Off.

suppress_tds_debugging

Returns Off if TDS debugging information appears in the database server messages window, and returns On if debugging information does not appear in the database server messages window.

synchronize_mirror_on_commit

Returns On if the database mirror server is synchronized on commit, otherwise returns Off.

tds_empty_string_is_null

Returns On if empty strings are returned as NULL for TDS connections, and returns Off if a string containing one blank character is returned for TDS connections.

temp_space_limit_check

Returns On if the database server checks the amount of temporary space available for a connection, and returns Off if the database server does not check the amount of space available for a connection.

TempFilePages

Returns the number of temporary file pages used by the connection.

TempTablePages

Returns the number of pages in the temporary file used for temporary tables.

time_format

Returns the string format used for times retrieved from the database.

time_zone_adjustment

Returns the number of minutes that must be added to the Coordinated Universal Time (UTC) to display time local to the connection.

timestamp_format

Returns the format for timestamps that are retrieved from the database.

timestamp_with_time_zone_format

Returns the format for TIMESTAMP WITH TIME ZONE values retrieved from the database.

TimeZoneAdjustment

Returns the number of minutes that must be added to the Coordinated Universal Time (UTC) to display time local to the connection.

TransactionStartTime

Returns a string containing the time the database was first modified after a COMMIT or ROLLBACK, or an empty string if no modifications have been made to the database since the last COMMIT or ROLLBACK.

truncate_timestamp_values

Returns On if the number of decimal places used in the TIMESTAMP values is limited, otherwise, returns Off.

trusted_certificates_file

Returns the file that contains the list of trusted Certificate Authority certificates when the database server acts as a client to an LDAP server.

tsql_outer_joins

Returns On if Transact-SQL outer joins can be used in DML statements.

tsql_variables

Returns On if you can use the @ sign instead of the colon as a prefix for host variable names in embedded SQL, otherwise, returns Off.

UncommitOp

Returns the number of uncommitted operations.

updatable_statement_isolation

Returns the isolation level (0, 1, 2, or 3) used by updatable statements when the isolation_level option is set to Readonly-statement-snapshot.

update_statistics

Returns On if this connection can send query feedback to the statistics governor. When the update_statistics option is set to Off, the statistics governor does not receive query feedback from the current connection.

upgrade_database_capability

This property is reserved for system use. Do not change the setting of this option.

user_estimates

Returns one of the following values that controls whether selectivity estimates in query predicates are respected or ignored by the query optimizer:

  • Enabled – All user-supplied selectivity estimates are respected. You can also use On to turn on this option.
  • Override-Magic – A user selectivity estimate is respected and used only if the optimizer would otherwise choose to use its last-resort, heuristic value (also called the magic value).
  • Disabled – All user estimates are ignored and magic values are used when no other estimate data is available. You can also use Off to turn off this option.
UserAppInfo

Returns the string specified by the AppInfo connection parameter in a connection string.

UserDefinedCounterRate01

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the change in the value of the counter over time.

UserDefinedCounterRate02

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the change in the value of the counter over time.

UserDefinedCounterRate03

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the change in the value of the counter over time.

UserDefinedCounterRate04

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the change in the value of the counter over time.

UserDefinedCounterRate05

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the change in the value of the counter over time.

UserDefinedCounterRaw01

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the absolute value of the counter.

UserDefinedCounterRaw02

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the absolute value of the counter.

UserDefinedCounterRaw03

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the absolute value of the counter.

UserDefinedCounterRaw04

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the absolute value of the counter.

UserDefinedCounterRaw05

Returns the current value of the user-defined performance counter. The semantics of this property are defined by the client application. This counter can also be accessed from the Performance Monitor. The Performance Monitor displays the absolute value of the counter.

UserID

Returns the user ID for the connection.

UtilCmdsPermitted

Returns On or Off to indicate whether utility commands such as CREATE DATABASE, DROP DATABASE, and RESTORE DATABASE are permitted for the connection.

uuid_has_hyphens

This property controls the formatting of unique identifier values when they are converted to strings.

verify_password_function

Returns the name of the function used for password verification if one has been specified.

wait_for_commit

Returns On if the database does not check foreign key integrity until the next COMMIT statement. Otherwise, returns Off and all foreign keys that are not created with the check_on_commit option are checked as they are inserted, updated or deleted.

WaitStartTime

Returns the time at which the connection started waiting (or an empty string if the connection is not waiting).

WaitType

Returns the reason for the wait, if it is available. Possible values for WaitType are:

  • lock – Returned if the connection is waiting on a lock.
  • waitfor – Returned if the connection is executing a waitfor statement.
  • empty string – Returned if the connection is not waiting, or if the reason for the wait is not available.
webservice_namespace_host

Returns the hostname to be used as the XML namespace within generated WSDL documents if one has been specified.

webservice_sessionid_name

Returns the session identifier name that is used by the web server to determine whether session management is being used.