LensClient (Lens 2.4.0-beta API)

java.lang.Object
- org.apache.lens.client.LensClient

```
public class LensClient
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LensClient.LensClientResultSetWithStats

Nested Classes
Modifier and Type	Class and Description
`static class`	`LensClient.LensClientResultSetWithStats`

Field Summary

Fields
Modifier and Type Field and Description

static String CLILOGGER

Fields
Modifier and Type	Field and Description
`static String`	`CLILOGGER`

Constructor Summary

Constructors
Constructor and Description
`LensClient()`
`LensClient(Credentials cred)`
`LensClient(LensClientConfig conf)`
`LensClient(LensClientConfig conf, String username, String password)`
`LensClient(String username, String password)`

Method Summary

Methods
Modifier and Type	Method and Description
`APIResult`	`addFileResource(String path)`
`APIResult`	`addJarResource(String path)`
`APIResult`	`addPartitionsToDim(String table, String storage, String partsSpec)`
`APIResult`	`addPartitionsToDim(String table, String storage, XPartitionList xpList)`
`APIResult`	`addPartitionsToFact(String table, String storage, String partsSpec)`
`APIResult`	`addPartitionsToFact(String table, String storage, XPartitionList xpList)`
`APIResult`	`addPartitionToDim(String table, String storage, String partSpec)`
`APIResult`	`addPartitionToDim(String table, String storage, XPartition xp)`
`APIResult`	`addPartitionToFact(String table, String storage, String partSpec)`
`APIResult`	`addPartitionToFact(String table, String storage, XPartition xp)`
`APIResult`	`addStorageToDim(String dim, String storage)`
`APIResult`	`addStorageToFact(String factName, String spec)`
`APIResult`	`closeConnection()`
`APIResult`	`createCube(String cubeSpec)`
`APIResult`	`createDatabase(String database, boolean ignoreIfExists)`
`APIResult`	`createDimension(String dimSpec)`
`APIResult`	`createDimensionTable(String dimSpec)`
`APIResult`	`createFactTable(String factSpec)`
`APIResult`	`createStorage(String storageSpec)`
`boolean`	`destroyPrepared(QueryPrepareHandle queryPrepareHandle)`
`APIResult`	`dropAllPartitionsOfDim(String dim, String storage)`
`APIResult`	`dropAllPartitionsOfDim(String dim, String storage, String list)`
`APIResult`	`dropAllPartitionsOfFact(String fact, String storage)`
`APIResult`	`dropAllPartitionsOfFact(String fact, String storage, String list)`
`APIResult`	`dropAllStoragesOfDim(String table)`
`APIResult`	`dropAllStoragesOfFact(String table)`
`APIResult`	`dropCube(String cube)`
`APIResult`	`dropDatabase(String database, boolean cascade)`
`APIResult`	`dropDimension(String dimName)`
`APIResult`	`dropDimensionTable(String dim, boolean cascade)`
`APIResult`	`dropFactTable(String fact, boolean cascade)`
`APIResult`	`dropStorage(String storage)`
`APIResult`	`dropStorageFromDim(String dim, String storage)`
`APIResult`	`dropStorageFromFact(String factName, String storage)`
`QueryHandle`	`executePrepared(QueryPrepareHandle phandle, String queryName)`
`LensAPIResult<QueryHandle>`	`executeQueryAsynch(String sql, String queryName)`
`LensAPIResult<QueryPlan>`	`explainAndPrepare(String sql, String queryName)`
`List<String>`	`getAllCubes()`
`List<String>`	`getAllDatabases()`
`List<String>`	`getAllDimensions()`
`List<String>`	`getAllDimensionTables()`
`List<String>`	`getAllDimensionTables(String dimensionName)`
`List<String>`	`getAllFactTables()`
`List<String>`	`getAllFactTables(String cubeName)`
`List<String>`	`getAllNativeTables()`
`List<XPartition>`	`getAllPartitionsOfDim(String dim, String storage)`
`List<XPartition>`	`getAllPartitionsOfDim(String dim, String storage, String list)`
`List<XPartition>`	`getAllPartitionsOfFact(String fact, String storage)`
`List<XPartition>`	`getAllPartitionsOfFact(String fact, String storage, String list)`
`List<String>`	`getAllStorages()`
`LensClient.LensClientResultSetWithStats`	`getAsyncResults(QueryHandle q)`
`static org.slf4j.Logger`	`getCliLooger()`
`LensConnection`	`getConnection()`
`List<String>`	`getConnectionParam()`
`List<String>`	`getConnectionParam(String key)`
`XCube`	`getCube(String cubeName)`
`String`	`getCurrentDatabae()`
`XDimension`	`getDimension(String dimName)`
`XDimensionTable`	`getDimensionTable(String dimName)`
`List<String>`	`getDimStorages(String dim)`
`List<String>`	`getFactStorages(String fact)`
`XFactTable`	`getFactTable(String factName)`
`javax.ws.rs.core.Response`	`getHttpResults()`
`javax.ws.rs.core.Response`	`getHttpResults(QueryHandle q)`
`XJoinChains`	`getJoinChains(String table)`
`Date`	`getLatestDateOfCube(String cubeName, String timePartition)`
`LensStatement`	`getLensStatement(QueryHandle query)`
`javax.ws.rs.core.Response`	`getLogs(String logFile)`
`LensMetadataClient`	`getMc()`
`LensMetadataClient`	`getMetadataClient()`
`XNativeTable`	`getNativeTable(String tblName)`
`List<String>`	`getPartitionTimelines(String factName, String storageName, String updatePeriod, String timeDimension)`
`PathValidator`	`getPathValidator()`
`List<QueryPrepareHandle>`	`getPreparedQueries(String userName, String queryName, long fromDate, long toDate)`
`LensPreparedQuery`	`getPreparedQuery(QueryPrepareHandle phandle)`
`List<QueryHandle>`	`getQueries(String state, String queryName, String user, long fromDate, long toDate)`
`XFlattenedColumns`	`getQueryableFields(String table, boolean flattened)`
`LensQuery`	`getQueryDetails(QueryHandle handle)`
`LensQuery`	`getQueryDetails(String handle)`
`LensAPIResult<QueryPlan>`	`getQueryPlan(String q)`
`QueryStatus`	`getQueryStatus(QueryHandle query)`
`QueryStatus`	`getQueryStatus(String q)`
`QueryResult`	`getResults(QueryHandle query)`
`LensClient.LensClientResultSetWithStats`	`getResults(String sql, String queryName)`
`LensClient.LensClientResultSetWithStats`	`getResultsFromPrepared(QueryPrepareHandle phandle, String queryName)`
`XStorage`	`getStorage(String storageName)`
`XStorageTableElement`	`getStorageFromDim(String dim, String storage)`
`XStorageTableElement`	`getStorageFromFact(String fact, String storage)`
`LensClient.LensClientResultSetWithStats`	`getSyncResults(QueryHandle q)`
`boolean`	`isConnectionOpen()`
`boolean`	`killQuery(QueryHandle q)`
`List<String>`	`listResources(String type)`
`LensAPIResult<QueryPrepareHandle>`	`prepare(String sql, String queryName)`
`APIResult`	`removeFileResource(String path)`
`APIResult`	`removeJarResource(String path)`
`APIResult`	`setConnectionParam(String key, String val)`
`boolean`	`setDatabase(String database)`
`APIResult`	`updateCube(String cubeName, String cubeSpec)`
`APIResult`	`updateDimension(String dimName, String dimSpec)`
`APIResult`	`updateDimensionTable(String dimName, String dimSpec)`
`APIResult`	`updateFactTable(String factName, String factSpec)`
`APIResult`	`updatePartitionOfDim(String table, String storage, String partSpec)`
`APIResult`	`updatePartitionOfDim(String table, String storage, XPartition xp)`
`APIResult`	`updatePartitionOfFact(String table, String storage, String partSpec)`
`APIResult`	`updatePartitionOfFact(String table, String storage, XPartition xp)`
`APIResult`	`updatePartitionsOfDim(String table, String storage, String partsSpec)`
`APIResult`	`updatePartitionsOfDim(String table, String storage, XPartitionList xpList)`
`APIResult`	`updatePartitionsOfFact(String table, String storage, String partsSpec)`
`APIResult`	`updatePartitionsOfFact(String table, String storage, XPartitionList xpList)`
`APIResult`	`updateStorage(String storageName, String storageSpec)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- CLILOGGER
```
public static final String CLILOGGER
```
  See Also:
  Constant Field Values

