Command Line

For quick database scenario testing, we many of the DbObjects are available from command line interface as well. Run q2 db -h to get a full list. That’s a lot! To help narrow down your search, these commands can all be accessed via tab completion as well. For instance:

$ q2 db get_<tab>

get_api_stored_procs
get_audit_actions
get_countries
get_customers
get_data_feeds
get_disclaimers
get_linked_accounts
get_nav_nodes
get_navigation_styles
get_pfm_classifications
get_pfm_products
get_phone_number
get_third_party_data
get_third_party_data_elements
get_ui_config_property_data
get_ui_text
get_users
get_user_account_attributes
get_user_property_data
get_user_property_data_by_value
get_user_property_data_elements
get_vendors

Once you have chosen an operation, use the help menu to gather more information:

 $ q2 db get_ui_text -h
 usage: q2 db get_ui_text [-h] [--no-trunc] prefix

 positional arguments:
   prefix      Shortname prefix for Text Element

 optional arguments:
   -h, --help  show this help message and exit
   --no-trunc  Do not truncate TextValue of results

.. note::
     For a more thorough explanation of how to use the command line interface, refer to :ref:`cli`