Skip to main content

Config for motherduck

Jobs that use the motherduck adaptor may require authentication. A "credential" for the motherduck 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.

{
  "token": "token_abc123..."
}

Full Schema​

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

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "token": {
          "title": "MotherDuck Token",
          "type": "string",
          "description": "MotherDuck authentication token",
          "writeOnly": true,
          "examples": [
              "token_abc123..."
          ]
      },
      "database": {
          "title": "Database Name",
          "type": "string",
          "description": "MotherDuck database name",
          "examples": [
              "my_database",
              "analytics_warehouse",
              "production_db"
          ]
      },
      "sessionHint": {
          "title": "Session Hint",
          "type": "string",
          "description": "Optional session hint for MotherDuck read scaling",
          "examples": [
              "primary",
              "readonly",
              "analytics"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "token"
  ]
}