The shape of it
Five objects, and the rules between them.
Five objects, and the rules between them. Everything else in this guide is a task performed on one of them.
- Workspace holds everything else:
- Connections: registered servers.
- Target groups: lists of targets, each target one database on a connection.
- Projects: each holds its scripts, the
.sqlfiles. - Environments and variables: an environment supplies a value for a variable.
| Object | Belongs to | Holds | Answers |
|---|---|---|---|
| Workspace | — (top level) | Connections, target groups, environments, variable declarations, a list of projects | "Which estate am I working on?" |
| Connection | Workspace | A server, credentials, and a production flag | "Which server?" |
| Target | A target group | One connection plus one database name | "Which database on it?" |
| Target group | Workspace | An ordered set of targets | "Where does this run go?" |
| Project | Workspace | Scripts in run order, and execution settings | "What runs, and in what order?" |
| Script | Project | A .sql file on disk |
The SQL itself |
| Environment | Workspace | A value for each variable | "What are the variables worth this time?" |
| Variable | Workspace | A name and a type | "What may a script parameterise?" |