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
---+ Basic Search
The basic search allows you to query using typename of an entity, associated classification/tag
and has support for filtering on the entity attribute(s) as well as the classification/tag attributes.
The entire query structure can be represented using the following JSON structure (called !SearchParameters)
<verbatim>
{
"typeName": "hive_table",
"excludeDeletedEntities": true,
"classification" : "",
"query": "",
"limit": 25,
"offset": 0,
"entityFilters": {
"attributeName": "name",
"operator": "contains",
"attributeValue": "testtable"
},
"tagFilters": null,
"attributes": [""]
}
</verbatim>
__Field description__
* typeName: The type of entity to look for
* excludeDeletedEntities: Should the search include deleted entities too (default: true)
* classification: Only include entities with given Classification/tag
* query: Any free text occurrence that the entity should have (generic/wildcard queries might be slow)
* limit: Max number of results to fetch
* offset: Starting offset of the result set (useful for pagination)
* entityFilters: Entity Attribute filter(s)
* tagFilters: Classification/tag Attribute filter(s)
* attributes: Attributes to include in the search result (default: include any attribute present in the filter)
Attribute based filtering can be done on multiple attributes with AND/OR condition.
*NOTE: The tagFilters and entityFilters field have same JSON structure.*
__Examples of filtering (for hive_table attributes)__
* Single attribute
<verbatim>
{
"typeName": "hive_table",
"excludeDeletedEntities": true,
"classification" : "",
"query": "",
"limit": 50,
"offset": 0,
"entityFilters": {
"attributeName": "name",
"operator": "contains",
"attributeValue": "testtable"
},
"tagFilters": null,
"attributes": [""]
}
</verbatim>
* Multi-attribute with OR
<verbatim>
{
"typeName": "hive_table",
"excludeDeletedEntities": true,
"classification" : "",
"query": "",
"limit": 50,
"offset": 0,
"entityFilters": {
"condition": "OR",
"criterion": [
{
"attributeName": "name",
"operator": "contains",
"attributeValue": "testtable"
},
{
"attributeName": "owner",
"operator": "eq",
"attributeValue": "admin"
}
]
},
"tagFilters": null,
"attributes": [""]
}
</verbatim>
* Multi-attribute with AND
<verbatim>
{
"typeName": "hive_table",
"excludeDeletedEntities": true,
"classification" : "",
"query": "",
"limit": 50,
"offset": 0,
"entityFilters": {
"condition": "AND",
"criterion": [
{
"attributeName": "name",
"operator": "contains",
"attributeValue": "testtable"
},
{
"attributeName": "owner",
"operator": "eq",
"attributeValue": "admin"
}
]
},
"tagFilters": null,
"attributes": [""]
}
</verbatim>
__Supported operators for filtering__
* LT (symbols: <, lt) works with Numeric, Date attributes
* GT (symbols: >, gt) works with Numeric, Date attributes
* LTE (symbols: <=, lte) works with Numeric, Date attributes
* GTE (symbols: >=, gte) works with Numeric, Date attributes
* EQ (symbols: eq, =) works with Numeric, Date, String attributes
* NEQ (symbols: neq, !=) works with Numeric, Date, String attributes
* LIKE (symbols: like, LIKE) works with String attributes
* STARTS_WITH (symbols: startsWith, STARTSWITH) works with String attributes
* ENDS_WITH (symbols: endsWith, ENDSWITH) works with String attributes
* CONTAINS (symbols: contains, CONTAINS) works with String attributes
__CURL Samples__
<verbatim>
curl -sivk -g
-u <user>:<password>
-X POST
-d '{
"typeName": "hive_table",
"excludeDeletedEntities": true,
"classification" : "",
"query": "",
"limit": 50,
"offset": 0,
"entityFilters": {
"condition": "AND",
"criterion": [
{
"attributeName": "name",
"operator": "contains",
"attributeValue": "testtable"
},
{
"attributeName": "owner",
"operator": "eq",
"attributeValue": "admin"
}
]
},
"tagFilters": null,
"attributes": [""]
}'
<protocol>://<atlas_host>:<atlas_port>/api/atlas/v2/search/basic
</verbatim>