org.apache.lens.cli.commands

Class LensCubeCommands

java.lang.Object

org.apache.lens.cli.commands.BaseLensCommand

org.apache.lens.cli.commands.LensCRUDCommand<T>

org.apache.lens.cli.commands.ConceptualTableCrudCommand<XCube>

org.apache.lens.cli.commands.LensCubeCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker, org.springframework.shell.core.ExecutionProcessor

@Component
 @UserDocumentation(title="Commands for OLAP Data Cube Management",
                   description="These commands provide CRUD for cubes")
public class LensCubeCommands
extends ConceptualTableCrudCommand<XCube>

The Class LensCubeCommands.

Field Summary

Fields inherited from class org.apache.lens.cli.commands.BaseLensCommand

DATE_FMT, DATE_PARSER

Constructor Summary

Constructors

Constructor and Description
LensCubeCommands()

Method Summary

Modifier and Type	Method and Description
String	createCube(File path) Creates the cube.
String	describeCube(String name) Describe cube.
APIResult	doUpdate(String name, String path)
String	dropCube(String name) Drop cube.
List<String>	getAll()
String	getLatest(String cube, String timeDim) Cube latest date
String	showCubes() Show cubes.
String	showJoinChains(String table)
String	showQueryableFields(String table, boolean flattened)
String	updateCube(String name, File path) Update cube.

Methods inherited from class org.apache.lens.cli.commands.ConceptualTableCrudCommand

getAllFields, getAllJoinChains

Methods inherited from class org.apache.lens.cli.commands.LensCRUDCommand

create, describe, drop, getSingleObjectName, showAll, update

Methods inherited from class org.apache.lens.cli.commands.BaseLensCommand

afterReturningInvocation, afterThrowingInvocation, beforeInvocation, formatDate, formatJson, getClient, getClientWrapper, getOrDefaultQueryHandleString, getValidPath, removePrefixBeforeURI, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

LensCubeCommands

public LensCubeCommands()

Method Detail

showCubes

@CliCommand(value="show cubes",
            help="show list of cubes in current database")
public String showCubes()

Show cubes.

Returns:

the string

createCube

@CliCommand(value="create cube",
            help="Create a new Cube, taking spec from <path-to-cube-spec-file>")
public String createCube(@CliOption(key={"","path"},mandatory=true,help="<path-to-cube-spec-file>") @NonNull
                                                                                                                                           File path)

Creates the cube.

Parameters:

path - the cube spec

Returns:

the string

describeCube

@CliCommand(value="describe cube",
            help="describe cube with name <cube_name>")
public String describeCube(@CliOption(key={"","name"},mandatory=true,help="<cube_name>")
                                                                                                                      String name)

Describe cube.

Parameters:

name - the cube name

Returns:

the string

updateCube

@CliCommand(value="update cube",
            help="update cube <cube_name> with spec from <path-to-cube-spec-file>")
public String updateCube(@CliOption(key={"","name"},mandatory=true,help="<cube_name>")
                                                                                                                                              String name,
                                                                                                                                              @CliOption(key={"","path"},mandatory=true,help="<path-to-cube-spec-file>") @NonNull
                                                                                                                                              File path)

Update cube.

Parameters:

name - cube name

path - path to new spec file

Returns:

the string

dropCube

@CliCommand(value="drop cube",
            help="drop cube <cube_name>")
public String dropCube(@CliOption(key={"","name"},mandatory=true,help="<cube_name>")
                                                                                                String name)

Drop cube.

Parameters:

name - the cube

Returns:

the string

getLatest

@CliCommand(value="cube latestdate",
            help="get latest date of data available in cube <cube_name> for time dimension <time_dimension_name>.  Instead of time dimension, partition column can be directly passed as <time_dimension>")
public String getLatest(@CliOption(key={"","name"},mandatory=true,help="<cube_name>")
                                                                                                                                                                                                                                                                         String cube,
                                                                                                                                                                                                                                                                         @CliOption(key={"","time_dimension"},mandatory=true,help="<time_dimension>")
                                                                                                                                                                                                                                                                         String timeDim)

Cube latest date

Parameters:

cube - cube name

timeDim - time dimension name

Returns:

the string

showQueryableFields

@CliCommand(value="cube show fields",
            help="Show queryable fields of the given cube <cube_name>. Optionally specify <flattened> to include chained fields")
public String showQueryableFields(@CliOption(key={"","name"},mandatory=true,help="<cube_name>")
                                                                                                                                                                                                          String table,
                                                                                                                                                                                                          @CliOption(key="flattened",mandatory=false,unspecifiedDefaultValue="false",specifiedDefaultValue="true",help="<flattened>")
                                                                                                                                                                                                          boolean flattened)

showJoinChains

@CliCommand(value="cube show joinchains",
            help="Show joinchains of the given cube <cube_name>. ")
public String showJoinChains(@CliOption(key={"","name"},mandatory=true,help="<cube_name>")
                                                                                                                                           String table)

getAll

public List<String> getAll()

Specified by:

getAll in class LensCRUDCommand<XCube>

doUpdate

public APIResult doUpdate(String name,
                          String path)

Specified by:

doUpdate in class LensCRUDCommand<XCube>