Piccolo ships with a handy command called
playground, which is a great way
to learn the basics.
piccolo playground run
You can follow along with the tutorials without first learning advanced concepts like migrations.
It’s a nice place to experiment with querying / inserting / deleting data using Piccolo, no matter how experienced you are.
Each time you launch the playground it flushes out the existing tables and rebuilds them, so don’t use it for anything permanent!
SQLite is used by default, which provides a zero config way of getting started.
piccolo.sqlite file will get created in the current directory.
To see how to use the playground with Postgres, and other advanced usage, see Advanced Playground Usage.
The schema generated in the playground represents fictional bands and their concerts.
When the playground is started it prints out the available tables.
Give these queries a go:
await Band.select() await Band.objects() await Band.select(Band.name) await Band.select(Band.name, Band.manager.name)
Tab completion is your friend¶
Piccolo was designed to make tab completion available in as many situations
as possible. Use it to find the column names for a table (e.g.
and the different query types (e.g.
Using tab completion will help avoid errors, and speed up your coding.