NAME
TaskPipe::Tool::Command_GenerateSchema - command to generate taskpipe schema files
PURPOSE
generate the schema files needed by taskpipe to interact with the database
DESCRIPTION
TaskPipe uses the DBIx::Class ORM to interface with your database(s). TaskPipe uses one general purpose global database and one project database for each project. See the help for deploy tables
for more information on the organisation of database tables.
Global Schema Files
After running setup
you will need to run generate schema
to create the schema files needed for your global database. You need to have already successfully deployed global tables (see deploy tables
). Then run
taskpipe generate schema --scope=global
Project Schema Files
Each time you make changes to your project database, you need to run generate schema
over your project database before you can run your plan again.
Schema files are generated for
the tables in your project which taskpipe autogenerated, and which taskpipe uses for caching (these are the
cache
tablesthe tables you created manually as part of your project (these are your
plan
tables).
To run generate schema
over your project database, make sure your tables are deployed (see deploy tables
). Then run
taskpipe generate schema --project=myproject
If you set a default project in your global config file, and you want to run generate schema
over the default project then you can just type
taskpipe generate schema
OPTIONS
- scope
-
Specify
project
to generate the schema over the tables in your project (both cache and plan tables) - orglobal
to generate the global schema
AUTHOR
Tom Gracey <tomgracey@gmail.com>
COPYRIGHT AND LICENSE
Copyright (c) Tom Gracey 2018
TaskPipe is free software, licensed under
The GNU Public License Version 3