connection.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "definitions": {
    "database": {
      "title": "Database",
      "type": "string",
      "minLength": 1
    },
    "username": {
      "title": "Username",
      "type": "string",
      "minLength": 1
    },
    "usePassword": {
      "title": "Use password",
      "type": "string",
      "enum": [
        "SQLTools Driver Credentials",
        "Ask on connect",
        "Use empty password",
        "Save as plaintext in settings",
        "IAM authentication"
      ],
      "default": "SQLTools Driver Credentials"
    },
    "password": {
      "title": "Password",
      "type": "string",
      "minLength": 1
    },
    "credentialsFile": {
      "title": "GCP Credentials File",
      "type": "string",
      "minLength": 1
    },
    "impersonatedServiceAccount": {
      "title": "Impersonated Service Account",
      "type": "string",
      "minLength": 1
    }
  },
  "properties": {
    "instanceConnectionName": {
      "title": "Instance Connection Name",
      "type": "string",
      "minLength": 1
    },
    "database": {
      "$ref": "#/definitions/database"
    },
    "username": {
      "$ref": "#/definitions/username"
    },
    "usePassword": {
      "$ref": "#/definitions/usePassword"
    },
    "credentialsFile": {
      "$ref": "#/definitions/credentialsFile"
    },
    "impersonatedServiceAccount": {
      "$ref": "#/definitions/impersonatedServiceAccount"
    },
    "connectionTimeout": {
      "title": "Connection Timeout",
      "type": "integer",
      "minimum": 0
    },
    "pgOptions": {
      "type": "object",
      "title": "node-pg driver specific options",
      "description": "You can get more info here: https://node-postgres.com/api/pool",
      "properties": {
        "statement_timeout": {
          "type": "number"
        },
        "query_timeout": {
          "type": "number"
        },
        "connectionTimeoutMillis": {
          "type": "number"
        },
        "idleTimeoutMillis": {
          "type": "number"
        },
        "max": {
          "type": "number"
        }
      }
    }
  },
  "dependencies": {
    "usePassword": {
      "oneOf": [
        {
          "properties": {
            "usePassword": {
              "enum": ["Ask on connect"]
            },
            "askForPassword": {
              "type": "boolean",
              "default": true
            }
          }
        },
        {
          "properties": {
            "usePassword": {
              "enum": ["Use empty password"]
            }
          }
        },
        {
          "properties": {
            "usePassword": {
              "enum": ["Save as plaintext in settings"]
            },
            "password": {
              "$ref": "#/definitions/password"
            }
          },
          "required": ["password"]
        },
        {
          "properties": {
            "usePassword": {
              "enum": ["SQLTools Driver Credentials"]
            }
          }
        },
        {
          "properties": {
            "usePassword": {
              "enum": ["IAM authentication"]
            }
          }
        }
      ]
    }
  },
  "required": ["instanceConnectionName", "database", "username"]
}