Package org.openmetadata.service.resources.search

Class SearchResource

java.lang.Object

org.openmetadata.service.resources.search.SearchResource

@Path("/v1/search")
@Produces("application/json")
public class SearchResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELASTIC_SEARCH_ENTITY_FQN_STREAM

Constructor Summary

Constructors

Constructor	Description
SearchResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	aggregate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String index, String fieldName, String value, String query, int size, String deleted)
javax.ws.rs.core.Response	reindexAllJobLastStatus(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
javax.ws.rs.core.Response	search(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String query, String index, boolean deleted, int from, int size, String sortFieldParam, String sortOrder, boolean trackTotalHits, String queryFilter, String postFilter, boolean fetchSource, List<String> includeSourceFields)
javax.ws.rs.core.Response	searchByField(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldName, String fieldValue, String index)
javax.ws.rs.core.Response	searchBySourceUrl(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String sourceUrl)
javax.ws.rs.core.Response	suggest(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String query, String index, String fieldName, int size, boolean fetchSource, List<String> includeSourceFields, boolean deleted)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ELASTIC_SEARCH_ENTITY_FQN_STREAM

public static final String ELASTIC_SEARCH_ENTITY_FQN_STREAM

See Also:

• Constant Field Values

Constructor Details

SearchResource

public SearchResource(Authorizer authorizer)

Method Details

search

@GET
@Path("/query")
public javax.ws.rs.core.Response search(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @DefaultValue("*") @QueryParam("q")
 String query,
 @DefaultValue("table_search_index") @QueryParam("index")
 String index,
 @DefaultValue("false") @QueryParam("deleted") @Deprecated(forRemoval=true)
 boolean deleted,
 @DefaultValue("0") @QueryParam("from")
 int from,
 @DefaultValue("10") @QueryParam("size")
 int size,
 @DefaultValue("_score") @QueryParam("sort_field")
 String sortFieldParam,
 @DefaultValue("desc") @QueryParam("sort_order")
 String sortOrder,
 @DefaultValue("false") @QueryParam("track_total_hits")
 boolean trackTotalHits,
 @QueryParam("query_filter")
 String queryFilter,
 @QueryParam("post_filter")
 String postFilter,
 @DefaultValue("true") @QueryParam("fetch_source")
 boolean fetchSource,
 @QueryParam("include_source_fields")
 List<String> includeSourceFields)
                                 throws IOException

Throws:

IOException

searchByField

@GET
@Path("/fieldQuery")
public javax.ws.rs.core.Response searchByField(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fieldName")
 String fieldName,
 @QueryParam("fieldValue")
 String fieldValue,
 @DefaultValue("table_search_index") @QueryParam("index")
 String index)
                                        throws IOException

Throws:

IOException

searchBySourceUrl

@GET
@Path("/sourceUrl")
public javax.ws.rs.core.Response searchBySourceUrl(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("sourceUrl")
 String sourceUrl)
                                            throws IOException

Throws:

IOException

suggest

@GET
@Path("/suggest")
public javax.ws.rs.core.Response suggest(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("q")
 String query,
 @DefaultValue("table_search_index") @QueryParam("index")
 String index,
 @DefaultValue("suggest") @QueryParam("field")
 String fieldName,
 @DefaultValue("10") @QueryParam("size")
 int size,
 @DefaultValue("true") @QueryParam("fetch_source")
 boolean fetchSource,
 @QueryParam("include_source_fields")
 List<String> includeSourceFields,
 @DefaultValue("false") @QueryParam("deleted")
 boolean deleted)
                                  throws IOException

Throws:

IOException

aggregate

@GET
@Path("/aggregate")
public javax.ws.rs.core.Response aggregate(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @DefaultValue("table_search_index") @QueryParam("index")
 String index,
 @QueryParam("field")
 String fieldName,
 @DefaultValue("") @QueryParam("value")
 String value,
 @DefaultValue("*") @QueryParam("q")
 String query,
 @DefaultValue("10") @QueryParam("size")
 int size,
 @DefaultValue("false") @QueryParam("deleted")
 String deleted)
                                    throws IOException

Throws:

IOException

reindexAllJobLastStatus

@GET
@Path("/reindex/stream/status")
public javax.ws.rs.core.Response reindexAllJobLastStatus(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext)