Chapter 27 Search Subcommands - Search Database Management

This chapter discusses the following search subcommands:

• analyze-search-database

• create-search-database

• expire-search-database

• list-search-databases

• purge-search-database

• reindex-search-database

• get-search-database-attribute

• list-search-database-attributes

• set-search-database-attribute

Search Database

analyze-search-database

Description

Analyzes a database for a search server.

Syntax

Long Format

psadmin analyze-search-database --searchserver search-server-ID --adminuser uid --passwordfile password-filename --database database-name [--debug] [--output output-filename] [--verbose] [--refresh]

Short Format

psadmin analyze-search-database -s search-server-ID -u uid -f password-filename -r database-name [--debug] [--output output-filename] [-v] [--refresh]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database | -r] database-name

Specifies the database.

The following options are optional:

[--refresh]

Refreshes the analysis cache.

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

create-search-database

Description

Creates a search database.

Syntax

Long Format

psadmin create-search-database --searchserver search-server-ID --adminuser uid --passwordfile password-filename --database database-name [--debug] [--output output-filename] [--verbose] [--attributes] '"key1=value1" "key2=value2" ...'

Short Format

psadmin create-search-database -s search-server-ID -u uid -f password-filename -r database-name [--debug] [--output output-filename] [-v] [--attributes] '"key1=value1" "key2=value2" ...'

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database | -r] database-name

Specifies the database.

The following options are optional:

[--attributes] '"key1=value1" "key2=value2" ...'

Specifies a list of attributes for the database.

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

expire-search-database

Description

Expires a database for a search server.

Syntax

Long Format

psadmin expire-search-database --searchserver search-server-ID --adminuser uid --passwordfile password-filename --database database-name [--debug] [--output output-filename] [--verbose]

Short Format

psadmin expire-search-db -s search-server-ID -u uid -f password-filename -r database-name [--debug] [--output output-filename] [-v]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database | -r] database-name

Specifies the database.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

list-search-databases

Description

Lists all databases of a search server.

Syntax

Long Format

psadmin list-search-databases --searchserver search-server-ID --adminuser uid --passwordfile password-filename [--debug] [--output output-filename] [--verbose]

Short Format

psadmin list-search-dbs -s search-server-ID -u uid -f password-filename [--debug] [--output output-filename] [-v]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

purge-search-database

Description

Purges the database for a search server.

Syntax

Long Format

psadmin purge-search-database --searchserver search-server-ID --adminuser uid --passwordfile password-filename --database database-name [--debug] [--output output-filename] [--verbose]

Short Format

psadmin purge-search-db -s search-server-ID -u uid -f password-filename -r database-name [--debug] [--output output-filename] [-v]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database | -r] database-name

Specifies the database.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

reindex-search-database

Description

Reindexes a database for a search server.

Syntax

Long Format

psadmin reindex-search-database --searchserver search-server-ID --adminuser uid --passwordfile password-filename -database database-name [--debug] [--output output-filename] [--verbose]

Short Format

psadmin reindex-search-db -s search-server-ID -u uid -f password-filename -r database-name [--debug] [--output output-filename] [-v]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database | -r] database-name

Specifies the database.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

get-search-database-attribute

Description

Displays a search database attribute.

Syntax

Long Format

psadmin get-search-database-attribute --searchserver search-server-ID --adminuser uid --passwordfile password-filename --database database-name --attribute key [--debug] [--output output-filename] [--verbose]

Short Format

psadmin get-search-db-attribute -s search-server-ID -u uid -f password-filename -r database-name --attribute key [--debug] [--output output-filename] [-v]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database | -r] database-name

Specifies the database.

[--attribute] key

Specifies the attribute name.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

list-search-database-attributes

Description

Lists a database's attributes.

Syntax

Long Format

psadmin list-search-database-attributes --searchserver search-server-ID --adminuser uid --passwordfile password-filename --database database-name [--debug] [--output output-filename] [--verbose]

Short Format

psadmin list-search-db-attributes -s search-server-ID -u uid -f password-filename -r database-name [--debug] [--output output-filename] [-v]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database | -r] database-name

Specifies the database.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

set-search-database-attribute

Description

Lists the attributes for a database.

Syntax

Long Format

psadmin set-search-database-attribute --searchserver search-server-ID --adminuser uid --passwordfile password-filename --database database-name --attribute key --value value [--debug] [--output output-filename] [--verbose]

Short Format

psadmin set-search-db-attribute -s search-server-ID -u uid -f password-filename -r database-name --attribute key --value value [--debug] [--output output-filename] [-v]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database | -r] database-name

Specifies the database.

[--attribute] key

Specifies the attribute name.

[--value] value

Specifies the attribute value.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.