Db2 Text Search and NSE syntactic differences for administration

Db2 Text Search and Net Search Extender administrative operations differ syntactically. It is important to be aware of the differences between the two search engines. Use the following tables to help understand the syntactic variations that exist for both Db2 Text Search and Net Search Extender. Note that the tables are based on NSE functionality; additional features in Db2 Text Search are not reflected here.

Important: Net Search Extender (NSE) is no longer supported in Db2. Use the Db2 Text Search feature.

START command

Search Solution Syntax
Common  
Net Search Extender  
Renamed for Db2 Text Search 
>>-START -------------------------><
is now
>>-START FOR TEXT--+-STATUS-+------------------><
                   '-VERIFY-'

STOP command

Search Solution Syntax
Common  
Net Search Extender 
>>-STOP ------------------------->
---------| FORCE |---------------><
Renamed for Db2 Text Search 
>>-STOP FOR TEXT--+-STATUS-+-----------><
                  '-VERIFY-'

ENABLE DATABASE FOR TEXT command

Search Solution Syntax
Common 
>>-ENABLE DATABASE FOR TEXT------------------->

>--+---------------------------------------+----><
   '-| AUTOGRANT |--| connection options |-'
Net Search Extender  
Db2 Text Search  
Note: The AUTOGRANT option is ignored for text search.

DISABLE DATABASE FOR TEXT command

Search Solution Syntax
Common 
DISABLE DATABASE FOR TEXT--+-------+-------->
                           '-FORCE-'   

>--| connection options |------------------><
Net Search Extender  
Renamed for Db2 Text Search  

ACTIVATE CACHE command

No corresponding command in Db2 Text Search

ALTER INDEX FOR TEXT command

Search Solution Syntax
Common 
>>-ALTER INDEX--index-name--FOR TEXT---------------------->

>--| update characteristics |--| storage options |-------->

>--| connection options |--------------------------------><

update characteristics

|--+--------------------------------------------+--------->
   '-UPDATE FREQUENCY--+-NONE-----------------+-'   
                       '-| update frequency |-'     

>--| incremental update characteristics |----------------|

update frequency

|--D-(-+-*------------+-)--H-(-+-*------------+-)--------->
       | .-,--------. |        | .-,--------. |     
       | V          | |        | V          | |     
       '---integer1-+-'        '---integer2-+-'     

       .-,--------.     
       V          |     
>--M-(---integer3-+-)------------------------------------|

incremental update characteristics

|--+----------------------------+------------------------|
   '-UPDATE MINIMUM--minchanges-'
Net Search Extender storage options:
  • work directory
  • cache table
  • maximum cache size
Db2 Text Search incremental update characteristics:
  • commitcount for update resolves to updateautocommit
storage options:
  • index directory resolves to collection directory

CONTROL command

Search Solution Syntax
Common  
Net Search Extender 
>>-CONTROL--+--LIST ALL LOCKS ...
            +--SHOW CACHE STATUS ...
Renamed for Db2 Text Search (1) 
>>-CONTROL--+--CLEAR ALL LOCKS FOR |--database---| --+--
                                   |- index -----|
is now
>>-CLEAR COMMAND LOCKS--+-----------------------+--FOR TEXT----->
                        '-FOR INDEX--index-name-'             

>--| connection options |--------------------------------><
(2)
>>-CONTROL--STATUS -----
is now
>>-START FOR TEXT---status---<

CLEAR EVENTS command

Search Solution Syntax
Common 
>>-CLEAR EVENTS FOR INDEX--index-name--FOR TEXT----------->

>--| connection options |--------------------------------><
Net Search Extender commitcount
Db2 Text Search  

CREATE INDEX FOR TEXT command

Search Solution Syntax
Common 
>>-CREATE INDEX--+------------------+--index-name FOR TEXT ON--->
'-index-schema-"."-' 

>--+------------------+--table-name----------------------------->
'-table-schema-"."-' 

>--+-(text-column-name)----------------------------------------------+-->
'-(--+-------------------+--function-name-(-text-column-name-)--)-' 
'-|function-schema "."|-' 
>-| text default information |--| update characteristics ->

>-| storage options |--| index configuration options |---->

