com.treasuredata.client

Interface TDClientApi<ClientImpl>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TDClient

public interface TDClientApi<ClientImpl>
extends AutoCloseable

Treasure Data Client API

Method Summary

Modifier and Type	Method and Description
ClientImpl	authenticate(String email, String password) Perform user email and password based authentication and return a new client that will use apikey based authentication.
void	commitBulkImportSession(String sessionName)
void	createBulkImportSession(String sessionName, String databaseName, String tableName)
void	createDatabase(String databaseName) Create a new database
void	createDatabaseIfNotExists(String databaseName)
void	createTable(String databaseName, String tableName) Create a new table
void	createTableIfNotExists(String databaseName, String tableName)
void	deleteBulkImportSession(String sessionName)
void	deleteDatabase(String databaseName) Delete a specified database.
void	deleteDatabaseIfExists(String databaseName)
void	deleteTable(String databaseName, String tableName)
void	deleteTableIfExists(String databaseName, String tableName)
boolean	existsDatabase(String databaseName)
boolean	existsTable(String databaseName, String table)
void	freezeBulkImportSession(String sessionName)
<Result> Result	getBulkImportErrorRecords(String sessionName, com.google.common.base.Function<InputStream,Result> resultStreamHandler)
TDBulkImportSession	getBulkImportSession(String sessionName)
TDJob	jobInfo(String jobId)
<Result> Result	jobResult(String jobId, TDResultFormat format, com.google.common.base.Function<InputStream,Result> resultStreamHandler) Open an input stream to retrieve the job result.
TDJobSummary	jobStatus(String jobId)
void	killJob(String jobId)
List<String>	listBulkImportParts(String sessionName)
List<TDBulkImportSession>	listBulkImportSessions()
List<String>	listDatabaseNames() Get the list of databases
List<TDDatabase>	listDatabases() Get the detailed information of databases
TDJobList	listJobs()
TDJobList	listJobs(long fromJobId, long toJobId)
List<TDTable>	listTables(String databaseName) Get the list of the tables in the specified database
TDPartialDeleteJob	partialDelete(String databaseName, String tableName, long from, long to)
void	performBulkImportSession(String sessionName)
void	performBulkImportSession(String sessionName, TDJob.Priority priority)
void	renameTable(String databaseName, String tableName, String newTableName)
void	renameTable(String databaseName, String tableName, String newTableName, boolean overwrite)
String	serverStatus()
String	startSavedQuery(String name, Date scheduledTime) Start a query saved on the cloud.
String	submit(TDJobRequest jobRequest) Submit a new job request
String	submitExportJob(TDExportJobRequest jobRequest) Start a table export job.
void	swapTables(String databaseName, String tableName1, String tableName2)
void	unfreezeBulkImportSession(String sessionName)
void	updateTableSchema(String databaseName, String tableName, List<TDColumn> newSchema)
void	uploadBulkImportPart(String sessionName, String uniquePartName, File path)
ClientImpl	withApiKey(String newApiKey) Return a TDClientApi implementation that uses the given api key.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

withApiKey

ClientImpl withApiKey(String newApiKey)

Return a TDClientApi implementation that uses the given api key. This instance will share the same internal http client, so closing the returned client will invalidate the current instance.

Parameters:

newApiKey -

Returns:

authenticate

ClientImpl authenticate(String email,
                        String password)

Perform user email and password based authentication and return a new client that will use apikey based authentication. Similary to withApiKey(String) method, closing the returned client will invalidate the current instance.

Parameters:

email -

password -

Returns:

serverStatus

String serverStatus()

listDatabaseNames

List<String> listDatabaseNames()

Get the list of databases

Returns:

list of databases

Throws:

TDClientException - if failed to retrieve the database list

listDatabases

List<TDDatabase> listDatabases()

Get the detailed information of databases

Returns:

list of TDDatabase

Throws:

TDClientException - if failed to retrieve the database list.

createDatabase

void createDatabase(String databaseName)

Create a new database

Parameters:

