Find-Item : Add support for custom SearchResultItem

[michaellwest]

In the current version, only SearchResultItem can be used. Would like to have a way to provide a custom class with custom properties.

Example of what should work:

Dynamic Query

class TitleSearchResultItem : SearchResultItem
{
   [Sitecore.ContentSearch.IndexField("title")]
   [string]$Title
}

$props = @{
    Index = "sitecore_master_index"
    Where = "Title.Contains(@0)"
    WhereValues = "great"
    QueryType = [TitleSearchResultItem]
}

Find-Item @props

Dynamic Query

class TemplatesSearchResultItem : SearchResultItem
{
   [Sitecore.ContentSearch.IndexField("_templates")]
   [System.Collections.Generic.List[ID]]$TemplateIds
}

$props = @{
    Index = "sitecore_master_index"
    Where = "Paths.Contains(@0) And TemplateIds.Contains(@1)"
    WhereValues = [ID]::Parse("{371EEE15-B6F3-423A-BB25-0B5CED860EEA}"), [ID]::Parse("{B0B6FB08-6BBE-43F2-8E36-FCE228325B63}")
    QueryType = [TemplatesSearchResultItem]
}

Find-Item @props

Scope Query

class TitleSearchResultItem : SearchResultItem
{
   [Sitecore.ContentSearch.IndexField("title")]
   [string]$Title
}

$props = @{
    Index = "sitecore_master_index"
    ScopeQuery = "location:{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9};custom:title|Sitecore"
    QueryType = [TitleSearchResultItem]
}

Find-Item @props | Select-Object -Property Title

Criteria

class TitleSearchResultItem : SearchResultItem
{
   [Sitecore.ContentSearch.IndexField("title")]
   [string]$Title
   [Sitecore.ContentSearch.IndexField("_creator")]
   [string]$Creator
}

$criteria = @(
    @{Filter = "Equals"; Field = "_templatename"; Value = "Sample Content"}, 
    @{Filter = "Contains"; Field = "Title"; Value = "Sitecore"},
    @{Filter = "Contains"; Field = "_creator"; Value = "admin"}
)
$props = @{
    Index = "sitecore_master_index"
    Criteria = $criteria
    QueryType = [TitleSearchResultItem]
}

Find-Item @props

Predicate

class TitleSearchResultItem : SearchResultItem
{
   [Sitecore.ContentSearch.IndexField("title")]
   [string]$Title
}

$criteriaTemplate = @{Filter = "Equals"; Field = "_templatename"; Value = "Template Field"; }, @{Filter = "Equals"; Field = "_templatename"; Value = "Sample Item"; Boost=25; }, @{Filter = "Equals"; Field = "_templatename"; Value = "Sample Content"; }
$predicateTemplate = New-SearchPredicate -Operation Or -Criteria $criteriaTemplate -QueryType ([TitleSearchResultItem])

$criteriaContent = @{Filter = "Contains"; Field = "Title"; Value = 'Sitecore'}
$predicateTitle = New-SearchPredicate -Criteria $criteriaContent -QueryType ([TitleSearchResultItem])

$predicateTemplateAndTitle = New-SearchPredicate -First $predicateTemplate -Second $predicateTitle -Operation And -QueryType ([TitleSearchResultItem])

$root = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
$criteriaRoot = @{Filter = "DescendantOf"; Value = $root }
$predicateRoot = New-SearchPredicate -Criteria $criteriaRoot -QueryType ([TitleSearchResultItem])

$predicate = New-SearchPredicate -First $predicateRoot -Second $predicateTemplateAndTitle -Operation And -QueryType ([TitleSearchResultItem])

$props = @{
    Index = "sitecore_master_index"
    Predicate = $predicate
    QueryType = [TitleSearchResultItem]
}

Find-Item @props

[michaellwest]

Supported scenarios:

• Criteria
• Predicate
• Scope Query
• Where Values

[AlexKasaku]

This is really nice!

[michaellwest]

Working with Predicate has proven more challenging. Will put that on the backburner for now.

[peplau]

I'll be watching this one closely ;)

http://blog.peplau.com.br/en_US/index-searching-find-item-using-custom-fields-with-sitecore-powershell/

[michaellwest]

@peplau I got the predicate working!

[peplau]

Wow! Where can I see the code? Implicit Generics rules! Em qui, 11 de jul de 2019 22:55, Michael <[email protected]> escreveu:

…

@peplau <https://github.com/peplau> I got the predicate working! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1120?email_source=notifications&email_token=ADI2TSFCSZSVSMM5RIRWHCLP67QCBA5CNFSM4H6N4SD2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZYOFZY#issuecomment-510714599>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ADI2TSGX6UETZIHEIZKMHN3P67QCBANCNFSM4H6N4SDQ> .

[michaellwest]

Probably should call out that when using Criteria the field names should be what's in the index. Using Dynamic the field names should match with the custom type.