JSON_EXTRACT_PATH_TEXT 函數

JSON_EXTRACT_PATH_TEXT 函數傳回 JSON 字串中由一連串路徑元素所參考的鍵-值對的值。JSON 路徑巢狀最深可達五層。路徑元素區分大小寫。如果 JSON 字串中沒有路徑元素，JSON_EXTRACT_PATH_TEXT 會傳回 NULL。

如果 null_if_invalid 引數設為 true，且 JSON 字串無效，此函數會傳回 NULL，而非傳回錯誤。

如需有關其他 JSON 函數的資訊，請參閱JSON 函數。如需使用 JSON 的相關資訊，請參閱從 JSON 格式 COPY。

語法

JSON_EXTRACT_PATH_TEXT('json_string', 'path_elem' [,'path_elem'[, …] ] [, null_if_invalid ] )

引數

json_string

格式正確的 JSON 字串。

path_elem

JSON 字串中的路徑元素。需要一個路徑元素。可指定其他路徑元素，最深可達五層。

null_if_invalid

(選用) BOOLEAN 值，指定輸入 JSON 字串無效時是否傳回 NULL，而非傳回錯誤。若要在 JSON 無效時傳回 NULL，請指定 true (t)。若要在 JSON 無效時傳回錯誤，請指定 false (f)。預設值為 false。

在 JSON 字串中，Amazon Redshift 將 \n 視為新行字元，將 \t 視為 Tab 字元。若要載入反斜線，請加上反斜線 ( \\ ) 來逸出。如需詳細資訊，請參閱 JSON 中的逸出字元。

傳回類型

VARCHAR

VARCHAR 字串，代表路徑元素所參考的 JSON 值。

範例

若要傳回路徑 'f4', 'f6' 的值，請使用下列範例。

SELECT JSON_EXTRACT_PATH_TEXT('{"f2":{"f3":1},"f4":{"f5":99,"f6":"star"}}','f4', 'f6');

+------------------------+
| json_extract_path_text |
+------------------------+
| star                   |
+------------------------+

若要因 JSON 無效而傳回錯誤，請使用下列範例。

SELECT JSON_EXTRACT_PATH_TEXT('{"f2":{"f3":1},"f4":{"f5":99,"f6":"star"}','f4', 'f6');

ERROR: invalid json object {"f2":{"f3":1},"f4":{"f5":99,"f6":"star"}

若要將 null_if_invalid 設為 true，以便在 JSON 無效時，陳述式傳回 NULL 而非傳回錯誤，請使用下列範例。

SELECT JSON_EXTRACT_PATH_TEXT('{"f2":{"f3":1},"f4":{"f5":99,"f6":"star"}','f4', 'f6',true);

+------------------------+
| json_extract_path_text |
+------------------------+
| NULL                   |
+------------------------+

若要傳回路徑 'farm', 'barn', 'color' 的值，其中擷取的值位於第三層，請使用下列範例。此範例使用 JSON lint 工具進行格式，以便於閱讀。

SELECT JSON_EXTRACT_PATH_TEXT('{
    "farm": {
        "barn": {
            "color": "red",
            "feed stocked": true
        }
    }
}', 'farm', 'barn', 'color');
+------------------------+
| json_extract_path_text |
+------------------------+
| red                    |
+------------------------+

若要在遺失 'color' 元素時傳回 NULL，請使用下列範例。此範例使用 JSON lint 工具進行格式化。

SELECT JSON_EXTRACT_PATH_TEXT('{
    "farm": {
        "barn": {}
    }
}', 'farm', 'barn', 'color');

+------------------------+
| json_extract_path_text |
+------------------------+
| NULL                   |
+------------------------+

如果 JSON 有效，嘗試提取缺少的元素會傳回 NULL。

若要傳回路徑 'house', 'appliances', 'washing machine', 'brand' 的值，請使用下列範例。

SELECT JSON_EXTRACT_PATH_TEXT('{
  "house": {
    "address": {
      "street": "123 Any St.",
      "city": "Any Town",
      "state": "FL",
      "zip": "32830"
    },
    "bathroom": {
      "color": "green",
      "shower": true
    },
    "appliances": {
      "washing machine": {
        "brand": "Any Brand",
        "color": "beige"
      },
      "dryer": {
        "brand": "Any Brand",
        "color": "white"
      }
    }
  }
}', 'house', 'appliances', 'washing machine', 'brand');  

+------------------------+
| json_extract_path_text |
+------------------------+
| Any Brand              |
+------------------------+

下列範例會建立範例資料表，並以 SUPER 值填入資料表，然後傳回這兩個資料列'f2'的路徑值。

CREATE TABLE json_example(id INT, json_text SUPER);

INSERT INTO json_example VALUES
(1, JSON_PARSE('{"f2":{"f3":1},"f4":{"f5":99,"f6":"star"}}')),
(2, JSON_PARSE('{
    "farm": {
        "barn": {
            "color": "red",
            "feed stocked": true
        }
    }
}'));

SELECT * FROM json_example;
id          | json_text
------------+--------------------------------------------
1           | {"f2":{"f3":1},"f4":{"f5":99,"f6":"star"}}
2           | {"farm":{"barn":{"color":"red","feed stocked":true}}}
 

SELECT id, JSON_EXTRACT_PATH_TEXT(JSON_SERIALIZE(json_text), 'f2') FROM json_example;
         
id          | json_text
------------+--------------------------------------------
1           | {"f3":1}
2           |