Skip to content

Commit 604aa43

Browse files
jeff-allen-mongojeff-allen-mongo
authored
(DOCSP-33442): Add new fields to listSearchIndexes output (#4887) (#5025)
* WIP * (DOCSP-33442): Add new fields to listSearchIndexes output * add line breaks to field names * add more info link for statuses * edits * typo * change examples * wording * edits * standardization * typo * wording * add possible statuses for synonyms * address review comments * simplify * typo * standardize object vs document * WIP * fix build errors * add table heading * add synonym detail link * edit fields * update examples with real output * add multi doc example * add staged index to output * better pretty printing in output docs * tweak * add version-added * Evan review edits * formatting * edits
1 parent 0f95819 commit 604aa43

File tree

8 files changed

+729
-128
lines changed

8 files changed

+729
-128
lines changed

‎source/includes/atlas-search-commands/command-output/examples/multi-doc-example-output.rst

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
.. code-block:: javascript
2+
:copyable: false
3+
4+
[
5+
{
6+
id: '6524096020da840844a4c4a7',
7+
name: 'default',
8+
status: 'BUILDING',
9+
queryable: true,
10+
latestDefinitionVersion: {
11+
version: 2,
12+
createdAt: ISODate("2023-10-09T14:51:57.355Z")
13+
},
14+
latestDefinition: {
15+
mappings: { dynamic: true },
16+
storedSource: { include: [ 'awards.text' ] }
17+
},
18+
statusDetail: [
19+
{
20+
hostname: 'atlas-n1cm1j-shard-00-02',
21+
status: 'BUILDING',
22+
queryable: true,
23+
mainIndex: {
24+
status: 'READY',
25+
queryable: true,
26+
definitionVersion: {
27+
version: 0,
28+
createdAt: ISODate("2023-10-09T14:08:32.000Z")
29+
},
30+
definition: { mappings: { dynamic: true, fields: {} } }
31+
},
32+
stagedIndex: {
33+
status: 'PENDING',
34+
queryable: false,
35+
definitionVersion: {
36+
version: 1,
37+
createdAt: ISODate("2023-10-09T14:51:29.000Z")
38+
},
39+
definition: {
40+
mappings: { dynamic: true, fields: {} },
41+
storedSource: true
42+
}
43+
}
44+
},
45+
{
46+
hostname: 'atlas-n1cm1j-shard-00-01',
47+
status: 'BUILDING',
48+
queryable: true,
49+
mainIndex: {
50+
status: 'READY',
51+
queryable: true,
52+
definitionVersion: {
53+
version: 0,
54+
createdAt: ISODate("2023-10-09T14:08:32.000Z")
55+
},
56+
definition: { mappings: { dynamic: true, fields: {} } }
57+
},
58+
stagedIndex: {
59+
status: 'PENDING',
60+
queryable: false,
61+
definitionVersion: {
62+
version: 1,
63+
createdAt: ISODate("2023-10-09T14:51:29.000Z")
64+
},
65+
definition: {
66+
mappings: { dynamic: true, fields: {} },
67+
storedSource: true
68+
}
69+
}
70+
},
71+
{
72+
hostname: 'atlas-n1cm1j-shard-00-00',
73+
status: 'BUILDING',
74+
queryable: true,
75+
mainIndex: {
76+
status: 'READY',
77+
queryable: true,
78+
definitionVersion: {
79+
version: 0,
80+
createdAt: ISODate("2023-10-09T14:08:32.000Z")
81+
},
82+
definition: { mappings: { dynamic: true, fields: {} } }
83+
}
84+
}
85+
]
86+
},
87+
{
88+
id: '65240be420da840844a4d077',
89+
name: 'synonym_mappings',
90+
status: 'READY',
91+
queryable: true,
92+
latestDefinitionVersion: {
93+
version: 0,
94+
createdAt: ISODate("2023-10-09T14:19:16.305Z")
95+
},
96+
latestDefinition: {
97+
mappings: {
98+
dynamic: true,
99+
fields: {
100+
fullplot: { type: 'string' }
101+
}
102+
},
103+
synonyms: [
104+
{
105+
name: 'synonym_mapping',
106+
analyzer: 'lucene.english',
107+
source: { collection: 'synonyms' }
108+
}
109+
]
110+
},
111+
synonymMappingStatus: 'READY',
112+
synonymMappingStatusDetail: [
113+
{
114+
synonym_mapping: {
115+
status: 'READY',
116+
queryable: true
117+
}
118+
}
119+
],
120+
statusDetail: [
121+
{
122+
hostname: 'atlas-n1cm1j-shard-00-02',
123+
status: 'READY',
124+
queryable: true,
125+
mainIndex: {
126+
status: 'READY',
127+
queryable: true,
128+
definitionVersion: {
129+
version: 0,
130+
createdAt: ISODate("2023-10-09T14:19:16.000Z")
131+
},
132+
definition: {
133+
mappings: {
134+
dynamic: true,
135+
fields: {
136+
fullplot: {
137+
type: 'string',
138+
indexOptions: 'offsets',
139+
store: true,
140+
norms: 'include'
141+
}
142+
}
143+
},
144+
synonyms: [
145+
{
146+
name: 'synonym_mapping',
147+
analyzer: 'lucene.english',
148+
source: { collection: 'synonyms' }
149+
}
150+
]
151+
},
152+
synonymMappingStatus: 'READY',
153+
synonymMappingStatusDetail: [
154+
{
155+
synonym_mapping: {
156+
status: 'READY',
157+
queryable: true
158+
}
159+
}
160+
]
161+
}
162+
},
163+
{
164+
hostname: 'atlas-n1cm1j-shard-00-01',
165+
status: 'READY',
166+
queryable: true,
167+
mainIndex: {
168+
status: 'READY',
169+
queryable: true,
170+
definitionVersion: {
171+
version: 0,
172+
createdAt: ISODate("2023-10-09T14:19:16.000Z")
173+
},
174+
definition: {
175+
mappings: {
176+
dynamic: true,
177+
fields: {
178+
fullplot: {
179+
type: 'string',
180+
indexOptions: 'offsets',
181+
store: true,
182+
norms: 'include'
183+
}
184+
}
185+
},
186+
synonyms: [
187+
{
188+
name: 'synonym_mapping',
189+
analyzer: 'lucene.english',
190+
source: { collection: 'synonyms' }
191+
}
192+
]
193+
},
194+
synonymMappingStatus: 'READY',
195+
synonymMappingStatusDetail: [
196+
{
197+
synonym_mapping: {
198+
status: 'READY',
199+
queryable: true
200+
}
201+
}
202+
]
203+
}
204+
},
205+
{
206+
hostname: 'atlas-n1cm1j-shard-00-00',
207+
status: 'READY',
208+
queryable: true,
209+
mainIndex: {
210+
status: 'READY',
211+
queryable: true,
212+
definitionVersion: {
213+
version: 0,
214+
createdAt: ISODate("2023-10-09T14:19:16.000Z")
215+
},
216+
definition: {
217+
mappings: {
218+
dynamic: true,
219+
fields: {
220+
fullplot: {
221+
type: 'string',
222+
indexOptions: 'offsets',
223+
store: true,
224+
norms: 'include'
225+
}
226+
}
227+
},
228+
synonyms: [
229+
{
230+
name: 'synonym_mapping',
231+
analyzer: 'lucene.english',
232+
source: { collection: 'synonyms' }
233+
}
234+
]
235+
},
236+
synonymMappingStatus: 'READY',
237+
synonymMappingStatusDetail: [
238+
{
239+
synonym_mapping: {
240+
status: 'READY',
241+
queryable: true
242+
}
243+
}
244+
]
245+
}
246+
}
247+
]
248+
}
249+
]

‎source/includes/atlas-search-commands/command-output/examples/single-doc-default-example-output.rst

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
.. code-block:: javascript
2+
:copyable: false
3+
4+
[
5+
{
6+
id: '6524096020da840844a4c4a7',
7+
name: 'default',
8+
status: 'BUILDING',
9+
queryable: true,
10+
latestDefinitionVersion: {
11+
version: 2,
12+
createdAt: ISODate("2023-10-09T14:51:57.355Z")
13+
},
14+
latestDefinition: {
15+
mappings: { dynamic: true },
16+
storedSource: { include: [ 'awards.text' ] }
17+
},
18+
statusDetail: [
19+
{
20+
hostname: 'atlas-n1cm1j-shard-00-02',
21+
status: 'BUILDING',
22+
queryable: true,
23+
mainIndex: {
24+
status: 'READY',
25+
queryable: true,
26+
definitionVersion: {
27+
version: 0,
28+
createdAt: ISODate("2023-10-09T14:08:32.000Z")
29+
},
30+
definition: { mappings: { dynamic: true, fields: {} } }
31+
},
32+
stagedIndex: {
33+
status: 'PENDING',
34+
queryable: false,
35+
definitionVersion: {
36+
version: 1,
37+
createdAt: ISODate("2023-10-09T14:51:29.000Z")
38+
},
39+
definition: {
40+
mappings: { dynamic: true, fields: {} },
41+
storedSource: true
42+
}
43+
}
44+
},
45+
{
46+
hostname: 'atlas-n1cm1j-shard-00-01',
47+
status: 'BUILDING',
48+
queryable: true,
49+
mainIndex: {
50+
status: 'READY',
51+
queryable: true,
52+
definitionVersion: {
53+
version: 0,
54+
createdAt: ISODate("2023-10-09T14:08:32.000Z")
55+
},
56+
definition: { mappings: { dynamic: true, fields: {} } }
57+
},
58+
stagedIndex: {
59+
status: 'PENDING',
60+
queryable: false,
61+
definitionVersion: {
62+
version: 1,
63+
createdAt: ISODate("2023-10-09T14:51:29.000Z")
64+
},
65+
definition: {
66+
mappings: { dynamic: true, fields: {} },
67+
storedSource: true
68+
}
69+
}
70+
},
71+
{
72+
hostname: 'atlas-n1cm1j-shard-00-00',
73+
status: 'BUILDING',
74+
queryable: true,
75+
mainIndex: {
76+
status: 'READY',
77+
queryable: true,
78+
definitionVersion: {
79+
version: 0,
80+
createdAt: ISODate("2023-10-09T14:08:32.000Z")
81+
},
82+
definition: { mappings: { dynamic: true, fields: {} } }
83+
}
84+
}
85+
]
86+
}
87+
]

0 commit comments

Comments
 (0)