sp_text_dump_database

Description

Makes a backup copy of a text index.

Syntax

sp_text_dump_database backupdbs [, current_to] [, 
     current_with] [, current_stripe01 [, ... [, 
     current_stripe31]]] [, textdb_to] [, textdb_with] [, 
     textdb_stripe01 [, ... [, textdb_stripe31]]]

Parameters

backupdbs: specifies whether the current database and the text_db database are backed up before the text index is backed up. Valid values are:

CURRENT_DB_AND_INDEXES – indicates that the current database is backed up before the text indexes are backed up.

CURRENT_DB_AND_CURRENT_INDEXES – indicates that the current database is backed up before the text indexes are backed up, and only the indexes associated with the current database are dumped.

TEXT_DB_AND_INDEXES – indicates that the text_db database is backed up before the text indexes are backed up.

INDEXES_AND_DATABASES – indicates that the current and text_db databases are backed up before the text indexes are backed up.

ONLY_INDEXES – indicates that only the text indexes are backed up.

current_to: is the to clause of the dump database command for dumping the current database. Use this only if you specify CURRENT_DB_AND_INDEXES or INDEXES_AND_DATABASES for the backupdbs parameter.

current_with: is the with clause of the dump database command for dumping the current database. Use this only if you specify CURRENT_DB_AND_INDEXES or INDEXES_AND_DATABASES for the backupdbs parameter.

current_stripe: is the stripe clause of the dump database command for dumping the current database. Use this only if you specify CURRENT_DB_AND_INDEXES or INDEXES_AND_DATABASES for the backupdbs parameter.

textdb_to: is the to clause of the dump database command for dumping the text_db database. Use this only if you specify INDEXES_AND_DATABASES for the backupdbs parameter. Use this only if you specify TEXT_DB_AND_INDEXES or INDEXES_AND_DATABASES for the backupdbs parameter.

textdb_with: is the with clause of the dump database command for dumping the text_db database. Use this only if you specify TEXT_DB_AND_INDEXES or INDEXES_AND_DATABASES for the backupdbs parameter.

textdb_stripe: is the stripe clause of the dump database command for dumping the text_db database. Use this only if you specify TEXT_DB_AND_INDEXES or INDEXES_AND_DATABASES for the backupdbs parameter.

Examples

Example 1

Only text indexes are backed up:

sp_text_dump_database ONLY_INDEXES

Example 2

The current database is dumped to /data/db1backup before the text indexes are backed up:

sp_text_dump_database CURRENT_DB_AND_INDEXES, "to '/data/db1backup'"

Example 3

The text_db database is dumped to /data/textdbbackup before the text indexes are backed up:

sp_text_dump_database @backkupdbs = "TEXT_DB_AND_INDEXES", 
@textdb_to = "to '/data/textdbbackup'"

Example 4

The current database is dumped to /data/db1backup and the text_db database is dumped to /data/textdbbackup before the text indexes are backed up:

sp_text_dump_database @backupdbs = "INDEXES_AND_DATABASES", 
@current_to = "to '/data/db1backup'", 
@textdb_to = "to '/data/textdbbackup'"

Usage

The Enhanced Full-Text Search engine concatenates the values of current_to, current_with, and current_stripe01 to current_stripe31 to dump database currentdbname and then executes the dump database command. The output from the execution of the dump database command is sent to the Enhanced Full-Text Search error log.
The Enhanced Full-Text Search engine concatenates the values of textdb_to, textdb_with, and textdb_stripe01 to textdb_stripe31 to the string “dump database currentdbname” and then executes the dump database command. The output from the execution of the dump database command is sent to the Enhanced Full-Text Search error log.
All entries in the text_events table that have a “processed” status in the current database are deleted when all indexes have been backed up.
The backup files for the Verity collections are stored in the directory specified in the backDir configuration parameter.
See references to the configuration parameter backCmd for customizing backups.

Messages

The parameter value ‘value’ is invalid.
Server name ‘server’ does not exist in sysservers.
Attempt to dump database ‘database_name’ failed – use the dump database command.
Attempt to backup text indexes on server ’server_name’ failed.
Attempt to clean text_events in database ‘database_name’ failed (date = ’date’).
Parameter ’parameter_name’ is required when dumping database ‘database_name’.
Dumping database ’database_name’ – check Full Text Search SDS error log for status.

Permissions

Any user can execute sp_text_dump_database.