Set-SPEnterpriseSearchCrawlDatabase

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Sets properties of a crawl database for a search service application.

Syntax

Set-SPEnterpriseSearchCrawlDatabase [-Identity] <CrawlStorePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-Shared <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-SPEnterpriseSearchCrawlDatabase cmdlet sets properties of a specified crawl database for a search service application. A crawl database stores crawl history for a search service application.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.CrawlStorePipeBind

Specifies the crawl database to modify.

A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid CrawlStore object.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

Note

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

FailoverDatabaseServer

Optional

System.String

Specifies the server to be used for failover when SQL Server mirroring is used.

SearchApplication

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the name of the search application to which the crawl database applies.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object.

Shared

Optional

System.Management.Automation.SwitchParameter

Used to denote that the search crawl database is to be used for all crawls instead of dedicated to a specific set of hosts through host distribution.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Input Types

Return Types

Example

------------------EXAMPLE------------------

$searchApp = Get-SPEnterpriseSearchServiceApplication mySearchServiceApp
Set-SPEnterpriseSearchCrawlDatabase -Identity SearchApp_CrawlStore
-SearchApplication $searchApp -FailoverDatabaseServer \\failoverServer

This example sets the failover database server for the crawl database, SearchApp_CrawlStore, to the \\failoverServer server.