Skip to content
Proud to collaborate with Microsoft for Startups

gcp.sql.database.ensure ​

Create or return a PostgreSQL database inside a Cloud SQL instance.

Overview ​

PropertyValue
Workflow typeLinear
LibraryBase-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—GCP CloudConnection UUID.
project_idstringNo—GCP project override.
instance_idstringYes—Cloud SQL instance id.
database_namestringYes—Database name.
charsetstringNo—Database charset.
collationstringNo—Database collation.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—Echoed connection UUID.
project_idstringNo—Effective project.
instance_idstringNo—Cloud SQL instance id.
database_namestringNo—Database name.
createdbooleanNo—True when created during this run.
databasejsonNo—Sanitized database response.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Engine failed layer.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
ensuringNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecuteensuring—
ensuringcompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "gcp.sql.database.ensure",
  "initial_data": {
    "connection_uuid": "value",
    "instance_id": "value",
    "database_name": "value"
  }
}