Get-SPEnterpriseSearchQueryComponent

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Returns a query component.

Syntax

Get-SPEnterpriseSearchQueryComponent [[-Identity] <QueryComponentPipeBind>] -QueryTopology <QueryTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-SearchApplication <SearchServiceApplicationPipeBind>]

Detailed Description

The Get-SPEnterpriseSearchQueryComponent cmdlet reads a QueryComponent object when the query component is created, updated, or deleted.

If the Identity parameter is not specified, this cmdlet returns the query component collection from the specified query topology.

Parameters

Parameter Required Type Description

Identity

Optional

Microsoft.Office.Server.Search.Cmdlet.QueryComponentPipeBind

Specifies the query component to get.

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

QueryTopology

Required

Microsoft.Office.Server.Search.Cmdlet.QueryTopologyPipeBind

Specifies the query topology that contains the query component collection.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid QueryTopology 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.

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.

Input Types

Return Types

Example

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

$ssa =  Get-SPEnterpriseSearchServiceApplication -Identity "MySSA"
$ssa | Get-SPEnterpriseSearchQueryTopology -Active | Get-SPEnterpriseSearchQueryComponent

This example gets the collection of query components from the search application named MySSA.