com.treasuredata.client

Class TDClient

java.lang.Object

com.treasuredata.client.TDClient

All Implemented Interfaces:

TDClientApi<TDClient>, AutoCloseable

public class TDClient
extends Object
implements TDClientApi<TDClient>

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.base.Optional<String>	apiKeyCache
protected TDClientConfig	config
protected TDHttpClient	httpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
	TDClient(TDClientConfig config)
protected	TDClient(TDClientConfig config, TDHttpClient httpClient, com.google.common.base.Optional<String> apiKeyCache)

Method Summary

Modifier and Type	Method and Description
TDClient	authenticate(String email, String password) Perform user email and password based authentication and return a new client that will use apikey based authentication.
protected static String	buildUrl(String urlPrefix, String... args)
void	close()
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	deleteBulkImportPart(String sessionName, String uniquePartName)
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)
protected <ResultType> ResultType	doGet(String path, Class<ResultType> resultTypeClass)
protected String	doPost(String path)
protected <ResultType> ResultType	doPost(String path, Map<String,String> queryParam, Class<ResultType> resultTypeClass)
protected <ResultType> ResultType	doPost(String path, Map<String,String> queryParam, com.google.common.base.Optional<String> jsonBody, Class<ResultType> resultTypeClass)
protected String	doPut(String path, File filePath)
boolean	existsDatabase(String databaseName)
boolean	existsTable(String databaseName, String tableName)
void	freezeBulkImportSession(String sessionName)
<Result> Result	getBulkImportErrorRecords(String sessionName, com.google.common.base.Function<InputStream,Result> resultStreamHandler)
TDBulkImportSession	getBulkImportSession(String sessionName)
static String	getVersion()
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
static TDClientBuilder	newBuilder()
static TDClientBuilder	newBuilder(boolean loadTDConf)
static TDClient	newClient()
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)
TDClient	withApiKey(String newApiKey) Create a new TDClient that uses the given api key for the authentication.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final TDClientConfig config

httpClient

protected final TDHttpClient httpClient

apiKeyCache

protected final com.google.common.base.Optional<String> apiKeyCache

Constructor Detail

TDClient

public TDClient(TDClientConfig config)

TDClient

protected TDClient(TDClientConfig config,
                   TDHttpClient httpClient,
                   com.google.common.base.Optional<String> apiKeyCache)

Method Detail

getVersion

public static String getVersion()

newClient

public static TDClient newClient()

newBuilder

public static TDClientBuilder newBuilder()

newBuilder

public static TDClientBuilder newBuilder(boolean loadTDConf)

withApiKey

public TDClient withApiKey(String newApiKey)

Create a new TDClient that uses the given api key for the authentication. The new instance of TDClient shares the same HttpClient, so closing this will invalidate the other copy of TDClient instances

Specified by:

withApiKey in interface TDClientApi<TDClient>

Parameters:

newApiKey -

Returns:

close

public void close()

Specified by:

close in interface AutoCloseable

buildUrl

protected static String buildUrl(String urlPrefix,
                                 String... args)

doGet

protected <ResultType> ResultType doGet(String path,
                                        Class<ResultType> resultTypeClass)
                                 throws TDClientException

Throws:

TDClientException

doPost

protected <ResultType> ResultType doPost(String path,
                                         Map<String,String> queryParam,
                                         com.google.common.base.Optional<String> jsonBody,
                                         Class<ResultType> resultTypeClass)
                                  throws TDClientException

Throws:

TDClientException

doPost

protected <ResultType> ResultType doPost(String path,
                                         Map<String,String> queryParam,
                                         Class<ResultType> resultTypeClass)
                                  throws TDClientException

Throws:

TDClientException

doPost

protected String doPost(String path)
                 throws TDClientException

Throws:

TDClientException

doPut

protected String doPut(String path,
                       File filePath)
                throws TDClientException

Throws:

TDClientException

authenticate

public TDClient authenticate(String email,
                             String password)

Description copied from interface: TDClientApi

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

Specified by:

