index export start

The index export start command exports the search index to a desired output location in *.zip file format. The *.zip file contains a *.txt file with pipe delimiters and double quotes as text qualifiers. The output file name corresponds to the name of the search index, followed by the time stamp.
  • For Legacy indexes, this command exports only the fields marked as Store when the index is created.
  • For Clustered indexes, this command exports all index fields.
  • The line break type is CRLF for Windows and LF for non-Windows exported files.


index export start --i indexName --o outputLocation --d Delimiter --q TextQualifier
Yes--i indexNameSpecifies the name of the search index to export.
Yes--o outputLocationSpecifies the output location for the exported index. If you do not specify an output location, you will see a message reminding you to do this.
No--d DelimiterFile Delimiter of the output file. By default, it is set to pipe.
Note: Delimiter values for Space and Tab are "\ " and "\t" respectively.
No--q TextQualifierText Qualifier of the output file. By default, it is set to double quotes.
Note: You don't need to specify the qualifier value if you want to set it to double quotes, as it is the default value.
Example 1

This example exports a search index named "CustomerIndex" to output location "pbIndexExports."

index export start --i CustomerIndex --o c:/pbIndexExports

Example 2

This example exports the search index sample_index to an output location /home/exportLocation with delimiter as dollar sign and qualifier as curl sign.

index export start --i sample_index --o /home/exportLocation --d $ --q ^