docpush reference

FAST Search Server 2010

Applies to: FAST Search Server 2010

Topic Last Modified: 2011-01-14

docpush is a test and diagnostics tool that you can use to feed a single item into a Microsoft FAST Search Server 2010 for SharePoint farm. You can also use the tool to delete single items from the index.

docpush has two modes of operation:

  • Redirect mode, enabled with the -r option

  • Direct mode, which is enabled by default

Use redirect mode (-r) to specify one or more relative file system references to have the DocumentRetriever item processing stage in the processor server download the items. Redirect mode assumes that all running processor servers have access to the specified file system reference, e.g. through a mounted share if the processor servers are running on a different network host.

You must specify one or more file references or URIs after the global options.

To use a command-line tool, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.

<FASTSearchFolder>\bin\docpush [global options] <file or URI> ... <file or URI>


Parameter Description

<file or URI> ... <file or URI>

Specifies the files or URIs to feed.


The path of the folder where you have installed FAST Search Server 2010 for SharePoint, for example C:\FASTSearch.


Option Value Required? Description



Displays help information.



Displays version information.




Specifies the content collection name. A collection called sp is created when FAST Search Server 2010 for SharePoint is deployed.



Uses redirection instead of reading and submitting the file content directly. docpush will send a reference to the file or item as a URI instead of reading the content locally and submitting it directly.

This option will not work if a firewall or proxy server does not allow the item processing servers within the FAST Search Server 2010 for SharePoint farm to access to the file or item. The item processing server must have read access rights to the file share and the file itself.



Redirection prefix. This specifies a common file prefix that is typically used when several file references are specified for submission.

Default: file:/<current directory>/


<URI prefix>


Specifies a URI prefix that is prepended to a file name reference and used as the item ID when the file is submitted. Used with direct mode only.


This option is normally not applicable, as the firewall or proxy settings will not enable the item processing servers to access external URIs.



Pushes URIs on the command line. Redirect mode (-r) is automatically enabled with this option.

The URI specifies the item ID and the getpath item attribute for the operation that is fed to the system. No local content/files are required when this option is used.



Deletes an item, instead of pushing it.


<number of documents>


When several items are pushed at the same time, sends them as a batch with the specified number of items in each batch.




Specifies the last callback in the feeding chain to wait for. The callbacks available in the default feeding chain are as follows:



  • LIVE



Enables verbose output.


<debug level>


Sets the debug level. Valid options are as follows:

  • debug

  • error

  • info

  • verbose

  • warning

The following example submits the URI to the sp collection (the DocumentRetriever item processing stage will download the item referenced by the URI):

<FASTSearchFolder>\bin\docpush -c sp -U

This example feeds the file c:\test.txt to the sp collection:

<FASTSearchFolder>\bin\docpush -c sp c:\test.txt

The following example reads the file test.txt in the current directory and feeds it to the sp collection:

<FASTSearchFolder>\bin\docpush -c sp -r test.txt

To read the file c:\test.txt and feed it to the sp collection with an absolute prefix of file:///, follow this example:

<FASTSearchFolder>\bin\docpush -c sp -r -g file:/// C:\test.txt