Set-SPEnterpriseSearchQueryTopology

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Sets the properties of a query topology for a shared search application.

Syntax

Set-SPEnterpriseSearchQueryTopology [-Identity] <QueryTopologyPipeBind> [-Active <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-SPEnterpriseSearchQueryTopology cmdlet updates properties of a query topology. A topology can contain multiple query topologies when a query component or index partition is added to or deleted from a topology.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.QueryTopologyPipeBind

Specifies the query topology to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid QueryTopology object.

Active

Optional

System.Management.Automation.SwitchParameter

Activates the topology to assume handling queries. An active query topology is currently serving queries for the search application.

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

SearchApplication

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application that contains the query topology.

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.

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------------------

$ssi = Get-SPEnterpriseSearchServiceInstance
$ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA
$newQueryTopology = $ssa | New-SPEnterpriseSearchQueryTopology -Partitions 1
$ip = Get-SPEnterpriseSearchIndexPartition -QueryTopology $newQueryTopology
$queryComponent = New-SPEnterpriseSearchQuerycomponent -QueryTopology $newQueryTopology -IndexPartition $ip -SearchServiceInstance $ssi
$newQueryTopology | Set-SPEnterpriseSearchQueryTopology -Active

This example creates a new query topology and query component, adds the new query topology to a search service application and sets it as the active query topology.