{
  "$schema": "/products/haybarn/functions/api/v1/function.schema.json",
  "schemaVersion": 1,
  "name": "json_extract_string",
  "schema": "main",
  "slug": "json_extract_string",
  "description": null,
  "category": "json",
  "kinds": [
    "scalar"
  ],
  "aliasOf": [],
  "snapshot": {
    "schemaVersion": 1,
    "id": "duckdb-2.0.0",
    "engine": "duckdb",
    "label": "DuckDB 2.0.0",
    "engineVersion": "v2.0.0",
    "sourceId": "d54cbbe3df",
    "source": "https://github.com/duckdb/duckdb/releases/tag/v2.0.0",
    "binarySha256": "4d5d001f4b0a16c16f1bc83338153a70bec7e58f0cae0eec4b44b9b9afa0bef0",
    "capturedAt": "2026-11-06T18:35:28.343Z",
    "requestedExtensions": [
      "core_functions",
      "icu",
      "json",
      "parquet"
    ],
    "loadedExtensions": [
      {
        "extension_name": "autocomplete",
        "extension_version": "v2.0.0",
        "installed_from": ""
      },
      {
        "extension_name": "core_functions",
        "extension_version": "v2.0.0",
        "installed_from": ""
      },
      {
        "extension_name": "icu",
        "extension_version": "v2.0.0",
        "installed_from": ""
      },
      {
        "extension_name": "json",
        "extension_version": "v2.0.0",
        "installed_from": ""
      },
      {
        "extension_name": "parquet",
        "extension_version": "v2.0.0",
        "installed_from": ""
      },
      {
        "extension_name": "shell",
        "extension_version": "v2.0.0",
        "installed_from": ""
      }
    ],
    "scope": "Built-in functions in the main schema, with the requested extensions loaded. Catalog visibility is not a guarantee of browser support."
  },
  "links": {
    "html": "/products/haybarn/functions/releases/duckdb-2.0.0/json_extract_string/",
    "markdown": "/products/haybarn/functions/releases/duckdb-2.0.0/json_extract_string/index.md",
    "json": "/products/haybarn/functions/api/v1/duckdb-2.0.0/functions/json_extract_string.json"
  },
  "interpretation": [
    "Choose a snapshot matching the target engine and build. The default is captured from the published Haybarn WASM package used by the browser playground. Historical native snapshots are also available.",
    "Availability is an observation in the recorded build and extension profile, not a guarantee of support in every installation or in WASM.",
    "Types and descriptions are declarations from duckdb_functions(). Binding can specialize result types. Null means not supplied by the catalog; do not invent defaults, optionality, argument mode, or table output columns.",
    "Raw parameter arrays preserve catalog order for scalar/aggregate/macro functions. Raw table arguments are alphabetical. Use callingConvention for engine-confirmed positional order and named arguments; null modes are unrecorded. Named does not mean optional. Macro defaults and special named variadic behavior are not supplied by duckdb_functions().",
    "Catalog examples are source material and may require data or extensions. runnableExamples contains separately verified SQL for the pinned WASM package; sample-data adaptations and guide examples are labeled separately.",
    "Guide annotations and recipes are separate editorial content. The browser runner always uses Haybarn WASM 2.0.0-rc12, independently of the documentation snapshot.",
    "All URLs beginning with / are relative to the origin hosting this document. Exports require no JavaScript, cookies, API key, or browser engine."
  ],
  "overloads": [
    {
      "id": "overload-9af41c846676eb88",
      "url": "/products/haybarn/functions/releases/duckdb-2.0.0/json_extract_string/#overload-9af41c846676eb88",
      "signature": "json_extract_string(json: JSON, index: BIGINT) → VARCHAR",
      "parameterOrder": "catalog-order",
      "callingConvention": {
        "source": null,
        "parameters": [
          {
            "name": "json",
            "type": "JSON",
            "mode": null,
            "position": null
          },
          {
            "name": "index",
            "type": "BIGINT",
            "mode": null,
            "position": null
          }
        ],
        "positional": null,
        "named": null,
        "variadic": null,
        "evidence": null
      },
      "syntax": {
        "kind": "function",
        "operator": null
      },
      "catalog": {
        "schema_name": "main",
        "function_name": "json_extract_string",
        "function_type": "scalar",
        "description": null,
        "comment": null,
        "return_type": "VARCHAR",
        "parameters": [
          "json",
          "index"
        ],
        "parameter_types": [
          "JSON",
          "BIGINT"
        ],
        "varargs": null,
        "macro_definition": null,
        "has_side_effects": false,
        "internal": true,
        "examples": [],
        "stability": "CONSISTENT",
        "categories": [],
        "alias_of": null
      }
    },
    {
      "id": "overload-67a06b42be682a9c",
      "url": "/products/haybarn/functions/releases/duckdb-2.0.0/json_extract_string/#overload-67a06b42be682a9c",
      "signature": "json_extract_string(json: VARCHAR, index: BIGINT) → VARCHAR",
      "parameterOrder": "catalog-order",
      "callingConvention": {
        "source": null,
        "parameters": [
          {
            "name": "json",
            "type": "VARCHAR",
            "mode": null,
            "position": null
          },
          {
            "name": "index",
            "type": "BIGINT",
            "mode": null,
            "position": null
          }
        ],
        "positional": null,
        "named": null,
        "variadic": null,
        "evidence": null
      },
      "syntax": {
        "kind": "function",
        "operator": null
      },
      "catalog": {
        "schema_name": "main",
        "function_name": "json_extract_string",
        "function_type": "scalar",
        "description": null,
        "comment": null,
        "return_type": "VARCHAR",
        "parameters": [
          "json",
          "index"
        ],
        "parameter_types": [
          "VARCHAR",
          "BIGINT"
        ],
        "varargs": null,
        "macro_definition": null,
        "has_side_effects": false,
        "internal": true,
        "examples": [],
        "stability": "CONSISTENT",
        "categories": [],
        "alias_of": null
      }
    },
    {
      "id": "overload-b5ec3e2a5b6b8d04",
      "url": "/products/haybarn/functions/releases/duckdb-2.0.0/json_extract_string/#overload-b5ec3e2a5b6b8d04",
      "signature": "json_extract_string(json: JSON, path: VARCHAR) → VARCHAR",
      "parameterOrder": "catalog-order",
      "callingConvention": {
        "source": null,
        "parameters": [
          {
            "name": "json",
            "type": "JSON",
            "mode": null,
            "position": null
          },
          {
            "name": "path",
            "type": "VARCHAR",
            "mode": null,
            "position": null
          }
        ],
        "positional": null,
        "named": null,
        "variadic": null,
        "evidence": null
      },
      "syntax": {
        "kind": "function",
        "operator": null
      },
      "catalog": {
        "schema_name": "main",
        "function_name": "json_extract_string",
        "function_type": "scalar",
        "description": null,
        "comment": null,
        "return_type": "VARCHAR",
        "parameters": [
          "json",
          "path"
        ],
        "parameter_types": [
          "JSON",
          "VARCHAR"
        ],
        "varargs": null,
        "macro_definition": null,
        "has_side_effects": false,
        "internal": true,
        "examples": [],
        "stability": "CONSISTENT",
        "categories": [],
        "alias_of": null
      }
    },
    {
      "id": "overload-b75ba938a0e8802c",
      "url": "/products/haybarn/functions/releases/duckdb-2.0.0/json_extract_string/#overload-b75ba938a0e8802c",
      "signature": "json_extract_string(json: JSON, path: VARCHAR[]) → VARCHAR[]",
      "parameterOrder": "catalog-order",
      "callingConvention": {
        "source": null,
        "parameters": [
          {
            "name": "json",
            "type": "JSON",
            "mode": null,
            "position": null
          },
          {
            "name": "path",
            "type": "VARCHAR[]",
            "mode": null,
            "position": null
          }
        ],
        "positional": null,
        "named": null,
        "variadic": null,
        "evidence": null
      },
      "syntax": {
        "kind": "function",
        "operator": null
      },
      "catalog": {
        "schema_name": "main",
        "function_name": "json_extract_string",
        "function_type": "scalar",
        "description": null,
        "comment": null,
        "return_type": "VARCHAR[]",
        "parameters": [
          "json",
          "path"
        ],
        "parameter_types": [
          "JSON",
          "VARCHAR[]"
        ],
        "varargs": null,
        "macro_definition": null,
        "has_side_effects": false,
        "internal": true,
        "examples": [],
        "stability": "CONSISTENT",
        "categories": [],
        "alias_of": null
      }
    },
    {
      "id": "overload-a5400bdfb8672446",
      "url": "/products/haybarn/functions/releases/duckdb-2.0.0/json_extract_string/#overload-a5400bdfb8672446",
      "signature": "json_extract_string(json: VARCHAR, path: VARCHAR) → VARCHAR",
      "parameterOrder": "catalog-order",
      "callingConvention": {
        "source": null,
        "parameters": [
          {
            "name": "json",
            "type": "VARCHAR",
            "mode": null,
            "position": null
          },
          {
            "name": "path",
            "type": "VARCHAR",
            "mode": null,
            "position": null
          }
        ],
        "positional": null,
        "named": null,
        "variadic": null,
        "evidence": null
      },
      "syntax": {
        "kind": "function",
        "operator": null
      },
      "catalog": {
        "schema_name": "main",
        "function_name": "json_extract_string",
        "function_type": "scalar",
        "description": null,
        "comment": null,
        "return_type": "VARCHAR",
        "parameters": [
          "json",
          "path"
        ],
        "parameter_types": [
          "VARCHAR",
          "VARCHAR"
        ],
        "varargs": null,
        "macro_definition": null,
        "has_side_effects": false,
        "internal": true,
        "examples": [],
        "stability": "CONSISTENT",
        "categories": [],
        "alias_of": null
      }
    },
    {
      "id": "overload-5147a241b5c077ee",
      "url": "/products/haybarn/functions/releases/duckdb-2.0.0/json_extract_string/#overload-5147a241b5c077ee",
      "signature": "json_extract_string(json: VARCHAR, path: VARCHAR[]) → VARCHAR[]",
      "parameterOrder": "catalog-order",
      "callingConvention": {
        "source": null,
        "parameters": [
          {
            "name": "json",
            "type": "VARCHAR",
            "mode": null,
            "position": null
          },
          {
            "name": "path",
            "type": "VARCHAR[]",
            "mode": null,
            "position": null
          }
        ],
        "positional": null,
        "named": null,
        "variadic": null,
        "evidence": null
      },
      "syntax": {
        "kind": "function",
        "operator": null
      },
      "catalog": {
        "schema_name": "main",
        "function_name": "json_extract_string",
        "function_type": "scalar",
        "description": null,
        "comment": null,
        "return_type": "VARCHAR[]",
        "parameters": [
          "json",
          "path"
        ],
        "parameter_types": [
          "VARCHAR",
          "VARCHAR[]"
        ],
        "varargs": null,
        "macro_definition": null,
        "has_side_effects": false,
        "internal": true,
        "examples": [],
        "stability": "CONSISTENT",
        "categories": [],
        "alias_of": null
      }
    }
  ],
  "editorial": {
    "argumentNotes": [],
    "usage": null,
    "recipes": [
      {
        "id": "read-json",
        "title": "Find the value inside the document.",
        "description": "Extract a JSON field directly as text, ready to use in the rest of your query.",
        "sql": "SELECT json_extract_string(\n  '{\"farm\":\"Willow Creek\",\"crops\":[\"apples\",\"pears\"]}',\n  '$.farm'\n) AS farm;",
        "source": "guide-recipe",
        "verification": null,
        "intendedRuntime": {
          "engine": "haybarn-wasm",
          "packageVersion": "2.0.0-rc12"
        }
      }
    ]
  },
  "examples": [],
  "translations": [],
  "runnableExamples": [],
  "additionalDocumentation": [
    {
      "title": "JSON Processing Functions",
      "url": "https://duckdb.org/docs/current/data/json/json_functions"
    }
  ],
  "availability": [
    {
      "snapshot": "haybarn-2.0.0-rc12",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [
        "overload-9af41c846676eb88",
        "overload-b5ec3e2a5b6b8d04",
        "overload-b75ba938a0e8802c",
        "overload-67a06b42be682a9c",
        "overload-a5400bdfb8672446",
        "overload-5147a241b5c077ee"
      ],
      "json": "/products/haybarn/functions/api/v1/haybarn-2.0.0-rc12/functions/json_extract_string.json"
    },
    {
      "snapshot": "haybarn-2.0.0-rc11",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [
        "overload-9af41c846676eb88",
        "overload-b5ec3e2a5b6b8d04",
        "overload-b75ba938a0e8802c",
        "overload-67a06b42be682a9c",
        "overload-a5400bdfb8672446",
        "overload-5147a241b5c077ee"
      ],
      "json": "/products/haybarn/functions/api/v1/haybarn-2.0.0-rc11/functions/json_extract_string.json"
    },
    {
      "snapshot": "haybarn-2.0.0-rc8",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [
        "overload-9af41c846676eb88",
        "overload-b5ec3e2a5b6b8d04",
        "overload-b75ba938a0e8802c",
        "overload-67a06b42be682a9c",
        "overload-a5400bdfb8672446",
        "overload-5147a241b5c077ee"
      ],
      "json": "/products/haybarn/functions/api/v1/haybarn-2.0.0-rc8/functions/json_extract_string.json"
    },
    {
      "snapshot": "haybarn-1.5.5-rc3",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [],
      "json": "/products/haybarn/functions/api/v1/haybarn-1.5.5-rc3/functions/json_extract_string.json"
    },
    {
      "snapshot": "haybarn-1.5.6-rc6",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [],
      "json": "/products/haybarn/functions/api/v1/haybarn-1.5.6-rc6/functions/json_extract_string.json"
    },
    {
      "snapshot": "duckdb-2.0.0",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [
        "overload-9af41c846676eb88",
        "overload-b5ec3e2a5b6b8d04",
        "overload-b75ba938a0e8802c",
        "overload-67a06b42be682a9c",
        "overload-a5400bdfb8672446",
        "overload-5147a241b5c077ee"
      ],
      "json": "/products/haybarn/functions/api/v1/duckdb-2.0.0/functions/json_extract_string.json"
    },
    {
      "snapshot": "duckdb-1.5.6",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [],
      "json": "/products/haybarn/functions/api/v1/duckdb-1.5.6/functions/json_extract_string.json"
    },
    {
      "snapshot": "duckdb-1.5.5",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [],
      "json": "/products/haybarn/functions/api/v1/duckdb-1.5.5/functions/json_extract_string.json"
    },
    {
      "snapshot": "duckdb-1.4.4",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [],
      "json": "/products/haybarn/functions/api/v1/duckdb-1.4.4/functions/json_extract_string.json"
    },
    {
      "snapshot": "duckdb-1.3.2",
      "observed": true,
      "overloadCount": 6,
      "matchingOverloadIds": [],
      "json": "/products/haybarn/functions/api/v1/duckdb-1.3.2/functions/json_extract_string.json"
    }
  ]
}
