Skip to content

Commit 21653d0

Browse files
michaellwestmichaellwest
committed
Updated documentation for SearchIndex commands.
1 parent 0a3167e commit 21653d0

9 files changed

+228
-146
lines changed

‎Documentation/Get-SearchIndex.ps1‎

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,64 @@
11
<#
22
.SYNOPSIS
3-
Returns sitecore Search indices.
3+
Returns the available Sitecore indexes.
44
55
.DESCRIPTION
6-
Returns sitecore Search indices.
6+
The Get-SearchIndex command returns the available Sitecore indexes. These are the same as those found in the Control Panel.
77
88
.PARAMETER Name
99
Name of the index to return.
1010
1111
.INPUTS
12+
None or System.String
1213
1314
.OUTPUTS
14-
Sitecore.Search.Index
15+
Sitecore.ContentSearch.ISearchIndex
1516
1617
.NOTES
1718
Help Author: Adam Najmanowicz, Michael West
1819
20+
.LINK
21+
Initialize-SearchIndex
22+
23+
.LINK
24+
Stop-SearchIndex
25+
26+
.LINK
27+
Resume-SearchIndex
28+
29+
.LINK
30+
Suspend-SearchIndex
31+
1932
.LINK
2033
https://github.com/SitecorePowerShell/Console/
2134
2235
.EXAMPLE
23-
PS master:\>Get-SearchIndex | ft -auto
24-
25-
Name Analyzer Directory
26-
---- -------- ---------
27-
system Lucene.Net.Analysis.Standard.StandardAnalyzer Lucene.Net.Store.SimpleFSDirectory@C:\Projects\ZenGarden\Data\indexes\__system lockFactory=Sitecore.Search.SitecoreLockFactory
28-
WeBlog Lucene.Net.Analysis.Standard.StandardAnalyzer Lucene.Net.Store.SimpleFSDirectory@C:\Projects\ZenGarden\Data\indexes\WeBlog lockFactory=Sitecore.Search.SitecoreLockFactory
36+
The following lists all available indexes.
37+
38+
PS master:\>Get-SearchIndex
39+
40+
Name IndexingState IsRebuilding IsSharded
41+
---- ------------- ------------ ---------
42+
sitecore_analytics_index Started False False
43+
sitecore_core_index Started False False
44+
sitecore_master_index Started True False
45+
sitecore_web_index Started False False
46+
sitecore_marketing_asset_inde... Started False False
47+
sitecore_marketing_asset_inde... Started False False
48+
sitecore_testing_index Started False False
49+
sitecore_suggested_test_index Started False False
50+
sitecore_fxm_master_index Started False False
51+
sitecore_fxm_web_index Started False False
52+
sitecore_list_index Started False False
53+
social_messages_master Started False False
54+
social_messages_web Started False False
55+
56+
.EXAMPLE
57+
The following lists only the specified index.
2958
59+
PS master:\>Get-SearchIndex -Name sitecore_master_index
60+
61+
Name IndexingState IsRebuilding IsSharded
62+
---- ------------- ------------ ---------
63+
sitecore_master_index Started True False
3064
#>

‎Documentation/Initialize-SearchIndex.TODO.ps1‎

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎Documentation/Initialize-SearchIndex.ps1‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<#
2+
.SYNOPSIS
3+
Rebuilds the Sitecore index.
4+
5+
.DESCRIPTION
6+
The Rebuild-SearchIndex command rebuilds Sitecore index. This command is an alias for Initialize-SearchIndex.
7+
8+
.PARAMETER Name
9+
The name of the index to resume.
10+
11+
.PARAMETER Index
12+
The index instance.
13+
14+
.PARAMETER IncludeRemoteIndex
15+
The remote indexing should be triggered.
16+
17+
.PARAMETER AsJob
18+
The job created for rebuilding the index should be returned as output.
19+
20+
.INPUTS
21+
None or Sitecore.Jobs.Job
22+
23+
.OUTPUTS
24+
None
25+
26+
.NOTES
27+
Help Author: Adam Najmanowicz, Michael West
28+
29+
.LINK
30+
Resume-SearchIndex
31+
32+
.LINK
33+
Suspend-SearchIndex
34+
35+
.LINK
36+
Stop-SearchIndex
37+
38+
.LINK
39+
Get-SearchIndex
40+
41+
.LINK
42+
https://github.com/SitecorePowerShell/Console/
43+
44+
.EXAMPLE
45+
The following rebuilds the index.
46+
47+
PS master:\> Rebuild-SearchIndex -Name sitecore_master_index
48+
49+
.EXAMPLE
50+
The following rebuilds the index.
51+
52+
PS master:\> Get-SearchIndex -Name sitecore_master_index | Rebuild-SearchIndex
53+
#>

‎Documentation/Resume-SearchIndex.TODO.ps1‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎Documentation/Resume-SearchIndex.ps1‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<#
2+
.SYNOPSIS
3+
Resumes the suspended (paused) Sitecore index.
4+
5+
.DESCRIPTION
6+
The Resume-SearchIndex command resumes the suspended (paused) Sitecore index.
7+
8+
.PARAMETER Name
9+
The name of the index to resume.
10+
11+
.INPUTS
12+
Sitecore.ContentSearch.ISearchIndex or System.String
13+
14+
.OUTPUTS
15+
None
16+
17+
.NOTES
18+
Help Author: Adam Najmanowicz, Michael West
19+
20+
.LINK
21+
Initialize-SearchIndex
22+
23+
.LINK
24+
Suspend-SearchIndex
25+
26+
.LINK
27+
Stop-SearchIndex
28+
29+
.LINK
30+
Get-SearchIndex
31+
32+
.LINK
33+
https://github.com/SitecorePowerShell/Console/
34+
35+
.EXAMPLE
36+
The following stops the indexing process from running.
37+
38+
PS master:\> Resume-SearchIndex -Name sitecore_master_index
39+
40+
.EXAMPLE
41+
The following stops the indexing process from running.
42+
43+
PS master:\> Get-SearchIndex -Name sitecore_master_index | Resume-SearchIndex
44+
#>

‎Documentation/Stop-SearchIndex.TODO.ps1‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎Documentation/Stop-SearchIndex.ps1‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<#
2+
.SYNOPSIS
3+
Stops the Sitecore index.
4+
5+
.DESCRIPTION
6+
The Stop-SearchIndex command stops the Sitecore index.
7+
8+
.PARAMETER Name
9+
The name of the index to stop.
10+
11+
.INPUTS
12+
Sitecore.ContentSearch.ISearchIndex or System.String
13+
14+
.OUTPUTS
15+
None
16+
17+
.NOTES
18+
Help Author: Adam Najmanowicz, Michael West
19+
20+
.LINK
21+
Initialize-SearchIndex
22+
23+
.LINK
24+
Suspend-SearchIndex
25+
26+
.LINK
27+
Resume-SearchIndex
28+
29+
.LINK
30+
Get-SearchIndex
31+
32+
.LINK
33+
https://github.com/SitecorePowerShell/Console/
34+
35+
.EXAMPLE
36+
The following stops the indexing process from running.
37+
38+
PS master:\> Stop-SearchIndex -Name sitecore_master_index
39+
40+
.EXAMPLE
41+
The following stops the indexing process from running.
42+
43+
PS master:\> Get-SearchIndex -Name sitecore_master_index | Stop-SearchIndex
44+
#>

‎Documentation/Suspend-SearchIndex.TODO.ps1‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)