>--| connection options |---------------><

text default information

|--+---------------------+--+------------------+------->
   '--LANGUAGE--locale-'   

   '-FORMAT--format-'   
update characteristics

|--+--------------------------------------------+------>
   '-UPDATE FREQUENCY--+-NONE-----------------+-'   
                       '-| update frequency |-'     

>--| incremental update characteristics |----------------|

update frequency

|--D-(-+-*------------+-)--H-(-+-*------------+-)--------->
       | .-,--------. |        | .-,--------. |     
       | V          | |        | V          | |     
       '---integer1-+-'        '---integer2-+-'     

       .-,--------.     
       V          |     
>--M-(---integer3-+-)-------------------------------------|

incremental update characteristics

|--+----------------------------+----------------------|
   '-UPDATE MINIMUM--minchanges-'   
storage options

>--+-------------------------------------------+----------|
   '-ADMINISTRATION TABLES IN--tablespace-name-'   

index configuration options

|--+-----------------------------------------------+------|
   |                        .-,----------------.   |   
   |                        V                  |   |   
   '-INDEX CONFIGURATION--(---| option-value |-+-)-'   

option-value

|--+-----------------------------------------+------------|
   +-AUXLOG--auxlog_value--------------------+ 
 +-UpdateDelay         --------------------+
Net Search Extender 
>--+------------------+----------------------------------------->
'-|attribute-list|-' 
>--+-------------------------------+---------------------------->
'-|cache-search-result-options|-' 


in text-default-options:
|--+---------------------+----------------------|
'- model-information -'


in storage-options:

|--+-------------------------------+--------------|
'-WORK DIRECTORY--workdirectory-' 


in incremental-update-characteristics:
>--+---------------------------+-------------------------------->
'-REORGANIZE--+-AUTOMATIC-+-' 
'-MANUAL----' 
>--+---------------------------------+--------------------------|
'-|capture-table-characteristics|-' 

option-value

|--+-----------------------------------------+------------|
   +-TreatNumbersAsWords---------------------+   
   +-IndexStopWords                       ---+   
   '-IgnoreEmptyDocs                        -'
Db2 Text Search text default information
  • CCSID resolves to CODEPAGE
incremental update characteristics
  • commitcount for update is now index configuration updateautocommit 
storage options

|--+---------------------------------+------------------->
    '-INDEX DIRECTORY--directory-'   

is now

|--+---------------------------------+------------------->
    '-COLLECTION DIRECTORY--directory-'

DB2EXTHL command

No corresponding command for Db2 Text Search.

DB2EXTTH command

No corresponding command for Db2 Text Search.

DEACTIVATE CACHE command

No corresponding command for Db2 Text Search.

DROP INDEX FOR TEXT command

Search Solution Syntax
Common 
>>-DROP INDEX--index-name--FOR TEXT--+----------------+--->
                                     
>--| connection options |--------------------------------><
Net Search Extender  
Db2 Text Search  

RESET PENDING command

Search Solution Syntax
Common 
>>-RESET PENDING FOR TABLE-- table-schema.table-name--FOR TEXT-->

>--+----------------------+------------------------------><
   '-|connection-options|-'
Net Search Extender  
Db2 Text Search  

UPDATE INDEX FOR TEXT command

Search Solution Syntax
Common 
>>-UPDATE INDEX--index-name--FOR TEXT--+----------------+->
                                      '-UPDATE OPTIONS-'   
--|-- Reorganize -- | -- Commitcount --|-- 
>--| connection options |--------------------------------><

UPDATE OPTIONS:
using update minimum
Net Search Extender Reorganize
Db2 Text Search Commitcount resolves to updateautocommit
Note: A reorganize feature for Db2 Text Search is available with the adminTool utility.

HELP command

Search Solution Syntax
Common 
>>---+-HELP-+--+------------------+---------------------><
     '-?----'  +-command----------+
Net Search Extender 
+-- reasoncode --+
Db2 Text Search Reasoncode resolves to error-identifier

COPYRIGHT command

Search Solution Syntax
Common  
Net Search Extender COPYRIGHT | LEVEL
Db2 Text Search  
Note: Db2 Text Search is a Db2 component. It shares the level information from Db2.