org.apache.lens.cli.commands

Class LensDimensionTableCommands

java.lang.Object

org.apache.lens.cli.commands.BaseLensCommand

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

org.apache.lens.cli.commands.LogicalTableCrudCommand<XDimensionTable>

org.apache.lens.cli.commands.LensDimensionTableCommands

All Implemented Interfaces:

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

@Component
 @UserDocumentation(title="Commands for Dimension Tables Management",
                   description="These commands provide CRUD for dimension tables, associated storages, and fact partitions")
public class LensDimensionTableCommands
extends LogicalTableCrudCommand<XDimensionTable>
implements org.springframework.shell.core.CommandMarker

The Class LensDimensionTableCommands.

Field Summary

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

DATE_FMT, DATE_PARSER

Constructor Summary

Constructors

Constructor and Description
LensDimensionTableCommands()

Method Summary

Modifier and Type	Method and Description
String	addNewDimStorage(String tableName, File path) Adds the new dim storage.
String	addPartitionsToDimtable(String tableName, String storageName, File path) Adds the partitions to dim table.
String	addPartitionToDimtable(String tableName, String storageName, File path) Adds the partition to dim table.
String	createDimensionTable(File path) Creates the dimension table.
String	describeDimensionTable(String name) Describe dimension table.
APIResult	doAddStorage(String name, String path)
APIResult	doDropAllStorages(String name)
APIResult	doDropStorage(String tableName, String storageName)
APIResult	doUpdate(String name, String path)
String	dropAllDimStorages(String tableName) Drop all dim storages.
String	dropAllPartitionsOfDim(String tableName, String storageName, String filter) Drop all partitions of dim.
String	dropDimensionTable(String name, boolean cascade) Drop dimension table.
String	dropStorageFromDim(String tableName, String storageName) Drop storage from dim.
List<String>	getAll()
List<String>	getAll(String dimesionName)
String	getAllPartitionsOfDimtable(String tableName, String storageName, String filter) Gets the all partitions of dim.
List<String>	getAllStorages(String name)
String	getDimStorages(String table) Gets the dim storages.
String	getStorageFromDim(String tableName, String storage) Gets the storage from dim.
String	showDimensionTables(String dimensionName) Show dimension tables.
String	updateDimensionTable(String name, File path) Update dimension table.
String	updatePartitionOfDimtable(String tableName, String storageName, File path)
String	updatePartitionsOfDimtable(String tableName, String storageName, String path)

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

addPartition, addPartitions, addStorage, dropAllStorages, dropPartitions, dropStorage, getAllPartitions, getStorage, showAll, showAllStorages, updatePartition, updatePartitions

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

LensDimensionTableCommands

public LensDimensionTableCommands()

Method Detail

showDimensionTables

@CliCommand(value="show dimtables",
            help="display list of dimtables in current database. If optional <dimension_name> is supplied, only facts belonging to dimension <dimension_name> will be displayed")
public String showDimensionTables(@CliOption(key={"","dimension_name"},mandatory=false,help="<dimension_name>")
                                                                                                                                                                                                                                                        String dimensionName)

Show dimension tables.

Returns:

the string

createDimensionTable

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

Creates the dimension table.

Parameters:

path - Path to dim spec

Returns:

the string

describeDimensionTable

@CliCommand(value="describe dimtable",
            help="describe dimtable <dimtable_name>")
public String describeDimensionTable(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                  String name)

Describe dimension table.

Parameters:

name - the dim

Returns:

the string

updateDimensionTable

@CliCommand(value="update dimtable",
            help="update dimtable <dimtable_name> taking spec from <path-to-dimtable-spec>")
public String updateDimensionTable(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                     String name,
                                                                                                                                                                     @CliOption(key={"","path"},mandatory=true,help="<path-to-dimtable-spec>") @NonNull
                                                                                                                                                                     File path)

Update dimension table.

Parameters:

name - the dimtable name

path - the path to spec file

Returns:

the string

dropDimensionTable

