schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/cloudquery/filetypes/v4/file-spec",
  "$ref": "#/$defs/FileSpec",
  "$defs": {
    "CSVSpec": {
      "properties": {
        "skip_header": {
          "type": "boolean",
          "description": "Specifies if the first line of a file should be the header.",
          "default": false
        },
        "delimiter": {
          "type": "string",
          "pattern": "^.$",
          "description": "Character that will be used as the delimiter.",
          "default": ","
        }
      },
      "additionalProperties": false,
      "type": "object",
      "description": "CloudQuery CSV file output spec."
    },
    "FileSpec": {
      "oneOf": [
        {
          "properties": {
            "format": {
              "type": "string",
              "const": "csv"
            },
            "format_spec": {
              "oneOf": [
                {
                  "$ref": "#/$defs/CSVSpec"
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        },
        {
          "properties": {
            "format": {
              "type": "string",
              "const": "json"
            },
            "format_spec": {
              "oneOf": [
                {
                  "$ref": "#/$defs/JSONSpec"
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        },
        {
          "properties": {
            "format": {
              "type": "string",
              "const": "parquet"
            },
            "format_spec": {
              "oneOf": [
                {
                  "$ref": "#/$defs/ParquetSpec"
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        }
      ],
      "properties": {
        "format": {
          "type": "string",
          "enum": [
            "csv",
            "json",
            "parquet"
          ],
          "description": "Output format."
        },
        "format_spec": {
          "oneOf": [
            {
              "anyOf": [
                {
                  "$ref": "#/$defs/CSVSpec"
                },
                {
                  "$ref": "#/$defs/JSONSpec"
                },
                {
                  "$ref": "#/$defs/ParquetSpec"
                }
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "compression": {
          "type": "string",
          "enum": [
            "",
            "gzip"
          ],
          "description": "Compression type.\nEmpty or missing stands for no compression."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "format"
      ]
    },
    "JSONSpec": {
      "additionalProperties": false,
      "type": "object",
      "description": "CloudQuery JSON file output spec."
    },
    "ParquetSpec": {
      "properties": {
        "version": {
          "type": "string",
          "enum": [
            "v1.0",
            "v2.4",
            "v2.6",
            "v2Latest"
          ],
          "description": "Parquet format version",
          "default": "v2Latest"
        },
        "root_repetition": {
          "type": "string",
          "enum": [
            "undefined",
            "required",
            "optional",
            "repeated"
          ],
          "description": "Root repetition",
          "default": "repeated"
        },
        "max_row_group_length": {
          "type": "integer",
          "minimum": 0,
          "description": "Max row group length",
          "default": 134217728
        }
      },
      "additionalProperties": false,
      "type": "object",
      "description": "CloudQuery Parquet file output spec."
    }
  }
}