database/json-structure/database-instance-structure.json at main · api-evangelist/database · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/database/refs/heads/main/json-structure/database-instance-structure.json",
  "name": "DatabaseInstance",
  "description": "Represents a managed database instance provisioned through a database-as-a-service or managed database API.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Provider-assigned identifier for the database instance.",
      "example": "br-young-snow-12345678"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the database instance.",
      "example": "production-orders"
    },
    "provider": {
      "type": "string",
      "description": "Name of the managed database provider hosting this instance.",
      "example": "Neon"
    },
    "engine": {
      "type": "string",
      "description": "Underlying database engine.",
      "enum": [
        "postgresql",
        "mysql",
        "mongodb",
        "cassandra",
        "redis",
        "dynamodb",
        "clickhouse",
        "snowflake",
        "bigquery",
        "redshift",
        "databricks",
        "influxdb",
        "timescaledb",
        "questdb",
        "neo4j",
        "fauna",
        "pinecone",
        "weaviate",
        "qdrant",
        "milvus",
        "other"
      ],
      "example": "postgresql"
    },
    "engine_version": {
      "type": "string",
      "description": "Version string of the database engine.",
      "example": "16.2"
    },
    "category": {
      "type": "string",
      "description": "High-level category of the database.",
      "enum": [
        "relational",
        "document",
        "key-value",
        "wide-column",
        "graph",
        "vector",
        "time-series",
        "search",
        "data-warehouse",
        "lakehouse",
        "multi-model"
      ],
      "example": "relational"
    },
    "region": {
      "type": "string",
      "description": "Cloud region where the instance is hosted.",
      "example": "us-east-1"
    },
    "endpoint": {
      "type": "object",
      "description": "Connection endpoint information for the database.",
      "properties": {
        "host": {
          "type": "string",
          "example": "ep-young-snow-12345678.us-east-2.aws.neon.tech"
        },
        "port": {
          "type": "int32",
          "example": 5432
        },
        "protocol": {
          "type": "string",
          "enum": ["tcp", "tls", "https", "grpc"],
          "example": "tls"
        },
        "http_query_url": {
          "type": "uri",
          "description": "HTTP endpoint for SQL-over-HTTP query execution, when supported.",
          "example": "https://ep-young-snow-12345678.us-east-2.aws.neon.tech/sql"
        }
      }
    },
    "tier": {
      "type": "string",
      "description": "Compute tier or plan for the instance.",
      "enum": [
        "free",
        "developer",
        "standard",
        "production",
        "enterprise",
        "serverless"
      ],
      "example": "serverless"
    },
    "storage_gb": {
      "type": "number",
      "description": "Provisioned or used storage in gigabytes.",
      "example": 10.5
    },
    "compute_units": {
      "type": "number",
      "description": "Active compute units, vCPUs, or instance size.",
      "example": 0.25
    },
    "high_availability": {
      "type": "boolean",
      "description": "Whether the instance has multi-zone or multi-region high availability enabled.",
      "example": true
    },
    "branch": {
      "type": "string",
      "description": "Branch or environment name, for platforms that support database branching.",
      "example": "main"
    },
    "status": {
      "type": "string",
      "enum": [
        "provisioning",
        "active",
        "paused",
        "suspended",
        "deleting",
        "failed"
      ],
      "example": "active"
    },
    "created_at": {
      "type": "datetime",
      "example": "2026-05-19T14:00:00Z"
    },
    "tags": {
      "type": "array",
      "description": "User-defined tags for organizing instances.",
      "items": {
        "type": "string"
      },
      "example": [
        "production",
        "orders",
        "tenant-acme"
      ]
    }
  },
  "required": [
    "name",
    "provider",
    "engine",
    "category",
    "status"
  ]
}