Constructor Detail

LensClient
```
public LensClient()
```

LensClient

public LensClient(LensClientConfig conf)

LensClient

public LensClient(String username,
          String password)

LensClient

public LensClient(LensClientConfig conf,
          String username,
          String password)

LensClient
```
public LensClient(Credentials cred)
```

Method Detail

getCliLooger

public static org.slf4j.Logger getCliLooger()

getMetadataClient

public LensMetadataClient getMetadataClient()

executeQueryAsynch

public LensAPIResult<QueryHandle> executeQueryAsynch(String sql,
                                            String queryName)
                                              throws LensAPIException

Throws:: LensAPIException

getLatestDateOfCube

public Date getLatestDateOfCube(String cubeName,
                       String timePartition)

getPartitionTimelines

public List<String> getPartitionTimelines(String factName,
                                 String storageName,
                                 String updatePeriod,
                                 String timeDimension)

getResults

public LensClient.LensClientResultSetWithStats getResults(String sql,
                                                 String queryName)
                                                   throws LensAPIException

Throws:: LensAPIException

getAsyncResults

public LensClient.LensClientResultSetWithStats getAsyncResults(QueryHandle q)

getSyncResults

public LensClient.LensClientResultSetWithStats getSyncResults(QueryHandle q)

getHttpResults