@CliCommand(value="drop dimtable",
            help="drop dimtable <dimtable_name>.  If <cascade> is true, all the storage tables associated with the dimtable <dimtable_name> are also dropped. By default <cascade> is false")
public String dropDimensionTable(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                                                                                                                  String name,
                                                                                                                                                                                                                                                                  @CliOption(key="cascade",mandatory=false,specifiedDefaultValue="true",unspecifiedDefaultValue="false",help="<cascade>")
                                                                                                                                                                                                                                                                  boolean cascade)

Drop dimension table.

Parameters:

name - the dim

cascade - the cascade

Returns:

the string

getDimStorages

@CliCommand(value="dimtable list storages",
            help="display list of storage associated to dimtable <dimtable_name>")
public String getDimStorages(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                            String table)

Gets the dim storages.

Parameters:

table - the dim

Returns:

the dim storages

addNewDimStorage

@CliCommand(value="dimtable add storage",
            help="adds a new storage to dimtable <dimtable_name>, taking storage spec from <path-to-storage-spec>")
public String addNewDimStorage(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                                             String tableName,
                                                                                                                                                                                             @CliOption(key={"","path"},mandatory=true,help="<path-to-storage-spec>") @NonNull
                                                                                                                                                                                             File path)

Adds the new dim storage.

Parameters:

tableName - dimtable name

path - path to storage spec

Returns:

the string

getStorageFromDim

@CliCommand(value="dimtable get storage",
            help="describe storage <storage_name> of dimtable <dimtable_name>")
public String getStorageFromDim(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                          String tableName,
                                                                                                                                                          @CliOption(key={"","storage_name"},mandatory=true,help="<storage_name>")
                                                                                                                                                          String storage)

Gets the storage from dim.

Parameters:

tableName - dimtable name

Returns:

path storage spec path

dropStorageFromDim

@CliCommand(value="dimtable drop storage",
            help="drop storage <storage_name> from dimtable <dimtable_name>")
public String dropStorageFromDim(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                          String tableName,
                                                                                                                                                          @CliOption(key={"","storage_name"},mandatory=true,help="<storage_name>")
                                                                                                                                                          String storageName)

Drop storage from dim.

Parameters:

tableName - dimtable name

storageName - storage name

Returns:

the string

dropAllDimStorages

@CliCommand(value="dimtable drop all storages",
            help="drop all storages associated to dimension table")
public String dropAllDimStorages(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                     String tableName)

Drop all dim storages.

Parameters:

tableName - the table

Returns:

the string

getAllPartitionsOfDimtable

@CliCommand(value="dimtable list partitions",
            help="get all partitions associated with dimtable <dimtable_name>, storage <storage_name> filtered by <partition-filter>")
public String getAllPartitionsOfDimtable(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                                                                              String tableName,
                                                                                                                                                                                                                              @CliOption(key={"","storage_name"},mandatory=true,help="<storage_name>")
                                                                                                                                                                                                                              String storageName,
                                                                                                                                                                                                                              @CliOption(key={"","filter"},mandatory=false,help="<partition-filter>")
                                                                                                                                                                                                                              String filter)

Gets the all partitions of dim.

Parameters:

tableName - dimtable name

storageName - storage name

filter - partition filter

Returns:

the all partitions of dim

dropAllPartitionsOfDim

@CliCommand(value="dimtable drop partitions",
            help="drop all partitions associated with dimtable <dimtable_name>, storage <storage_name> filtered by <partition-filter>")
public String dropAllPartitionsOfDim(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                                                                           String tableName,
                                                                                                                                                                                                                           @CliOption(key={"","storage_name"},mandatory=true,help="<storage_name>")
                                                                                                                                                                                                                           String storageName,
                                                                                                                                                                                                                           @CliOption(key={"","filter"},mandatory=false,help="<partition-filter>")
                                                                                                                                                                                                                           String filter)

Drop all partitions of dim.

Parameters:

tableName - dimtable name

storageName - storage name

filter - partition query filter

Returns:

the string

addPartitionToDimtable

