aboutsummaryrefslogtreecommitdiffstats
path: root/docs/abstract-schema-table.json
blob: f86b11d1da1efabdb76a879ed41f60cf7a01f277 (plain) (blame)
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
{
	"$schema": "https://json-schema.org/schema#",
	"description": "Abstract description of a mediawiki database table",
	"type": "object",
	"additionalProperties": false,
	"properties": {
		"name": {
			"type": "string",
			"description": "Name of the table"
		},
		"comment": {
			"type": "string",
			"description": "Comment describing the table"
		},
		"columns": {
			"type": "array",
			"additionalItems": false,
			"description": "Columns",
			"minItems": 1,
			"items": {
				"type": "object",
				"additionalProperties": false,
				"properties": {
					"name": {
						"type": "string",
						"description": "Name of the column"
					},
					"comment": {
						"type": "string",
						"description": "Comment describing the column"
					},
					"type": {
						"type": "string",
						"description": "Data type of the column",
						"enum": [
							"bigint",
							"binary",
							"blob",
							"boolean",
							"datetimetz",
							"decimal",
							"float",
							"integer",
							"mwenum",
							"mwtimestamp",
							"mwtinyint",
							"smallint",
							"string",
							"text"
						]
					},
					"options": {
						"type": "object",
						"description": "Additional options",
						"additionalProperties": false,
						"properties": {
							"autoincrement": {
								"type": "boolean",
								"description": "Indicates if the field should use an autoincremented value if no value was provided",
								"default": false
							},
							"default": {
								"type": [
									"number",
									"string",
									"null"
								],
								"description": "The default value of the column if no value was specified",
								"default": null
							},
							"fixed": {
								"type": "boolean",
								"description": "Indicates if the column should have a fixed length",
								"default": false
							},
							"length": {
								"type": "number",
								"description": "Length of the field.",
								"default": null,
								"minimum": 0
							},
							"notnull": {
								"type": "boolean",
								"description": "Indicates whether the column is nullable or not",
								"default": true
							},
							"unsigned": {
								"type": "boolean",
								"description": "If the column should be an unsigned integer",
								"default": false
							},
							"scale": {
								"type": "number",
								"description": "Exact number of decimal digits to be stored in a decimal type column",
								"default": 0
							},
							"precision": {
								"type": "number",
								"description": "Precision of a decimal type column that determines the overall maximum number of digits to be stored (including scale)",
								"default": 10
							},
							"PlatformOptions": {
								"type": "object",
								"additionalProperties": false,
								"properties": {
									"version": {
										"type": "boolean"
									}
								}
							},
							"CustomSchemaOptions": {
								"type": "object",
								"description": "Custom schema options",
								"additionalProperties": false,
								"properties": {
									"allowInfinite": {
										"type": "boolean"
									},
									"doublePrecision": {
										"type": "boolean"
									},
									"enum_values": {
										"type": "array",
										"description": "Values to use with type 'mwenum'",
										"additionalItems": false,
										"items": {
											"type": "string"
										},
										"uniqueItems": true
									}
								}
							}
						}
					}
				},
				"required": [
					"name",
					"type",
					"options"
				]
			}
		},
		"indexes": {
			"type": "array",
			"additionalItems": false,
			"description": "Indexes",
			"items": {
				"type": "object",
				"additionalProperties": false,
				"properties": {
					"name": {
						"type": "string",
						"description": "Index name"
					},
					"comment": {
						"type": "string",
						"description": "Comment describing the index"
					},
					"columns": {
						"type": "array",
						"additionalItems": false,
						"description": "Columns used by the index",
						"items": {
							"type": "string"
						},
						"uniqueItems": true
					},
					"unique": {
						"type": "boolean",
						"description": "If the index is unique",
						"default": false
					},
					"flags": {
						"type": "array",
						"items": {
							"type": "string",
							"enum": [
								"fulltext",
								"spatial"
							]
						},
						"uniqueItems": true
					},
					"options": {
						"type": "object",
						"properties": {
							"lengths": {
								"type": "array",
								"items": {
									"type": [
										"number",
										"null"
									]
								},
								"minItems": 1
							}
						}
					}
				},
				"required": [
					"name",
					"columns",
					"unique"
				]
			}
		},
		"pk": {
			"type": "array",
			"additionalItems": false,
			"description": "Array of column names used in the primary key",
			"items": {
				"type": "string"
			},
			"uniqueItems": true
		},
		"table_options": {
			"type": "array",
			"items": {
				"type": "string"
			}
		}
	},
	"required": [
		"name",
		"columns",
		"indexes"
	]
}