Using the rck2 Utility to Search K2 Documents

The rck2 command-line tool allows you to search collections associated with a K2 Server in a K2 Search System. rck2 is installed into the ColdFusion bin directory:

UNIX: /opt/coldfusion/bin
Windows: cfusion\bin

rck2 syntax

The syntax used to start rck2 from the command line is:

rck2 -server <servername> -port <portno>

For example: c:\cfusion\bin\rck2 -server localhost -port 9901

Syntax Element

Description

-server <servername>
The server name for the K2 Server to attach to. The server name is defined in the k2server.ini file. The collections attached to this server will be searched by rck2.

-port <portno>
The port number where the K2 Server (specified in -server) is running.

Syntax Element	Description
-server <servername>	The server name for the K2 Server to attach to. The server name is defined in the k2server.ini file. The collections attached to this server will be searched by `rck2`.
-port <portno>	The port number where the K2 Server (specified in -server) is running.

rck2 command options

rck2 Command

Description

p <sortspec>
The sort specification for the search results. By default results are sorted by Score. Multiple fields must be specified in a space-separated list using asc or desc to indicate ascending or decending order. For example: p score desc title asc

m <maxdocs>
The maximum number of documents to return in the results list.

c <collections>
The list of collections to search. Multiple collections must be specified in a space separated list. For example: c coll1 coll2 coll3

f <fields>
The list of fields to retrieve. For example: f k2dockey title date

s <query text>
The query (or question) to be used to process the search. The query can be expressed as words and phrases separated by commas. Additionally, the query can include Verity query language, operators and modifiers.

g <collection>
Display collection information.

d <k2dockey>
Display fields for the K2 document key specified.

v <k2dockey>
Stream the document and display it with highlights.

r <docstart>
Display results starting with the first result in the results list. Fields specified using the f command are displayed. Docstart indicates the first result to be displayed. For example, r 10 displays results starting with the 10th document in the results list.

b <docstart>
Display results based on the last field selection.

i
Display information about the K2 Server including nodes and collections.

x <score precision>
Set score precision to 8 or 16 bit. By default, 16 bit precision is used.

h or ?
Display online help for the rck2 command options.

Advanced ColdFusion Administration
Configuring Verity K2 Server

rck2 Command	Description
p <sortspec>	The sort specification for the search results. By default results are sorted by Score. Multiple fields must be specified in a space-separated list using asc or desc to indicate ascending or decending order. For example: `p score desc title asc`
m <maxdocs>	The maximum number of documents to return in the results list.
c <collections>	The list of collections to search. Multiple collections must be specified in a space separated list. For example: `c coll1 coll2 coll3`
f <fields>	The list of fields to retrieve. For example: `f k2dockey title date`
s <query text>	The query (or question) to be used to process the search. The query can be expressed as words and phrases separated by commas. Additionally, the query can include Verity query language, operators and modifiers.
g <collection>	Display collection information.
d <k2dockey>	Display fields for the K2 document key specified.
v <k2dockey>	Stream the document and display it with highlights.
r <docstart>	Display results starting with the first result in the results list. Fields specified using the f command are displayed. Docstart indicates the first result to be displayed. For example, `r 10` displays results starting with the 10th document in the results list.
b <docstart>	Display results based on the last field selection.
i	Display information about the K2 Server including nodes and collections.
x <score precision>	Set score precision to 8 or 16 bit. By default, 16 bit precision is used.
h or ?	Display online help for the `rck2` command options.