Re-indexing metadata

The text index can be fully reindexed without disturbing production. The reindexing process also handles application server restarts, and can be monitored. Normally, reindexing is only needed if the metadata field definition are changed, but it can be a good idea to reindex if the database is moved or if upgrading to a newer version of Vidispine.

Controlling index of items/collections

If the metadata field solr-index of an item/collection is set to false, it won’t be indexed.

Example:

<MetadataDocument xmlns="http://xml.vidispine.com/schema/vidispine">
   <timespan end="+INF" start="-INF">
      <field>
         <name>solr-index</name>
         <value>false</value>
      </field>
   </timespan>
</MetadataDocument>

Note

The number of indexes returned in the GET command is only an estimate.

Changed in version 5.0: The document index was added.

Request a reindex

PUT /reindex/(index)

Starts a reindex. If a reindex of the same type is already in progress, it is restarted.

The types than can be reindexed are: item, collection, ACL, file, thumbnail and document.

Note

Only files that do not belong to an item will be indexed when reindexing files. To reindex all files both a file and item reindex must be started.

Parameters:
  • index (string) – The index to rebuild. One of item, collection, acl, file, thumbnail or document.
Query Parameters:
 
  • status (string) –

    If current status is FINISHED or ABORTED then PAUSED, ABORTED and IN_PROGRESS are no-ops.

    • IN_QUEUE (default) - To start or restart reindex.
    • PAUSED - To pause reindex.
    • ABORTED - To cancel reindex.
    • IN_PROGRESS/IN PROGRESS - To resume a paused reindex.
  • priority (integer) – The priority of this reindex request compare to other request. Requests with a larger/higher priority will be processed first. Default is 500.
Produces:
Role:

_administrator

Example:

PUT /reindex/item
<ReindexRequestDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <index>item</index>
    <priority>500</priority>
    <status>IN QUEUE</status>
    <start>2016-03-23T22:41:04.133+01:00</start>
</ReindexRequestDocument>

Retrieve reindex status

GET /reindex/(index)

Gets information about a reindex process, i.e., progress and whether it is finished.

Produces:
Role:

_administrator

Example:

GET /reindex/item
<ReindexRequestDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <index>item</index>
    <priority>500</priority>
    <status>FINISHED</status>
    <start>2016-03-23T22:41:04.133+01:00</start>
    <finish>2016-03-23T22:41:04.774+01:00</finish>
    <indexesDone>48</indexesDone>
    <indexesTotal>48</indexesTotal>
</ReindexRequestDocument>