Skip to main content

Config for mssql

Jobs that use the mssql adaptor may require authentication. A "credential" for the mssql adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "server": "something.database.windows.net",
  "database": "demo-db",
  "userName": "admin",
  "password": "@super(!)Password"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "properties": {
      "server": {
          "title": "Server URL",
          "description": "The database instance server URL or IP address",
          "type": "string",
          "minLength": 1,
          "examples": [
              "something.database.windows.net",
              "192.168.12.10"
          ]
      },
      "database": {
          "title": "Database",
          "type": "string",
          "description": "The database name",
          "minLength": 1,
          "examples": [
              "demo-db"
          ]
      },
      "userName": {
          "title": "Username",
          "type": "string",
          "description": "Username",
          "minLength": 1,
          "examples": [
              "admin"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Password",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@super(!)Password"
          ]
      },
      "port": {
          "title": "Port",
          "description": "Database instance port",
          "type": "integer",
          "default": 1433,
          "examples": [
              1432
          ]
      },
      "encrypt": {
          "type": "boolean",
          "title": "Encrypt",
          "description": "Encrypt connection to database",
          "default": true,
          "examples": [
              false
          ]
      },
      "trustServerCertificate": {
          "type": "boolean",
          "title": "Trust Server Certificate",
          "default": false,
          "description": "Trust self-signed certificates (not recommended for production)",
          "examples": [
              true
          ]
      },
      "requestTimeout": {
          "title": "Request Timeout",
          "description": "Number of milliseconds before a request times out. Default is 600000 (10 minutes). Set to 0 for no timeout.",
          "type": "integer",
          "default": 600000,
          "examples": [
              300000
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "server",
      "database",
      "userName",
      "password"
  ]
}