public javax.ws.rs.core.Response getHttpResults()

getHttpResults

public javax.ws.rs.core.Response getHttpResults(QueryHandle q)

getLensStatement

public LensStatement getLensStatement(QueryHandle query)

getQueryStatus

public QueryStatus getQueryStatus(QueryHandle query)

getQueryDetails

public LensQuery getQueryDetails(QueryHandle handle)

getQueryStatus

public QueryStatus getQueryStatus(String q)

getQueryDetails

public LensQuery getQueryDetails(String handle)

getQueryPlan

public LensAPIResult<QueryPlan> getQueryPlan(String q)
                                      throws LensAPIException

Throws:: LensAPIException

killQuery

public boolean killQuery(QueryHandle q)

getResults

public QueryResult getResults(QueryHandle query)

getQueries

public List<QueryHandle> getQueries(String state,
                           String queryName,
                           String user,
                           long fromDate,
                           long toDate)

getAllDatabases
```
public List<String> getAllDatabases()
```

getAllNativeTables

public List<String> getAllNativeTables()

getAllFactTables

public List<String> getAllFactTables()

getAllFactTables

public List<String> getAllFactTables(String cubeName)

getAllDimensionTables

public List<String> getAllDimensionTables()

getAllDimensionTables

public List<String> getAllDimensionTables(String dimensionName)

getAllCubes
```
public List<String> getAllCubes()
```

getAllDimensions

public List<String> getAllDimensions()

getCurrentDatabae
```
public String getCurrentDatabae()
```

setDatabase

public boolean setDatabase(String database)

dropDatabase

public APIResult dropDatabase(String database,
                     boolean cascade)

createDatabase

public APIResult createDatabase(String database,
                       boolean ignoreIfExists)

setConnectionParam

public APIResult setConnectionParam(String key,
                           String val)

getConnectionParam

public List<String> getConnectionParam()

getConnectionParam

public List<String> getConnectionParam(String key)

closeConnection
```
public APIResult closeConnection()
```

addJarResource

public APIResult addJarResource(String path)

removeJarResource

public APIResult removeJarResource(String path)

addFileResource

public APIResult addFileResource(String path)

removeFileResource

public APIResult removeFileResource(String path)

createFactTable

