Skip to content

Commit 076b747

Browse files
committed
add docs
1 parent 7dae161 commit 076b747

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/src/piccolo/projects_and_apps/included_apps.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,21 @@ Lets you create a new ``piccolo_conf.py`` file. See :ref:`PiccoloProjects`.
6060
6161
piccolo project new
6262
63+
schema
64+
~~~~~~
65+
66+
Lets you auto generate Piccolo ``Table`` classes from an existing database.
67+
Make sure the credentials in ``piccolo_conf.py`` are for the database you're
68+
interested in, then run the following:
69+
70+
.. code-block:: bash
71+
72+
piccolo schema generate > tables.py
73+
74+
.. warning:: This feature is still a work in progress. However, even in it's
75+
current form it will save you a lot of time. Make sure you check the
76+
generated code to make sure it's correct.
77+
6378
shell
6479
~~~~~
6580

0 commit comments

Comments
 (0)