org.apache.lens.cli.commands

Class LensDatabaseCommands

java.lang.Object

org.apache.lens.cli.commands.BaseLensCommand

org.apache.lens.cli.commands.LensCRUDCommand

org.apache.lens.cli.commands.LensDatabaseCommands

All Implemented Interfaces:

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

@Component
@UserDocumentation(title="Commands for Database Management",
                   description="These commands provide CRUD for databases")
public class LensDatabaseCommands
extends LensCRUDCommand

The Class LensDatabaseCommands.

Field Summary

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

DATE_FMT, DATE_PARSER

Constructor Summary

Constructors

Constructor and Description
LensDatabaseCommands()

Method Summary

Methods

Modifier and Type	Method and Description
String	createDatabase(String database, boolean ignoreIfExists) Creates the database.
APIResult	doUpdate(String name, String path)
String	dropDatabase(String database, boolean cascade) Drop database.
List<String>	getAll()
String	showAllDatabases() Show all databases.
String	switchDatabase(String database) Switch database.

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

LensDatabaseCommands

public LensDatabaseCommands()

Method Detail

showAllDatabases

@CliCommand(value="show databases",
            help="displays list of all databases")
public String showAllDatabases()

Show all databases.

Returns:

the string

switchDatabase

@CliCommand(value="use",
            help="change to new database")
public String switchDatabase(@CliOption(key={"","db"},mandatory=true,help="")
                               String database)

Switch database.

Parameters:

database - the database

Returns:

the string

createDatabase

@CliCommand(value="create database",
            help="create a database with specified name. if  is true, create will not be tried if already exists. Default is false")
public String createDatabase(@CliOption(key={"","db"},mandatory=true,help="")
                               String database,
                               @CliOption(key="ignoreIfExists",mandatory=false,unspecifiedDefaultValue="false",help="")
                               boolean ignoreIfExists)

Creates the database.

Parameters:

database - the database

ignoreIfExists - the ignore

Returns:

the string

dropDatabase

@CliCommand(value="drop database",
            help="drop a database with specified name")
public String dropDatabase(@CliOption(key={"","db"},mandatory=true,help="")
                             String database,
                             @CliOption(key="cascade",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                             boolean cascade)

Drop database.

Parameters:

database - the database

Returns:

the string

getAll

public List<String> getAll()

Specified by:

getAll in class LensCRUDCommand

doUpdate

public APIResult doUpdate(String name,
                 String path)

Specified by:

doUpdate in class LensCRUDCommand