1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
# Document Indexes
## Overview
An index can be thought of as a collection of _Documents_, and represents the largest granularity of data grouping in the store.
The first step in persisting documents via the _Search Data Service_ is to create the _Index_ into which we will put the documents.
This is where we define the structure of the _Documents_ that we will be storing in our _Index_, including how we want the data in our documents to be analyzed and indexed so that they can be queried for in interesting and useful ways.
## Syntax
When we create an _Index_ we need to define the structure of the _Documents_ that we will be storing in it. Specifically, we must enumerate the _Fields_ that make up the _Document_, the type of data we expect to be stored in each _Field_, and how we want that data to be indexed by the back end document store.
We express this as a JSON structure, enumerating the _Fields_ in our document, where each _Field_ is expressed as a JSON object which conforms to the following schema:
{
"name": {"type": "string" },
"data-type": {"type": "string" },
"format": {"type": "string" },
"searchable": {"type": "boolean"},
"search-analyzer": {"type": "string" },
"index-analyzer": {"type": "string" }
}
Where,
name = An arbitrary label to assign to the _Index_
data-type = One of: string, date, long, double, boolean, ip, or nested*
format = For 'date' type fields, the date format string to use when persisting the field.
searchable = true - field will be indexed,
false - field will not be indexed
search-analyzer = Default analyzer to use for queries if one is not specified as part of the query
One of: whitespace or ngram.
index-analyser = Analyzer to use for this field when indexing documents being persisted to the Index
One of: whitespace or ngram.
\* **Nested** fields:
If the _data-type_ is specified as _nested_, then this indicates that the contents of the field is itself a set of document fields. In this case, the _Field_ definition should contain an additional entry named _sub-fields_, which is a JSON array containing the definitions of the sub-fields.
**Example - A simple document definition which includes a 'date' type field.**
_Take note of the following:_
* For our 'BirthDate' field, which is a date, we also specify the format string to use when storing the field's contents.
{
"fields": [
{"name": "FirstName", "data-type": "string"},
{"name": "LastName", "data-type": "string"},
{"name": "BirthDate", "data-type": "date", "format": "MMM d y HH:m:s"}
]
}
**Example - An example document definition containing nested sub-fields.**
_Take note of the following:_
* It is perfectly valid for a nested field to itself contain nested fields
* For the _Tracks.Title_ field, we are specifying that the _whitespace_ analyzer should be applied for both indexing and queries.
{
"fields": [
{"name": "Album", "data-type": "string"},
{"name": "Group", "data-type": "string"},
{"name": "Tracks", "data-type": "nested", "sub-fields": [
{"name": "Title", "data-type": "string", "index-analyzer": "whitespace", "search-analyzer": "whitespace"},
{"name": "Length", "data-type": "long"}
]},
{"name": "BandMembers", "data-type": "nested", "sub-fields": [
{"name": "FirstName", "data-type": "string"},
{"name": "LastName", "data-type": "string"},
{"name": "Address", "data-type": "nested", "sub-fields": [
{"name": "Street", "data-type": "string"},
{"name": "City", "data-type": "string"},
{"name": "Country", "data-type": "string"}
]}
]}
]
}
## API
### Create Index
Define a new _Index_ in the _Search Data Service_.
---
**URL**
https://{host}:9509/services/search-data-service/v1/search/indexes/{index}/
**Method**
PUT
**URL Params**
index - The name to assign to the document index we are creating.
**Request Header**
Accept = application/json
X-TransactionId = Unique id set by client (for logging purposes)
X-FromAppId = Application identifier (for logging purposes)
Content-Type = application/json
**Request Payload**
JSON format document structure for this index (see Syntax Section)
**Success Response**
Code: 201
Header(s): None
Body: JSON structure containing the URL for the created Index
Example:
{"url": "indexes/myindex"}
**Error Response**
400 - Bad Request
403 - Unauthorized
500 - Internal Error
---
### Delete Index
Remove an existing _Index_ from the _Search Data Service_.
Note that this results in the removal of all _Documents_ that are stored in the _Index_ at the time that the DELETE operation occurs.
---
**URL**
https://{host}:9509/services/search-data-service/v1/search/indexes/{index}/
**Method**
DELETE
**URL Params**
index - The name to assign to the document index we are creating.
**Request Header**
Accept = application/json
X-TransactionId = Unique id set by client (for logging purposes)
X-FromAppId = Application identifier (for logging purposes)
Content-Type = application/json
**Request Payload**
None
**Success Response**
Code: 201
Header(s): None
Body: JSON structure containing the URL for the created Index
Example:
{"url": "indexes/myindex"}
**Error Response**
400 - Bad Request
403 - Unauthorized
500 - Internal Error
---
|
