SEARCH-CMD(1)()

NAME
search-cmd - Riak Search and query tool

SYNOPSIS
search-cmd [set-schema] [show-schema] [clear-schema-cache] [search] [search-doc] [explain] [index] [delete] [solr] [install] [uninstall] [test]

DESCRIPTION
Riak Search is a distributed, decentralized, full-text search system with a Solr compatible interface.

The search-cmd command provides administration and query tools for a Riak Search cluster. Be sure to enable search on the appropriate node(s) via app.config. With search enabled, search-cmd can be used with several subcommands to perform the desired operation against Riak search.

OPTIONS
The search-cmd command can be invoked without arguments for a list of subcommands. The <index> argument is optional, and defaults to search.

set-schema
    <index> <schema_file>
    Specify the schema to be used for a particular index. If not explicitly specified, index will use default schema.

show-schema
    <index>
    Show the schema in use for a particular index.

clear-schema-cache
    Clear cached schemas; commonly invoked after modifying schemas to ensure use of latest schema version.

search
    <index> <query>
    Execute a search query using Lucene syntax on an index; returns document identifier, properties, and score.

search-doc
    <index> <query>
    Execute a search query using Lucene syntax on an index; returns document identifier, properties, score, and document fields.

explain
    <index> <query>
    Outputs current query plan for specified index.

index
    <index> <path>
    Index document located at specified relative or absolute path.

delete
    <index> <path>
    Delete documents for specified index located at relative or absolute path. The use of wildcards is permitted in path.

solr
    <index> <path>
    Index Solr XML document located at specified relative or absolute path.

install
    <bucket> Install search pre-commit hook on specified bucket to allow indexing incoming objects.

uninstall
    <bucket>
    Uninstall search pre-commit hook from specified bucket.

test
    <path>
    Execute search test script located at specified relative or absolute path.

    Index a Solr XML document:

    pong

    Delete indexed documents:

    ok

AUTHORS
Riak is developed by Basho Technologies, Inc. http://basho.com