databaseName -

Throws:

TDClientException - if the specified database already exists

createDatabaseIfNotExists

void createDatabaseIfNotExists(String databaseName)

deleteDatabase

void deleteDatabase(String databaseName)

Delete a specified database. Deleting a database deletes all of its belonging tables.

Parameters:

databaseName -

Throws:

TDClientException - if no such a database exists

deleteDatabaseIfExists

void deleteDatabaseIfExists(String databaseName)

listTables

List<TDTable> listTables(String databaseName)

Get the list of the tables in the specified database

Parameters:

databaseName -

Returns:

Throws:

TDClientException

existsDatabase

boolean existsDatabase(String databaseName)

existsTable

boolean existsTable(String databaseName,
                    String table)

createTable

void createTable(String databaseName,
                 String tableName)

Create a new table

Parameters:

databaseName -

tableName -

Throws:

TDClientException

createTableIfNotExists

void createTableIfNotExists(String databaseName,
                            String tableName)

renameTable

void renameTable(String databaseName,
                 String tableName,
                 String newTableName)

renameTable

void renameTable(String databaseName,
                 String tableName,
                 String newTableName,
                 boolean overwrite)

deleteTable

void deleteTable(String databaseName,
                 String tableName)

deleteTableIfExists

void deleteTableIfExists(String databaseName,
                         String tableName)

partialDelete

TDPartialDeleteJob partialDelete(String databaseName,
                                 String tableName,
                                 long from,
                                 long to)

swapTables

void swapTables(String databaseName,
                String tableName1,
                String tableName2)

updateTableSchema

void updateTableSchema(String databaseName,
                       String tableName,
                       List<TDColumn> newSchema)

submit

String submit(TDJobRequest jobRequest)

Submit a new job request

Parameters:

jobRequest -

Returns:

job_id

Throws:

TDClientException

listJobs

TDJobList listJobs()

listJobs

TDJobList listJobs(long fromJobId,
                   long toJobId)

killJob

void killJob(String jobId)

jobStatus

TDJobSummary jobStatus(String jobId)

jobInfo

TDJob jobInfo(String jobId)

jobResult

<Result> Result jobResult(String jobId,
                          TDResultFormat format,
                          com.google.common.base.Function<InputStream,Result> resultStreamHandler)

Open an input stream to retrieve the job result. The input stream will be closed after this method

You will receive an empty stream if the query has not finished yet.

Parameters:

jobId -

format -

resultStreamHandler -

Returns:

listBulkImportSessions

List<TDBulkImportSession> listBulkImportSessions()

listBulkImportParts

List<String> listBulkImportParts(String sessionName)

createBulkImportSession

void createBulkImportSession(String sessionName,
                             String databaseName,
                             String tableName)

getBulkImportSession

TDBulkImportSession getBulkImportSession(String sessionName)

uploadBulkImportPart

void uploadBulkImportPart(String sessionName,
                          String uniquePartName,
                          File path)

freezeBulkImportSession

void freezeBulkImportSession(String sessionName)

unfreezeBulkImportSession

void unfreezeBulkImportSession(String sessionName)

performBulkImportSession

void performBulkImportSession(String sessionName)

performBulkImportSession

void performBulkImportSession(String sessionName,
                              TDJob.Priority priority)

commitBulkImportSession

void commitBulkImportSession(String sessionName)

deleteBulkImportSession

void deleteBulkImportSession(String sessionName)

getBulkImportErrorRecords

<Result> Result getBulkImportErrorRecords(String sessionName,
                                          com.google.common.base.Function<InputStream,Result> resultStreamHandler)

startSavedQuery

String startSavedQuery(String name,
                       Date scheduledTime)

Start a query saved on the cloud.

Parameters:

name - name of the saved query

scheduledTime - the return time of TD_SCHEDULED_TIME

Returns:

job id

submitExportJob

String submitExportJob(TDExportJobRequest jobRequest)

Start a table export job.

Parameters:

jobRequest -

Returns:

job id