evolution/examples/full/res/template_schema.json at main · firelink-data/evolution · 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
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://github.com/firelink-data/evolution/tree/main/resources/template_schema.json",
    "title": "Fixed-length file",
    "description": "The specification for a valid fixed-length file (.flf).",
    "type": "object",
    "properties": {
        "name": {
            "description": "The name of the schema.",
            "type": "string"
        },
        "version": {
            "description": "The version of the schema.",
            "type": "integer"
        },
        "columns": {
            "description": "The fixed-length columns of the file.",
            "type": "array",
            "items": {
                "description": "A fixed-length column.",
                "type": "object",
                "properties": {
                    "name": {
                        "description": "The name of the column.",
                        "type": "string"
                    },
                    "offset": {
                        "description": "The offset from the start of a row (in runes).",
                        "type": "integer"
                    },
                    "length": {
                        "description": "The length of the column (in runes).",
                        "type": "integer"
                    },
                    "dtype": {
                        "description": "The datatype of the column.",
                        "type": "string",
                        "enum": [
                            "Boolean",
                            "Float16",
                            "Float32",
                            "Float64",
                            "Int16",
                            "Int32",
                            "Int64",
                            "Utf8",
                            "LargeUtf8"
                        ]
                    },
                    "alignment": {
                        "description": "The alignment mode of the column.",
                        "type": "string",
                        "enum": [ "Left", "Right", "Center" ]
                    },
                    "pad_symbol": {
                        "description": "The name of the padding symbol used in the column.",
                        "type": "string",
                        "enum": [
                            "Hyphen",
                            "Underscore",
                            "Dot",
                            "Comma",
                            "Colon",
                            "Semicolon",
                            "Hashtag",
                            "Backslash",
                            "Forwardslash",
                            "Asterisk",
                            "Whitespace",
                            "Zero",
                            "One",
                            "Two",
                            "Three",
                            "Four",
                            "Five",
                            "Six",
                            "Seven",
                            "Eight",
                            "Nine"
                        ]
                    },
                    "is_nullable": {
                        "description": "Whether or not the values in the column can be null.",
                        "type": "boolean"
                    }
                },
                "required": [
                    "name",
                    "offset",
                    "length",
                    "dtype",
                    "is_nullable"
                ]
            },
            "minItems": 1
        }
    },
    "required": [ "name", "version", "columns" ]
}