com.facebook.presto.thrift.api.connector

Interface PrestoThriftService

@ThriftService(value="presto",
               idlName="PrestoThriftService")
public interface PrestoThriftService

Presto Thrift service definition. This thrift service needs to be implemented in order to be used with Thrift Connector.

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<PrestoThriftSplitBatch>	getIndexSplits(PrestoThriftSchemaTableName schemaTableName, List<String> indexColumnNames, List<String> outputColumnNames, PrestoThriftPageResult keys, PrestoThriftTupleDomain outputConstraint, int maxSplitCount, PrestoThriftNullableToken nextToken) Returns a batch of index splits for the given batch of keys.
com.google.common.util.concurrent.ListenableFuture<PrestoThriftPageResult>	getRows(PrestoThriftId splitId, List<String> columns, long maxBytes, PrestoThriftNullableToken nextToken) Returns a batch of rows for the given split.
com.google.common.util.concurrent.ListenableFuture<PrestoThriftSplitBatch>	getSplits(PrestoThriftSchemaTableName schemaTableName, PrestoThriftNullableColumnSet desiredColumns, PrestoThriftTupleDomain outputConstraint, int maxSplitCount, PrestoThriftNullableToken nextToken) Returns a batch of splits.
PrestoThriftNullableTableMetadata	getTableMetadata(PrestoThriftSchemaTableName schemaTableName) Returns metadata for a given table.
List<String>	listSchemaNames() Returns available schema names.
List<PrestoThriftSchemaTableName>	listTables(PrestoThriftNullableSchemaName schemaNameOrNull) Returns tables for the given schema name.

Method Detail

listSchemaNames

@ThriftMethod(value="prestoListSchemaNames")
List<String> listSchemaNames()
                                                                   throws PrestoThriftServiceException,
                                                                          com.facebook.drift.TException

Returns available schema names.

Throws:

PrestoThriftServiceException

com.facebook.drift.TException

listTables

@ThriftMethod(value="prestoListTables")
List<PrestoThriftSchemaTableName> listTables(@ThriftField(name="schemaNameOrNull")
                                                                                     PrestoThriftNullableSchemaName schemaNameOrNull)
                                                                              throws PrestoThriftServiceException,
                                                                                     com.facebook.drift.TException

Returns tables for the given schema name.

Parameters:

schemaNameOrNull - a structure containing schema name or null

Returns:

a list of table names with corresponding schemas. If schema name is null then returns a list of tables for all schemas. Returns an empty list if a schema does not exist

Throws:

PrestoThriftServiceException

com.facebook.drift.TException

getTableMetadata

@ThriftMethod(value="prestoGetTableMetadata")
PrestoThriftNullableTableMetadata getTableMetadata(@ThriftField(name="schemaTableName")
                                                                                                 PrestoThriftSchemaTableName schemaTableName)
                                                                                          throws PrestoThriftServiceException,
                                                                                                 com.facebook.drift.TException

Returns metadata for a given table.

Parameters:

schemaTableName - schema and table name

Returns:

metadata for a given table, or a null value inside if it does not exist

Throws:

PrestoThriftServiceException

com.facebook.drift.TException

getSplits

@ThriftMethod(value="prestoGetSplits",
              exception=@ThriftException(type=PrestoThriftServiceException.class,id=1))
com.google.common.util.concurrent.ListenableFuture<PrestoThriftSplitBatch> getSplits(@ThriftField(name="schemaTableName")
                                                                                                                                                                                                                    PrestoThriftSchemaTableName schemaTableName,
                                                                                                                                                                                                                    @ThriftField(name="desiredColumns")
                                                                                                                                                                                                                    PrestoThriftNullableColumnSet desiredColumns,
                                                                                                                                                                                                                    @ThriftField(name="outputConstraint")
                                                                                                                                                                                                                    PrestoThriftTupleDomain outputConstraint,
                                                                                                                                                                                                                    @ThriftField(name="maxSplitCount")
                                                                                                                                                                                                                    int maxSplitCount,
                                                                                                                                                                                                                    @ThriftField(name="nextToken")
                                                                                                                                                                                                                    PrestoThriftNullableToken nextToken)

Returns a batch of splits.

Parameters:

schemaTableName - schema and table name

desiredColumns - a superset of columns to return; empty set means "no columns", null set means "all columns"

outputConstraint - constraint on the returned data

maxSplitCount - maximum number of splits to return

nextToken - token from a previous split batch or null if it is the first call

Returns:

a batch of splits

getIndexSplits

@ThriftMethod(value="prestoGetIndexSplits",
              exception=@ThriftException(type=PrestoThriftServiceException.class,id=1))
com.google.common.util.concurrent.ListenableFuture<PrestoThriftSplitBatch> getIndexSplits(@ThriftField(name="schemaTableName")
                                                                                                                                                                                                                              PrestoThriftSchemaTableName schemaTableName,
                                                                                                                                                                                                                              @ThriftField(name="indexColumnNames")
                                                                                                                                                                                                                              List<String> indexColumnNames,
                                                                                                                                                                                                                              @ThriftField(name="outputColumnNames")
                                                                                                                                                                                                                              List<String> outputColumnNames,
                                                                                                                                                                                                                              @ThriftField(name="keys")
                                                                                                                                                                                                                              PrestoThriftPageResult keys,
                                                                                                                                                                                                                              @ThriftField(name="outputConstraint")
                                                                                                                                                                                                                              PrestoThriftTupleDomain outputConstraint,
                                                                                                                                                                                                                              @ThriftField(name="maxSplitCount")
                                                                                                                                                                                                                              int maxSplitCount,
                                                                                                                                                                                                                              @ThriftField(name="nextToken")
                                                                                                                                                                                                                              PrestoThriftNullableToken nextToken)

Returns a batch of index splits for the given batch of keys. This method is called if index join strategy is chosen for a query.

Parameters:

schemaTableName - schema and table name

indexColumnNames - specifies columns and their order for keys

outputColumnNames - a list of column names to return

keys - keys for which records need to be returned; includes only unique and non-null values

outputConstraint - constraint on the returned data

maxSplitCount - maximum number of splits to return

nextToken - token from a previous split batch or null if it is the first call

Returns:

a batch of splits

getRows

@ThriftMethod(value="prestoGetRows",
              exception=@ThriftException(type=PrestoThriftServiceException.class,id=1))
com.google.common.util.concurrent.ListenableFuture<PrestoThriftPageResult> getRows(@ThriftField(name="splitId")
                                                                                                                                                                                                                PrestoThriftId splitId,
                                                                                                                                                                                                                @ThriftField(name="columns")
                                                                                                                                                                                                                List<String> columns,
                                                                                                                                                                                                                @ThriftField(name="maxBytes")
                                                                                                                                                                                                                long maxBytes,
                                                                                                                                                                                                                @ThriftField(name="nextToken")
                                                                                                                                                                                                                PrestoThriftNullableToken nextToken)

Returns a batch of rows for the given split.

Parameters:

splitId - split id as returned in split batch

columns - a list of column names to return

maxBytes - maximum size of returned data in bytes

nextToken - token from a previous batch or null if it is the first call

Returns:

a batch of table data