Get-SPEnterpriseSearchLinksDatabase

Retrieves a reference to a links database.

Syntax

Get-SPEnterpriseSearchLinksDatabase
   [[-Identity] <LinksStorePipeBind>]
   -SearchApplication <SearchServiceApplicationPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

The Get-SPEnterpriseSearchLinksDatabase cmdlet returns a LinksStore object for use during configuration and when a links database for a search service application is modified or deleted. A links database stores query logging and search analytics data for a search service application. If the Identity parameter is not specified, this cmdlet returns all links databases for the specified search application.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

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

C:\PS>$linksDatabase = Get-SPEnterpriseSearchLinksDatabase  -Identity LinksDB_1 -SearchApplication MySearchServiceApp

This example gets a reference to the links database LinksDB_1 from the search service application MySearchServiceApp.

Required Parameters

-SearchApplication

Specifies the search application that contains the links 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.

Type:SearchServiceApplicationPipeBind
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016

Optional Parameters

-AssignmentCollection

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.

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Identity

Specifies the links database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object.

Type:LinksStorePipeBind
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016