authenticate in interface TDClientApi<TDClient>

Returns:

serverStatus

public String serverStatus()

Specified by:

serverStatus in interface TDClientApi<TDClient>

listDatabaseNames

public List<String> listDatabaseNames()
                               throws TDClientException

Description copied from interface: TDClientApi

Get the list of databases

Specified by:

listDatabaseNames in interface TDClientApi<TDClient>

Returns:

list of databases

Throws:

TDClientException - if failed to retrieve the database list

listDatabases

public List<TDDatabase> listDatabases()
                               throws TDClientException

Description copied from interface: TDClientApi

Get the detailed information of databases

Specified by:

listDatabases in interface TDClientApi<TDClient>

Returns:

list of TDDatabase

Throws:

TDClientException - if failed to retrieve the database list.

createDatabase

public void createDatabase(String databaseName)
                    throws TDClientException

Description copied from interface: TDClientApi

Create a new database

Specified by:

createDatabase in interface TDClientApi<TDClient>

Throws:

TDClientException - if the specified database already exists

createDatabaseIfNotExists

public void createDatabaseIfNotExists(String databaseName)
                               throws TDClientException

Specified by:

createDatabaseIfNotExists in interface TDClientApi<TDClient>

Throws:

TDClientException

deleteDatabase

public void deleteDatabase(String databaseName)
                    throws TDClientException

Description copied from interface: TDClientApi

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

Specified by:

deleteDatabase in interface TDClientApi<TDClient>

Throws:

TDClientException - if no such a database exists

deleteDatabaseIfExists

public void deleteDatabaseIfExists(String databaseName)
                            throws TDClientException

Specified by:

deleteDatabaseIfExists in interface TDClientApi<TDClient>

Throws:

TDClientException

listTables

public List<TDTable> listTables(String databaseName)
                         throws TDClientException

Description copied from interface: TDClientApi

Get the list of the tables in the specified database

Specified by:

listTables in interface TDClientApi<TDClient>

Returns:

Throws:

TDClientException

existsDatabase

public boolean existsDatabase(String databaseName)
                       throws TDClientException

Specified by:

existsDatabase in interface TDClientApi<TDClient>

Throws:

TDClientException

existsTable

public boolean existsTable(String databaseName,
                           String tableName)
                    throws TDClientException

Specified by:

existsTable in interface TDClientApi<TDClient>

Throws:

TDClientException

createTable

public void createTable(String databaseName,
                        String tableName)
                 throws TDClientException

Description copied from interface: TDClientApi

Create a new table

Specified by:

createTable in interface TDClientApi<TDClient>

Throws:

TDClientException

createTableIfNotExists

public void createTableIfNotExists(String databaseName,
                                   String tableName)
                            throws TDClientException

Specified by:

createTableIfNotExists in interface TDClientApi<TDClient>

Throws:

TDClientException

renameTable

public void renameTable(String databaseName,
                        String tableName,
                        String newTableName)
                 throws TDClientException

Specified by:

renameTable in interface TDClientApi<TDClient>

Throws:

TDClientException

renameTable

public void renameTable(String databaseName,
                        String tableName,
                        String newTableName,
                        boolean overwrite)
                 throws TDClientException

Specified by:

renameTable in interface TDClientApi<TDClient>

Throws:

TDClientException

deleteTable

public void deleteTable(String databaseName,
                        String tableName)
                 throws TDClientException

Specified by:

deleteTable in interface TDClientApi<TDClient>

Throws:

TDClientException

deleteTableIfExists

public void deleteTableIfExists(String databaseName,
                                String tableName)
                         throws TDClientException

Specified by:

deleteTableIfExists in interface TDClientApi<TDClient>

Throws:

TDClientException

partialDelete

public TDPartialDeleteJob partialDelete(String databaseName,
                                        String tableName,
                                        long from,
                                        long to)
                                 throws TDClientException

Specified by:

partialDelete in interface TDClientApi<TDClient>

Throws:

TDClientException

swapTables

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

