Get v1projects plans 1

{
  "name": "<string>",
  "state": "STATE_UNSPECIFIED",
  "issue": "<string>",
  "rollout": "<string>",
  "title": "<string>",
  "description": "<string>",
  "specs": [
    {
      "id": "<string>",
      "createDatabaseConfig": {
        "target": "<string>",
        "database": "<string>",
        "table": "<string>",
        "characterSet": "<string>",
        "collation": "<string>",
        "cluster": "<string>",
        "owner": "<string>",
        "environment": "<string>"
      },
      "changeDatabaseConfig": {
        "targets": [
          "<string>"
        ],
        "sheet": "<string>",
        "release": "<string>",
        "type": "DATABASE_CHANGE_TYPE_UNSPECIFIED",
        "ghostFlags": {},
        "enablePriorBackup": true,
        "enableGhost": true
      },
      "exportDataConfig": {
        "targets": [
          "<string>"
        ],
        "sheet": "<string>",
        "format": "FORMAT_UNSPECIFIED",
        "password": "<string>"
      }
    }
  ],
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "planCheckRunStatusCount": {},
  "deployment": {
    "environments": [
      "<string>"
    ],
    "databaseGroupMappings": [
      {
        "databaseGroup": "<string>",
        "databases": [
          "<string>"
        ]
      }
    ]
  }
}

GET

projects

{project}

plans

{plan}

{
  "name": "<string>",
  "state": "STATE_UNSPECIFIED",
  "issue": "<string>",
  "rollout": "<string>",
  "title": "<string>",
  "description": "<string>",
  "specs": [
    {
      "id": "<string>",
      "createDatabaseConfig": {
        "target": "<string>",
        "database": "<string>",
        "table": "<string>",
        "characterSet": "<string>",
        "collation": "<string>",
        "cluster": "<string>",
        "owner": "<string>",
        "environment": "<string>"
      },
      "changeDatabaseConfig": {
        "targets": [
          "<string>"
        ],
        "sheet": "<string>",
        "release": "<string>",
        "type": "DATABASE_CHANGE_TYPE_UNSPECIFIED",
        "ghostFlags": {},
        "enablePriorBackup": true,
        "enableGhost": true
      },
      "exportDataConfig": {
        "targets": [
          "<string>"
        ],
        "sheet": "<string>",
        "format": "FORMAT_UNSPECIFIED",
        "password": "<string>"
      }
    }
  ],
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "planCheckRunStatusCount": {},
  "deployment": {
    "environments": [
      "<string>"
    ],
    "databaseGroupMappings": [
      {
        "databaseGroup": "<string>",
        "databases": [
          "<string>"
        ]
      }
    ]
  }
}

Path Parameters

project

string

required

The project id.

plan

string

required

The plan id.

Response

name

string

The name of the plan. plan is a system generated ID. Format: projects/{project}/plans/{plan}

state

enum<string>

The state of the plan.

Available options:

STATE_UNSPECIFIED,

ACTIVE,

DELETED

issue

string

The issue associated with the plan. Can be empty. Format: projects/{project}/issues/{issue}

rollout

string

The rollout associated with the plan. Can be empty. Format: projects/{project}/rollouts/{rollout}

title

string

The title of the plan.

description

string

The description of the plan.

specs

object[]

The deployment specs for the plan.

Show child attributes

specs.id

string

A UUID4 string that uniquely identifies the Spec.

specs.createDatabaseConfig

object

Show child attributes

specs.createDatabaseConfig.target

string

required

The resource name of the instance on which the database is created. Format: instances/{instance}

specs.createDatabaseConfig.database

string

required

The name of the database to create.

specs.createDatabaseConfig.table

string

table is the name of the table, if it is not empty, Bytebase should create a table after creating the database. For example, in MongoDB, it only creates the database when we first store data in that database.

specs.createDatabaseConfig.characterSet

string

character_set is the character set of the database.

specs.createDatabaseConfig.collation

string

collation is the collation of the database.

specs.createDatabaseConfig.cluster

string

cluster is the cluster of the database. This is only applicable to ClickHouse for "ON CLUSTER <>".

specs.createDatabaseConfig.owner

string

owner is the owner of the database. This is only applicable to Postgres for "WITH OWNER <>".

specs.createDatabaseConfig.environment

string

The environment resource. Format: environments/prod where prod is the environment resource ID.

specs.changeDatabaseConfig

object

Show child attributes

specs.changeDatabaseConfig.targets

string[]

The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}].

specs.changeDatabaseConfig.sheet

string

The resource name of the sheet. Format: projects/{project}/sheets/{sheet}

specs.changeDatabaseConfig.release

string

The resource name of the release. Format: projects/{project}/releases/{release}

specs.changeDatabaseConfig.type

enum<string>

Type is the database change type.

Available options:

DATABASE_CHANGE_TYPE_UNSPECIFIED,

MIGRATE,

SDL

specs.changeDatabaseConfig.ghostFlags

object

Show child attributes

specs.changeDatabaseConfig.ghostFlags.{key}

string

specs.changeDatabaseConfig.enablePriorBackup

boolean

If set, a backup of the modified data will be created automatically before any changes are applied.

specs.changeDatabaseConfig.enableGhost

boolean

Whether to use gh-ost for online schema migration.

specs.exportDataConfig

object

Show child attributes

specs.exportDataConfig.targets

string[]

The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}].

specs.exportDataConfig.sheet

string

The resource name of the sheet. Format: projects/{project}/sheets/{sheet}

specs.exportDataConfig.format

enum<string>

The format of the exported file.

Available options:

FORMAT_UNSPECIFIED,

CSV,

JSON,

SQL,

XLSX

specs.exportDataConfig.password

string

The zip password provide by users. Leave it empty if no needs to encrypt the zip file.

creator

string

Format: users/[email protected]

createTime

string<date-time>

updateTime

string<date-time>

planCheckRunStatusCount

object

The status count of the latest plan check runs. Keys are:

SUCCESS
WARNING
ERROR
RUNNING

Show child attributes

planCheckRunStatusCount.{key}

integer<int32>

deployment

object

Show child attributes

deployment.environments

string[]

The environments deploy order.

deployment.databaseGroupMappings

object[]

The database group mapping.

Show child attributes

deployment.databaseGroupMappings.databaseGroup

string

Format: projects/{project}/databaseGroups/{databaseGroup}.

deployment.databaseGroupMappings.databases

string[]

Format: instances/{instance-id}/databases/{database-name}.

Post v1projects plans Patch v1projects plans

ProjectService

ActuatorService

AuditLogService

AuthService

CelService

OrgPolicyService

GroupService

IdentityProviderService

InstanceService

DatabaseService

DatabaseCatalogService

RevisionService

SQLService

InstanceRoleService

DatabaseGroupService

IssueService

PlanService

ReleaseService

RolloutService

SheetService

ReviewConfigService

RoleService

SettingService

SubscriptionService

UserService

WorksheetService

WorkspaceService

Path Parameters

Response