public APIResult createFactTable(String factSpec)

createCube

public APIResult createCube(String cubeSpec)

createStorage

public APIResult createStorage(String storageSpec)

createDimension

public APIResult createDimension(String dimSpec)

createDimensionTable

public APIResult createDimensionTable(String dimSpec)

getAllStorages
```
public List<String> getAllStorages()
```

dropDimensionTable

public APIResult dropDimensionTable(String dim,
                           boolean cascade)

dropFactTable

public APIResult dropFactTable(String fact,
                      boolean cascade)

dropCube

public APIResult dropCube(String cube)

dropStorage

public APIResult dropStorage(String storage)

dropDimension

public APIResult dropDimension(String dimName)

updateFactTable

public APIResult updateFactTable(String factName,
                        String factSpec)

updateDimensionTable

public APIResult updateDimensionTable(String dimName,
                             String dimSpec)

updateCube

public APIResult updateCube(String cubeName,
                   String cubeSpec)

updateStorage

public APIResult updateStorage(String storageName,
                      String storageSpec)

updateDimension

public APIResult updateDimension(String dimName,
                        String dimSpec)

getFactTable

public XFactTable getFactTable(String factName)

getDimensionTable

public XDimensionTable getDimensionTable(String dimName)

getNativeTable

public XNativeTable getNativeTable(String tblName)

getCube

public XCube getCube(String cubeName)

getQueryableFields

public XFlattenedColumns getQueryableFields(String table,
                                   boolean flattened)

getJoinChains

public XJoinChains getJoinChains(String table)

getDimension

public XDimension getDimension(String dimName)

getStorage

public XStorage getStorage(String storageName)

getFactStorages

public List<String> getFactStorages(String fact)

getDimStorages

public List<String> getDimStorages(String dim)

dropAllStoragesOfDim

public APIResult dropAllStoragesOfDim(String table)

dropAllStoragesOfFact

public APIResult dropAllStoragesOfFact(String table)

addStorageToFact

public APIResult addStorageToFact(String factName,
                         String spec)

dropStorageFromFact

public APIResult dropStorageFromFact(String factName,
                            String storage)

getStorageFromFact

public XStorageTableElement getStorageFromFact(String fact,
                                      String storage)

addStorageToDim

public APIResult addStorageToDim(String dim,
                        String storage)

dropStorageFromDim

public APIResult dropStorageFromDim(String dim,
                           String storage)

getStorageFromDim

public XStorageTableElement getStorageFromDim(String dim,
                                     String storage)

getAllPartitionsOfFact

public List<XPartition> getAllPartitionsOfFact(String fact,
                                      String storage)

getAllPartitionsOfFact

public List<XPartition> getAllPartitionsOfFact(String fact,
                                      String storage,
                                      String list)

getAllPartitionsOfDim

public List<XPartition> getAllPartitionsOfDim(String dim,
                                     String storage)

getAllPartitionsOfDim

public List<XPartition> getAllPartitionsOfDim(String dim,
                                     String storage,
                                     String list)

dropAllPartitionsOfFact

public APIResult dropAllPartitionsOfFact(String fact,
                                String storage)

dropAllPartitionsOfFact

public APIResult dropAllPartitionsOfFact(String fact,
                                String storage,
                                String list)

dropAllPartitionsOfDim

public APIResult dropAllPartitionsOfDim(String dim,
                               String storage)

dropAllPartitionsOfDim

public APIResult dropAllPartitionsOfDim(String dim,
                               String storage,
                               String list)

addPartitionToFact

public APIResult addPartitionToFact(String table,
                           String storage,
                           String partSpec)

addPartitionsToFact

public APIResult addPartitionsToFact(String table,
                            String storage,
                            String partsSpec)

addPartitionToFact

public APIResult addPartitionToFact(String table,
                           String storage,
                           XPartition xp)

addPartitionsToFact

public APIResult addPartitionsToFact(String table,
                            String storage,
                            XPartitionList xpList)

addPartitionToDim

public APIResult addPartitionToDim(String table,
                          String storage,
                          String partSpec)

