Retrieve Status of Collection

This procedure returns the status of the text search collection.

STATUS

Authorization

This stored procedure is created with public authority *EXCLUDE and is owned by the creator of the text search collection.

The procedure will adopt the authority of the text search collection owner's profile. Authority can be granted to other users to allow them to execute the procedure.

Syntax

Read syntax diagramSkip visual syntax diagram STATUS

The schema qualifier is the name of the text search collection.

Parameters

None

RESULT SET RETURNED

The procedure returns a result set that has one row for each object set:

SERVERID          INTEGER
SERVERNAME        VARCHAR(128)
SERVERSTATUS      VARCHAR(32)
LASTUPDATETIME    TIMESTAMP
LASTUPDATESTATUS  VARCHAR(30)
UPDATEFREQUENCY   VARCHAR(512)

SERVERID - The server ID for the text search index.

SERVERNAME - The host name or IP address of the text search server.

SERVERSTATUS - Indicates whether the server can be used as a text search server to create new text search indexes. The default value is 0 (zero), which means that the server can be used.

LASTUPDATETIME - The time that the text search index was last updated.

LASTUPDATESTATUS - Indicate last update status for the text search index.
NEVER UPDATED   - The text search index is never updated before.
UP TO DATE      - The text search index is up to date.
CHANGES PENDING - There are changes pending. User need update the index to make the text search index up to date.
FAILED          - The text search index was updated failed last time.

UPDATEFREQUENCY - When to make automatic updates to the text search index.

Examples

Call MYCOLLECTION.STATUS;

To retrieve status of collection from IBM® Navigator for i, follow these steps.

  1. From IBM Navigator for i, expand IBM i Management > System > All Tasks.
  2. On the right panel, select System > OmniFind > Collection List.