org.apache.lens.cli.commands

Class LensFactCommands

java.lang.Object

org.apache.lens.cli.commands.BaseLensCommand

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

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

org.apache.lens.cli.commands.LensFactCommands

All Implemented Interfaces:

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

@Component
@UserDocumentation(title="Commands for Facts Management",
                   description="These command provide CRUD for facts, associated storages, and fact partitions")
public class LensFactCommands
extends LogicalTableCrudCommand<XFactTable>

The Class LensFactCommands.

Field Summary

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

DATE_FMT, DATE_PARSER

Constructor Summary

Constructors

Constructor and Description
LensFactCommands()

Method Summary

Methods

Modifier and Type	Method and Description
String	addNewFactStorage(String tableName, File path) Adds the new fact storage.
String	addPartitionsToFact(String tableName, String storageName, File path)
String	addPartitionToFact(String tableName, String storageName, File path) Adds the partition to fact.
String	createFact(File path) Creates the fact.
String	describeFactTable(String name) Describe fact table.
APIResult	doAddStorage(String name, String path)
APIResult	doDropAllStorages(String name)
APIResult	doDropStorage(String tableName, String storageName)
APIResult	doUpdate(String name, String path)
String	dropAllFactStorages(String name) Drop all fact storages.
String	dropAllPartitionsOfFact(String tableName, String storageName, String filter) Drop all partitions of fact.
String	dropFact(String fact, boolean cascade) Drop fact.
String	dropStorageFromFact(String tableName, String storageName) Drop storage from fact.
List<String>	getAll()
List<String>	getAll(String cubeName)
String	getAllPartitionsOfFact(String tableName, String storageName, String filter) Gets the all partitions of fact.
List<String>	getAllStorages(String name)
String	getFactStorages(String tableName) Gets the fact storages.
String	getStorageFromFact(String tableName, String storage) Gets the storage from fact.
List<String>	getTimelines(String factName, String storageName, String updatePeriod, String timeDimension)
String	showFacts(String cubeName) Show facts.
String	updateFactTable(String name, File specPath) Update fact table.
String	updatePartitionOfFact(String tableName, String storageName, File path) updates the partition in the fact.
String	updatePartitionsOfFact(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

LensFactCommands

public LensFactCommands()

Method Detail

showFacts

@CliCommand(value="show facts",
            help="display list of fact tables in current database. If optional  is supplied, only facts belonging to cube  will be displayed")
public String showFacts(@CliOption(key={"","cube_name"},mandatory=false,help="")
                          String cubeName)

Show facts.

Returns:

the string

createFact

@CliCommand(value="create fact",
            help="create a fact table with spec from ")
public String createFact(@CliOption(key={"","path"},mandatory=true,help="")@NonNull
                           File path)

Creates the fact.

Parameters:

path - Path to fact spec

Returns:

the string

describeFactTable

@CliCommand(value="describe fact",
            help="describe fact ")
public String describeFactTable(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                  String name)

Describe fact table.

Parameters:

name - the fact

Returns:

the string

updateFactTable

@CliCommand(value="update fact",
            help="update fact  taking spec from ")
public String updateFactTable(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                String name,
                                @CliOption(key={"","path"},mandatory=true,help="")@NonNull
                                File specPath)

Update fact table.

Parameters:

name - fact name to be updated

specPath - path to the file containing new spec of the fact

Returns:

the string

dropFact

@CliCommand(value="drop fact",
            help="drops fact . If  is true, all the storage tables associated with the fact  are also dropped. By default  is false")
public String dropFact(@CliOption(key={"","fact_name"},mandatory=true,help="")
                         String fact,
                         @CliOption(key="cascade",mandatory=false,unspecifiedDefaultValue="false",help="")
                         boolean cascade)

Drop fact.

Parameters:

fact - the fact

cascade - the cascade

Returns:

the string

getFactStorages

@CliCommand(value="fact list storage",
            help="display list of storages associated to fact ")
public String getFactStorages(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                String tableName)

Gets the fact storages.

Parameters:

tableName - the fact

Returns:

the fact storages

addNewFactStorage

@CliCommand(value="fact add storage",
            help="adds a new storage to fact , taking storage spec from ")
public String addNewFactStorage(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                  String tableName,
                                  @CliOption(key={"","path"},mandatory=true,help="")@NonNull
                                  File path)

Adds the new fact storage.

Parameters:

tableName - the fact name

path - the path to storage spec

Returns:

the string

getStorageFromFact

@CliCommand(value="fact get storage",
            help="describe storage  of fact ")
public String getStorageFromFact(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                   String tableName,
                                   @CliOption(key={"","storage_name"},mandatory=true,help="")
                                   String storage)

Gets the storage from fact.

Parameters:

tableName - fact table name

storage - storage spec path

Returns:

the storage from fact

dropStorageFromFact

@CliCommand(value="fact drop storage",
            help="drop storage  from fact ")
public String dropStorageFromFact(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                    String tableName,
                                    @CliOption(key={"","storage_name"},mandatory=true,help="")
                                    String storageName)

Drop storage from fact.

Parameters:

tableName - the table name

storageName - the storage name

Returns:

the string

dropAllFactStorages

@CliCommand(value="fact drop all storages",
            help="drop all storages associated to fact ")
public String dropAllFactStorages(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                    String name)

Drop all fact storages.

Parameters:

name - the table

Returns:

the string

getAllPartitionsOfFact

@CliCommand(value="fact list partitions",
            help="get all partitions associated with fact , storage  filtered by ")
public String getAllPartitionsOfFact(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                       String tableName,
                                       @CliOption(key={"","storage_name"},mandatory=true,help="")
                                       String storageName,
                                       @CliOption(key={"","filter"},mandatory=false,help="")
                                       String filter)

Gets the all partitions of fact.

Parameters:

tableName - fact name

storageName - storage name

filter - partition filter

Returns:

the all partitions of fact

dropAllPartitionsOfFact

@CliCommand(value="fact drop partitions",
            help="drop all partitions associated with fact , storage  filtered by ")
public String dropAllPartitionsOfFact(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                        String tableName,
                                        @CliOption(key={"","storage_name"},mandatory=true,help="")
                                        String storageName,
                                        @CliOption(key={"","filter"},mandatory=false,help="")
                                        String filter)

Drop all partitions of fact.

Parameters:

tableName - fact name

storageName - storage name

filter - partition query filter

Returns:

the string

addPartitionToFact

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

Adds the partition to fact.

Parameters:

tableName - fact name

storageName - storage name

path - partition spec path

Returns:

the string

updatePartitionOfFact

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

updates the partition in the fact.

Parameters:

tableName - fact name

storageName - storage name

path - partition spec path

Returns:

the string

addPartitionsToFact

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

updatePartitionsOfFact

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

getTimelines

@CliCommand(value="fact timelines",
            help="get timelines for fact. Can optionally specify storage, update period and time dimension to filter by. Instead of time dimension, partition column can be directly passed as ")
public List<String> getTimelines(@CliOption(key={"","fact_name"},mandatory=true,help="")
                                   String factName,
                                   @CliOption(key="storage_name",mandatory=false,help="")
                                   String storageName,
                                   @CliOption(key="update_period",mandatory=false,help="")
                                   String updatePeriod,
                                   @CliOption(key="time_dimension",mandatory=false,help="")
                                   String timeDimension)

doDropStorage

public APIResult doDropStorage(String tableName,
                      String storageName)

Specified by:

doDropStorage in class LogicalTableCrudCommand<XFactTable>

getAllStorages

public List<String> getAllStorages(String name)

Specified by:

getAllStorages in class LogicalTableCrudCommand<XFactTable>

doAddStorage

public APIResult doAddStorage(String name,
                     String path)

Specified by:

doAddStorage in class LogicalTableCrudCommand<XFactTable>

doDropAllStorages

public APIResult doDropAllStorages(String name)

Specified by:

doDropAllStorages in class LogicalTableCrudCommand<XFactTable>

getAll

public List<String> getAll()

Specified by:

getAll in class LensCRUDCommand<XFactTable>

getAll

public List<String> getAll(String cubeName)

doUpdate

public APIResult doUpdate(String name,
                 String path)

Specified by:

doUpdate in class LensCRUDCommand<XFactTable>