loading table of contents...

3.14.2.4. DBIndex

The dbindex utility is intended for creating an index over the folder structure of your CoreMedia CMS repository. This index will enhance the speed of a query using the descendantOf criterion. However, maintaining this index may affect the performance of the server, especially if you restructure large folders frequently. There is no need to create the index if descendantOf queries are used rarely or the folder tree is small.

You cannot access the CoreMedia CMS repository for some minutes after start of the utility.

[Note]Note

A log message like this "Warning: cap.server.store: SQL Query: finding candidate folders for query takes a long time (5008ms for 348 folders so far); consider activating the folder index" is a good pointer, that you should use the dbindex tool.

usage: cm dbindex -u <user> [other options] [ --create | --drop |
          --rebuild | --enable | --disable ]
available options:
 -b,--rebuild               rebuild index
 -c,--create                create index
 -r,--drop                  drop index
 -e,--enable                enable index
 -i,--disable               disable index
 -p,--password <password>   password for login
 -d,--domain <domain name> domain for login (default=<builtin>)
 -u,--user <user name>      user for login (required)
 -url <ior url>             url to connect to
 -v,--verbose                enables verbose output

The options have the following meaning:

Parameter Description
-b Rebuild the existing index. You need this only in exceptional cases. Normally you will create or enable the index.
-c Create the index for the first time or after you dropped it.
-r Drop the index.
-e Enable the index after you temporarily disabled it. After major changes in the folder structure it might be faster to drop and create the index.
-i Temporarily disable the index. You might want to do so for some fast changes in the folder structure.

Table 3.24. Options of dbindex


After changes in the folder structure have been made, the index is automatically updated while the content server is online. If a large portion of the folder structure changes, that is several moves of large sub trees have been made, this may take a moment. So, there can be a short delay in descendantOf queries afterwards.

To avoid unnecessary updates of the database, the index on a Live System (Master Live Server or Replication Live Server) should only be enabled if there are descendantOf queries from inside the CAE JSP templates.