addPartitionToDim

public APIResult addPartitionToDim(String table,
                          String storage,
                          XPartition xp)

addPartitionsToDim

public APIResult addPartitionsToDim(String table,
                           String storage,
                           XPartitionList xpList)

addPartitionsToDim

public APIResult addPartitionsToDim(String table,
                           String storage,
                           String partsSpec)

updatePartitionOfFact

public APIResult updatePartitionOfFact(String table,
                              String storage,
                              String partSpec)

updatePartitionsOfFact

public APIResult updatePartitionsOfFact(String table,
                               String storage,
                               String partsSpec)

updatePartitionOfFact

public APIResult updatePartitionOfFact(String table,
                              String storage,
                              XPartition xp)

updatePartitionsOfFact

public APIResult updatePartitionsOfFact(String table,
                               String storage,
                               XPartitionList xpList)

updatePartitionOfDim

public APIResult updatePartitionOfDim(String table,
                             String storage,
                             String partSpec)

updatePartitionOfDim

public APIResult updatePartitionOfDim(String table,
                             String storage,
                             XPartition xp)

updatePartitionsOfDim

public APIResult updatePartitionsOfDim(String table,
                              String storage,
                              XPartitionList xpList)

updatePartitionsOfDim

public APIResult updatePartitionsOfDim(String table,
                              String storage,
                              String partsSpec)

prepare

public LensAPIResult<QueryPrepareHandle> prepare(String sql,
                                        String queryName)
                                          throws LensAPIException

Throws:: LensAPIException

explainAndPrepare

public LensAPIResult<QueryPlan> explainAndPrepare(String sql,
                                         String queryName)
                                           throws LensAPIException

Throws:: LensAPIException

destroyPrepared

public boolean destroyPrepared(QueryPrepareHandle queryPrepareHandle)

getPreparedQueries

public List<QueryPrepareHandle> getPreparedQueries(String userName,
                                          String queryName,
                                          long fromDate,
                                          long toDate)

getPreparedQuery

public LensPreparedQuery getPreparedQuery(QueryPrepareHandle phandle)

getResultsFromPrepared

public LensClient.LensClientResultSetWithStats getResultsFromPrepared(QueryPrepareHandle phandle,
                                                             String queryName)

executePrepared

public QueryHandle executePrepared(QueryPrepareHandle phandle,
                          String queryName)

isConnectionOpen
```
public boolean isConnectionOpen()
```

listResources

public List<String> listResources(String type)

getLogs

public javax.ws.rs.core.Response getLogs(String logFile)

getMc

@Generated(value="lombok")
public LensMetadataClient getMc()

getConnection

@Generated(value="lombok")
public LensConnection getConnection()

getPathValidator

@Generated(value="lombok")
public PathValidator getPathValidator()

Class LensClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLILOGGER

Constructor Detail

LensClient

LensClient

LensClient

LensClient

LensClient

Method Detail

getCliLooger

getMetadataClient

executeQueryAsynch

getLatestDateOfCube

getPartitionTimelines

getResults

getAsyncResults

getSyncResults

getHttpResults

getHttpResults

getLensStatement

getQueryStatus

getQueryDetails

getQueryStatus

getQueryDetails

getQueryPlan

killQuery

getResults

getQueries

getAllDatabases

getAllNativeTables

getAllFactTables

getAllFactTables

getAllDimensionTables

getAllDimensionTables

getAllCubes

getAllDimensions

getCurrentDatabae

setDatabase

dropDatabase

createDatabase

setConnectionParam

getConnectionParam

getConnectionParam

closeConnection

addJarResource

removeJarResource

addFileResource

removeFileResource

createFactTable

createCube

createStorage

createDimension

createDimensionTable

getAllStorages

dropDimensionTable

dropFactTable

dropCube

dropStorage

dropDimension

updateFactTable

updateDimensionTable

updateCube

updateStorage

updateDimension

getFactTable

getDimensionTable

getNativeTable

getCube

getQueryableFields

getJoinChains

getDimension

getStorage

getFactStorages

getDimStorages