@CliCommand(value="dimtable add single-partition",
            help="add single partition to dimtable <dimtable_name>\'s storage <storage_name>, reading spec from <partition-spec-path>")
public String addPartitionToDimtable(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                                                                                String tableName,
                                                                                                                                                                                                                                @CliOption(key={"","storage_name"},mandatory=true,help="<storage_name>")
                                                                                                                                                                                                                                String storageName,
                                                                                                                                                                                                                                @CliOption(key={"","path"},mandatory=true,help="<partition-spec-path>") @NonNull
                                                                                                                                                                                                                                File path)

Adds the partition to dim table.

Parameters:

tableName - dimtable name

storageName - storage name

path - partition spec path

Returns:

the string

updatePartitionOfDimtable

@CliCommand(value="dimtable update single-partition",
            help="update single partition to dimtable <dimtable_name>\'s storage <storage_name>, reading spec from <partition-spec-path> The partition has to exist to be eligible for updation.")
public String updatePartitionOfDimtable(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                                                                                                                                                 String tableName,
                                                                                                                                                                                                                                                                                                 @CliOption(key={"","storage_name"},mandatory=true,help="<storage_name>")
                                                                                                                                                                                                                                                                                                 String storageName,
                                                                                                                                                                                                                                                                                                 @CliOption(key={"","path"},mandatory=true,help="<partition-spec-path>") @NonNull
                                                                                                                                                                                                                                                                                                 File path)

addPartitionsToDimtable

@CliCommand(value="dimtable add partitions",
            help="add multiple partition to dimtable <dimtable_name>\'s storage <storage_name>, reading partition list spec from <partition-list-spec-path>")
public String addPartitionsToDimtable(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                                                                                                 String tableName,
                                                                                                                                                                                                                                                 @CliOption(key={"","storage_name"},mandatory=true,help="<storage_name>")
                                                                                                                                                                                                                                                 String storageName,
                                                                                                                                                                                                                                                 @CliOption(key={"","path"},mandatory=true,help="<partition-list-spec-path>") @NonNull
                                                                                                                                                                                                                                                 File path)

Adds the partitions to dim table.

Parameters:

tableName - dimtable name

storageName - storage name

path - partition spec path

Returns:

the string

updatePartitionsOfDimtable

@CliCommand(value="dimtable update partitions",
            help="update multiple partition to dimtable <dimtable_name>\'s storage <storage_name>, reading partition list spec from <partition-list-spec-path> The partitions have to exist to be eligible for updation.")
public String updatePartitionsOfDimtable(@CliOption(key={"","dimtable_name"},mandatory=true,help="<dimtable_name>")
                                                                                                                                                                                                                                                                                                                    String tableName,
                                                                                                                                                                                                                                                                                                                    @CliOption(key={"","storage_name"},mandatory=true,help="<storage_name>")
                                                                                                                                                                                                                                                                                                                    String storageName,
                                                                                                                                                                                                                                                                                                                    @CliOption(key={"","path"},mandatory=true,help="<partition-list-spec-path>")
                                                                                                                                                                                                                                                                                                                    String path)

doDropStorage

public APIResult doDropStorage(String tableName,
                               String storageName)

Specified by:

doDropStorage in class LogicalTableCrudCommand<XDimensionTable>

getAllStorages

public List<String> getAllStorages(String name)

Specified by:

getAllStorages in class LogicalTableCrudCommand<XDimensionTable>

doAddStorage

public APIResult doAddStorage(String name,
                              String path)

Specified by:

doAddStorage in class LogicalTableCrudCommand<XDimensionTable>

doDropAllStorages

public APIResult doDropAllStorages(String name)

Specified by:

doDropAllStorages in class LogicalTableCrudCommand<XDimensionTable>

getAll

public List<String> getAll()

Specified by:

getAll in class LensCRUDCommand<XDimensionTable>

getAll

public List<String> getAll(String dimesionName)

doUpdate

public APIResult doUpdate(String name,
                          String path)

Specified by:

doUpdate in class LensCRUDCommand<XDimensionTable>