Skip to content

Commit 8533868

Browse files
committed
added docs for sql_shell
1 parent a298721 commit 8533868

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/src/piccolo/projects_and_apps/included_apps.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,20 @@ Launches an iPython shell, and automatically imports all of your registered
7070
7171
piccolo shell run
7272
73+
sql_shell
74+
~~~~~~~~~
75+
76+
Launches a SQL shell (``psql`` or ``sqlite`` depending on the engine), using
77+
the connection settings defined in ``piccolo_conf.py``. It's convenient if you
78+
need to run raw SQL queries on your database.
79+
80+
.. code-block:: bash
81+
82+
piccolo sql_shell run
83+
84+
For it to work, the underlying command needs to be on the path (i.e. ``psql``
85+
or ``sqlite`` depending on which you're using).
86+
7387
-------------------------------------------------------------------------------
7488

7589
Optional includes

0 commit comments

Comments
 (0)