dql.cli module

Interative DQL client

class dql.cli.DQLClient(completekey='tab', stdin=None, stdout=None)

Bases: cmd.Cmd

Interactive commandline interface.

Attributes:

running : bool

True while session is active, False after quitting

engine : dql.engine.FragmentEngine

caution_callback(self, action)

Prompt user for manual continue when doing write operation on all items in a table

complete_file(self, text, line, *_)

Autocomplete DQL file lookup

complete_ls(self, text, *_)

Autocomplete for ls

complete_opt(self, text, line, begidx, endidx)

Autocomplete for options

complete_opt_allow_select_scan(self, text, *_)

Autocomplete for allow_select_scan option

complete_opt_display(self, text, *_)

Autocomplete for display option

complete_opt_format(self, text, *_)

Autocomplete for format option

complete_opt_pagesize(self, *_)

Autocomplete for pagesize option

complete_opt_width(self, *_)

Autocomplete for width option

complete_use(self, text, *_)

Autocomplete for use

complete_watch(self, text, *_)

Autocomplete for watch

completedefault(self, text, line, *_)

Autocomplete table names in queries

conf = None

default(self, command)

display = None

do_EOF(self, arglist)

Exit

do_exit(self, arglist)

Exit

do_file(self, arglist)

Read and execute a .dql file

do_local(self, arglist)

Connect to a local DynamoDB instance. Use ‘local off’ to disable.

> local > local host=localhost port=8001 > local off

do_ls(self, arglist)

List all tables or print details of one table

do_opt(self, arglist)

Get and set options

do_shell(self, arglist)

Run a shell command

do_throttle(self, arglist)

Set the allowed consumed throughput for DQL.

# Set the total allowed throughput across all tables > throttle 1000 100 # Set the default allowed throughput per-table/index > throttle default 40% 20% # Set the allowed throughput on a table > throttle mytable 10 10 # Set the allowed throughput on a global index > throttle mytable myindex 40 6

see also: unthrottle

do_unthrottle(self, arglist)

Remove the throughput limits for DQL that were set with ‘throttle’

# Remove all limits > unthrottle # Remove the limit on total allowed throughput > unthrottle total # Remove the default limit > unthrottle default # Remove the limit on a table > unthrottle mytable # Remove the limit on a global index > unthrottle mytable myindex

do_use(self, arglist)

Switch the AWS region

> use us-west-1 > use us-east-1

do_watch(self, arglist)

Watch Dynamo tables consumed capacity

emptyline(self)

engine = None

formatter = None

getopt_default(self, option)

Default method to get an option

getopt_display(self)

Get value for display option

getopt_format(self)

Get value for format option

help_alter(self)

Print the help text for ALTER

help_analyze(self)

Print the help text for ALTER

help_create(self)

Print the help text for CREATE

help_delete(self)

Print the help text for DELETE

help_drop(self)

Print the help text for DROP

help_dump(self)

Print the help text for DUMP

help_explain(self)

Print the help text for EXPLAIN

help_help(self)

Print the help text for help

help_insert(self)

Print the help text for INSERT

help_load(self)

Print the help text for LOAD

help_opt(self)

Print the help text for options

help_scan(self)

Print the help text for SCAN

help_select(self)

Print the help text for SELECT

help_update(self)

Print the help text for UPDATE

initialize(self, region='us-west-1', host=None, port=8000, config_dir=None, session=None)

Set up the repl for execution.

load_config(self)

Load your configuration settings from a file

opt_allow_select_scan(self, allow)

Set option allow_select_scan

opt_display(self, display)

Set value for display option

opt_format(self, fmt)

Set value for format option

opt_pagesize(self, pagesize)

Get or set the page size of the query output

opt_width(self, width)

Set width of output (‘auto’ will auto-detect terminal width)

postcmd(self, stop, line)

run_command(self, command)

Run a command passed in from the command line with -c

running = False

save_config(self)

Save the conf file

session = None

start(self)

Start running the interactive session (blocking)

throttle = None

update_prompt(self)

Update the prompt

dql.cli.get_enum_key(key, choices)

Get an enum by prefix or equality

dql.cli.indent(string, prefix=' ')

Indent a paragraph of text

dql.cli.prompt(msg, default=<object object at 0x7ff2423a0090>, validate=None)

Prompt user for input

dql.cli.promptyn(msg, default=None)

Display a blocking prompt until the user confirms

dql.cli.repl_command(fxn)

Decorator for cmd methods

Parses arguments from the arg string and passes them to the method as *args and **kwargs.