Specified by:

swapTables in interface TDClientApi<TDClient>

updateTableSchema

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

Specified by:

updateTableSchema in interface TDClientApi<TDClient>

submit

public String submit(TDJobRequest jobRequest)
              throws TDClientException

Description copied from interface: TDClientApi

Submit a new job request

Specified by:

submit in interface TDClientApi<TDClient>

Returns:

job_id

Throws:

TDClientException

listJobs

public TDJobList listJobs()
                   throws TDClientException

Specified by:

listJobs in interface TDClientApi<TDClient>

Throws:

TDClientException

listJobs

public TDJobList listJobs(long fromJobId,
                          long toJobId)
                   throws TDClientException

Specified by:

listJobs in interface TDClientApi<TDClient>

Throws:

TDClientException

killJob

public void killJob(String jobId)
             throws TDClientException

Specified by:

killJob in interface TDClientApi<TDClient>

Throws:

TDClientException

jobStatus

public TDJobSummary jobStatus(String jobId)
                       throws TDClientException

Specified by:

jobStatus in interface TDClientApi<TDClient>

Throws:

TDClientException

jobInfo

public TDJob jobInfo(String jobId)
              throws TDClientException

Specified by:

jobInfo in interface TDClientApi<TDClient>

Throws:

TDClientException

jobResult

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

Description copied from interface: TDClientApi

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.

Specified by:

jobResult in interface TDClientApi<TDClient>

Returns:

Throws:

TDClientException

listBulkImportSessions

public List<TDBulkImportSession> listBulkImportSessions()

Specified by:

listBulkImportSessions in interface TDClientApi<TDClient>

listBulkImportParts

public List<String> listBulkImportParts(String sessionName)

Specified by:

listBulkImportParts in interface TDClientApi<TDClient>

createBulkImportSession

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

Specified by:

createBulkImportSession in interface TDClientApi<TDClient>

getBulkImportSession

public TDBulkImportSession getBulkImportSession(String sessionName)

Specified by:

getBulkImportSession in interface TDClientApi<TDClient>

uploadBulkImportPart

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

Specified by:

uploadBulkImportPart in interface TDClientApi<TDClient>

deleteBulkImportPart

public void deleteBulkImportPart(String sessionName,
                                 String uniquePartName)

freezeBulkImportSession

public void freezeBulkImportSession(String sessionName)

Specified by:

freezeBulkImportSession in interface TDClientApi<TDClient>

unfreezeBulkImportSession

public void unfreezeBulkImportSession(String sessionName)

Specified by:

unfreezeBulkImportSession in interface TDClientApi<TDClient>

performBulkImportSession

public void performBulkImportSession(String sessionName)

Specified by:

performBulkImportSession in interface TDClientApi<TDClient>

performBulkImportSession

public void performBulkImportSession(String sessionName,
                                     TDJob.Priority priority)

Specified by:

performBulkImportSession in interface TDClientApi<TDClient>

commitBulkImportSession

public void commitBulkImportSession(String sessionName)

Specified by:

commitBulkImportSession in interface TDClientApi<TDClient>

deleteBulkImportSession

public void deleteBulkImportSession(String sessionName)

Specified by:

deleteBulkImportSession in interface TDClientApi<TDClient>

getBulkImportErrorRecords

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

Specified by:

getBulkImportErrorRecords in interface TDClientApi<TDClient>

startSavedQuery

public String startSavedQuery(String name,
                              Date scheduledTime)

Description copied from interface: TDClientApi

Start a query saved on the cloud.

Specified by:

startSavedQuery in interface TDClientApi<TDClient>

Parameters:

name - name of the saved query

scheduledTime - the return time of TD_SCHEDULED_TIME

Returns:

job id

submitExportJob

public String submitExportJob(TDExportJobRequest jobRequest)
                       throws TDClientException

Description copied from interface: TDClientApi

Start a table export job.

Specified by:

submitExportJob in interface TDClientApi<TDClient>

Returns:

job id

Throws:

TDClientException