Get-SPEnterpriseSearchIndexPartition

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-04-14

Returns an index partition for a query topology.

Syntax

Get-SPEnterpriseSearchIndexPartition [[-Identity] <IndexPartitionPipeBind>] -QueryTopology <QueryTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-SearchApplication <SearchServiceApplicationPipeBind>]

Detailed Description

The Get-SPEnterpriseSearchIndexPartition cmdlet returns an index partition for a query topology. Index partitions define how document IDs are mapped to the query components for full-text user queries for a shared search application.

If the Identity parameter is not specified, this cmdlet returns the index partition collection for the specified query topology.

Parameters

Parameter Required Type Description

Identity

Optional

Microsoft.Office.Server.Search.Cmdlet.IndexPartitionPipeBind

Specifies the index partition to get.

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

QueryTopology

Required

Microsoft.Office.Server.Search.Cmdlet.QueryTopologyPipeBind

Specifies the query topology that contains the index partition 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

$searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" 
$qtopo = Get-SPEnterpriseSearchQueryTopology -SearchApplication $searchapp
$index = Get-SPEnterpriseSearchIndexPartition -QueryTopology $qtopo

This example retrieves an index partition for the only query topology in the search service application SearchApp1.