Plan Endpoint | POST /v1/projects/-/plans |
Sheet Endpoint | POST /v1/projects/-/sheets |
Plan
contains one or multiple change statements and dictate how they are grouped and ordered. The plan layouts how to execute the change statements.
Sheet
object. Each Sheet
contains one or more change statements.Step
. Each Step
specifies one or more changes units. A change unit specifies the SQL statements via Sheet
and the target database.Code sample: https://github.com/bytebase/create-plan-from-release-action/blob/main/src/main.ts
Inside the plan, create one or more sheets if needed. Then you orchestrate the order via Steps:
Each spec corresponds to a task. A task is a single change unit. Tasks run in the following order:
Tasks from the late stage must wait until all the tasks from the previous stage reach to the end state.
For tasks belong to the same stage:
If you want to enforce strict running order inside a step/stage. You can specify dependsOnSpecs
with the previous task.
Plan Endpoint | POST /v1/projects/-/plans |
Sheet Endpoint | POST /v1/projects/-/sheets |
Plan
contains one or multiple change statements and dictate how they are grouped and ordered. The plan layouts how to execute the change statements.
Sheet
object. Each Sheet
contains one or more change statements.Step
. Each Step
specifies one or more changes units. A change unit specifies the SQL statements via Sheet
and the target database.Code sample: https://github.com/bytebase/create-plan-from-release-action/blob/main/src/main.ts
Inside the plan, create one or more sheets if needed. Then you orchestrate the order via Steps:
Each spec corresponds to a task. A task is a single change unit. Tasks run in the following order:
Tasks from the late stage must wait until all the tasks from the previous stage reach to the end state.
For tasks belong to the same stage:
If you want to enforce strict running order inside a step/stage. You can specify dependsOnSpecs
with the previous task.