Package org.apache.pinot.server.api.resources

Class TablesResource

java.lang.Object

org.apache.pinot.server.api.resources.TablesResource

@Path("/")
public class TablesResource
extends Object

Constructor Summary

Constructors

Constructor	Description
TablesResource()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	downloadSegment(String tableNameWithType, String segmentName, javax.ws.rs.core.HttpHeaders httpHeaders)
List<SegmentConsumerInfo>	getConsumingSegmentsInfo(String realtimeTableName)
String	getCrcMetadataForTable(String tableName)
String	getSegmentMetadata(String tableName, String segmentName, List<String> columns)
String	getSegmentMetadata(String tableName, List<String> columns)
String	listTables()
String	listTableSegments(String tableName)
String	uploadLLCSegment(String realtimeTableName, String segmentName)	Upload a low level consumer segment to segment store and return the segment download url.
TableSegmentValidationInfo	validateTableSegmentState(String tableNameWithType)

Methods inherited from class java.lang.Object

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

Constructor Detail

TablesResource

public TablesResource()

Method Detail

listTables

@GET
@Path("/tables")
@Produces("application/json")
public String listTables()

listTableSegments

@GET
@Path("/tables/{tableName}/segments")
@Produces("application/json")
public String listTableSegments(@PathParam("tableName")
                                String tableName)

getSegmentMetadata

@GET
@Encoded
@Produces("application/json")
@Path("/tables/{tableName}/metadata")
public String getSegmentMetadata(@PathParam("tableName")
                                 String tableName,
                                 @QueryParam("columns") @DefaultValue("")
                                 List<String> columns)
                          throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

getSegmentMetadata

@GET
@Encoded
@Path("/tables/{tableName}/segments/{segmentName}/metadata")
@Produces("application/json")
public String getSegmentMetadata(@PathParam("tableName")
                                 String tableName,
                                 @PathParam("segmentName")
                                 String segmentName,
                                 @QueryParam("columns") @DefaultValue("")
                                 List<String> columns)

getCrcMetadataForTable

@GET
@Path("/tables/{tableName}/segments/crc")
@Produces("application/json")
public String getCrcMetadataForTable(@PathParam("tableName")
                                     String tableName)

downloadSegment

@GET
@Produces("application/octet-stream")
@Path("/segments/{tableNameWithType}/{segmentName}")
public javax.ws.rs.core.Response downloadSegment(@PathParam("tableNameWithType")
                                                 String tableNameWithType,
                                                 @PathParam("segmentName") @Encoded
                                                 String segmentName,
                                                 @Context
                                                 javax.ws.rs.core.HttpHeaders httpHeaders)
                                          throws Exception

Throws:

Exception

uploadLLCSegment

@POST
@Path("/segments/{realtimeTableName}/{segmentName}/upload")
@Produces("application/json")
public String uploadLLCSegment(@PathParam("realtimeTableName")
                               String realtimeTableName,
                               @PathParam("segmentName")
                               String segmentName)
                        throws Exception

Upload a low level consumer segment to segment store and return the segment download url. This endpoint is used when segment store copy is unavailable for committed low level consumer segments. Please note that invocation of this endpoint may cause query performance to suffer, since we tar up the segment to upload it.

Throws:

Exception

See Also:

href="https://tinyurl.com/f63ru4sb

getConsumingSegmentsInfo

@GET
@Path("tables/{realtimeTableName}/consumingSegmentsInfo")
@Produces("application/json")
public List<SegmentConsumerInfo> getConsumingSegmentsInfo(@PathParam("realtimeTableName")
                                                          String realtimeTableName)

validateTableSegmentState

@GET
@Path("tables/{tableNameWithType}/allSegmentsLoaded")
@Produces("application/json")
public TableSegmentValidationInfo validateTableSegmentState(@PathParam("tableNameWithType")
                                                            String tableNameWithType)