Checks the current operational state of the database and returns one of the following codes:

  • 0—Success. The database passed the health check for the specified state.
  • 1-15—Internal failures prevented the utility from running.
  • 16—Startup check failed.
  • 32—Liveness check failed.
  • 64—Readiness check failed.

Syntax

proutil db-name -C probe state [ -livenessTimeout seconds] 
   [ -verbose ]

Parameters

db-name
Specifies the name of the database to be checked.
probe

Returns the current state of the database.

state
Specifies one of the following three states to be checked.
State Definition Success Failure
startup The broker has begun serving users. Some logins are enabled for the database. Logins are not yet enabled. Either startup may still occur as during failure recovery, or the broker process does not yet exist.
liveness The broker runs normally and returns no errors. Startup is completed and the broker is responsive. The broker either has trouble spawning another broker, or has a problem with the USR latch or login semaphore.
readiness The database has passed the liveness state and is ready for additional connections. The database is ready to connect with any language client and complete the activity allowed on the database. The allowed activity is typically CRUD (create, read, update and delete) operations, but on a replication target and read-only databases, it is read operations, soley. Either additional client connections are not possible, or they cannot perform activity on the database. The following may prevent readiness:
  • AI or BI stall
  • Online backup during the BI-backup phase
  • Maximum users reached (-n limit excluding the special slot for proshut)
LivenessTimeout

Specifies the number of seconds to wait when a database fails a probe check.

seconds
Specifies the number of seconds to wait for the liveness timeout. The valid range is from 10 to 600 seconds, and the default is 60 seconds.
-verbose
Provides messages about failures of state checks, such as:
  • Database .lk file does not exist. (20881)
  • Replication is not connected or a communications error occurred. (20900) This message may be displayed for a readiness state check if you started the target but not the source database.
  • Broker process with PID 14459 is dead. (20888) This message is displayed for a liveness or a readiness check if the broker is not running. (Liveness is a precursor to readiness.)
  • Database is in a quiet point. (20898) This message is displayed for a readiness check but not a liveness check because clients cannot connect to perform any activity.
  • Broker process with PID 14733 is unresponsive. Time of last update: Jun 20 17:11:31 2023 (20890)

For successful responses, -verbose provides no output.