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(action)

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

complete_file(text, line, *_)

Autocomplete DQL file lookup

complete_ls(text, *_)

Autocomplete for ls

complete_opt(text, line, begidx, endidx)

Autocomplete for options

complete_opt_allow_select_scan(text, *_)

Autocomplete for allow_select_scan option

complete_opt_display(text, *_)

Autocomplete for display option

complete_opt_format(text, *_)

Autocomplete for format option

complete_opt_lossy_json_float(text, *_)

Autocomplete for lossy_json_float option

complete_opt_pagesize(*_)

Autocomplete for pagesize option

complete_opt_width(*_)

Autocomplete for width option

complete_use(text, *_)

Autocomplete for use

complete_watch(text, *_)

Autocomplete for watch

completedefault(text, line, *_)

Autocomplete table names in queries

default(command)

This is an override of super class method.

do_EOF()

Exit

do_exit()

Exit

do_file(filename)

Read and execute a .dql file

do_local(host='localhost', port=8000)

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

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

do_ls(table: str = None) → None

List all tables or print details of one table

do_opt(*_args, **kwargs)

Get and set options

do_shell(arglist)

Run a shell command

do_throttle(*_args)

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(*args)

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(region)

Switch the AWS region

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

do_watch(*args)

Watch Dynamo tables consumed capacity

emptyline()

Called when an empty line is entered in response to the prompt.

If this method is not overridden, it repeats the last nonempty command entered.

formatter = None

getopt_default(option)

Default method to get an option

getopt_display()

Get value for display option

getopt_format()

Get value for format option

help_alter()

Print the help text for ALTER

help_analyze()

Print the help text for ANALYZE

help_create()

Print the help text for CREATE

help_delete()

Print the help text for DELETE

help_drop()

Print the help text for DROP

help_dump()

Print the help text for DUMP

help_explain()

Print the help text for EXPLAIN

help_help()

Print the help text for help

help_insert()

Print the help text for INSERT

help_load()

Print the help text for LOAD

help_opt()

Print the help text for options

help_scan()

Print the help text for SCAN

help_select()

Print the help text for SELECT

help_update()

Print the help text for UPDATE

initialize(region: str = 'us-west-1', host: str = None, port: int = 8000, config_dir: Optional[str] = None, session: Optional[Any] = None) → None

Set up the repl for execution.

load_config()

Load your configuration settings from a file

opt_allow_select_scan(allow)

Set option allow_select_scan

opt_display(display)

Set value for display option

opt_format(fmt)

Set value for format option

opt_lossy_json_float(lossy)

Set option lossy_json_float

opt_pagesize(pagesize)

Get or set the page size of the query output

opt_width(width)

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

postcmd(stop, line)

Hook method executed just after a command dispatch is finished.

run_command(command: str, use_json: bool = False, raise_exceptions: bool = False) → None

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

running = False

save_config()

Save the conf file

session = None

start()

Start running the interactive session (blocking)

update_prompt()

Update the prompt

dql.cli.exception_handler(engine)

It is a context manager which can handle exceptions and deal with them.

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>, 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.