New-SPEnterpriseSearchCrawlDatabase
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard | SharePoint Foundation 2013
Creates a crawl database which can be added to a search service application.
New-SPEnterpriseSearchCrawlDatabase -DatabaseName <String> -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| DatabaseName | Required | System.String | Specifies the name of the database to create for the crawl database. The type must be a valid name of a SQL Server database; for example, CrawlStoreDB1. | ||
| SearchApplication | Required | Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind | Specifies the search application that contains the crawl database. 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. | ||
| 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.
| ||
| 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 | ||
| DatabasePassword | Optional | System.String | Specifies the name of the password for the Microsoft SQL Server database server. | ||
| DatabaseServer | Optional | System.String | Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SQLServerHost1. | ||
| DatabaseUsername | Optional | System.String | Specifies the account name specified in the Database Server parameter. | ||
| FailoverDatabaseServer | Optional | System.String | Server that is used for failover when SQL Server mirroring is used. | ||
| 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 |
Detailed Description
The New-SPEnterpriseSearchCrawlDatabase cmdlet is used during initial configuration and farm scale-out to create a new crawl database, which can be added to a search service application. A crawl database stores crawl history for a search application.
Input Types
Return Types
| Exceptions | Description |
|---|---|
------------------EXAMPLE------------------
$searchApp = Get-SPEnterpriseSearchServiceApplication mySearchServiceAppNew-SPEnterpriseSearchCrawlDatabase -SearchApplication $searchApp -DatabaseName newCrawlDB
This example creates a new crawl database named newCrawlDB for the mySearchServiceApp search service application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: