資料品質定義語言 (DQDL) 參考

資料品質定義語言 (DQDL) 是您用來定義 AWS Glue Data Quality 規則的網域特定語言。

本指南介紹了關鍵的 DQDL 概念，可幫助您了解該語言。其中也提供 DQDL 規則類型的參考，內含語法和範例。在使用本指南之前，建議您先熟悉 AWS Glue Data Quality。如需更多詳細資訊，請參閱 AWS Glue Data Quality。

DQDL 語法

DQDL 文件區分大小寫，且包含規則集，可將個別資料品質規則分組。若要建構規則集，您必須建立名為 Rules (大寫) 的清單，並以一對方括號分隔。如下列範例所示，清單應包含一或多個以逗號分隔的 DQDL 規則。

Rules = [
   IsComplete "order-id",
   IsUnique "order-id"
]

規則結構

DQDL 規則的結構取決於規則類型。不過，DQDL 規則通常適合以下格式。

<RuleType> <Parameter> <Parameter> <Expression>

RuleType 是您要設定的規則類型名稱 (區分大小寫)。例如，IsComplete、IsUnique 或 CustomSql。每種規則類型的規則參數都不同。如需 DQDL 規則類型及其參數的完整參考資料，請參閱 DQDL 規則類型參考。

複合規則

您可以使用相同的運算子來連接多個規則，因此允許使用以下規則組合。

(Mean "Star_Rating" > 3) and (Mean "Order_Total" > 500) and (IsComplete "Order_Id")

您可以將邏輯運算子合併為單一運算式。例如：

(Mean "Star_Rating" > 3) and ((Mean "Order_Total" > 500) or (IsComplete "Order_Id"))

您也可以撰寫更複雜的巢狀規則。

(RowCount > 0) or ((IsComplete "colA") and (IsUnique "colA"))

複合規則的運作方式

依預設，複合規則會評估為整個資料集或資料表的個別規則，然後合併結果。換言之，其會先評估整個資料欄，然後套用運算子。下面透過一個範例來解釋此預設行為：

# Dataset

+------+------+
|myCol1|myCol2|
+------+------+
|     2|     1|
|     0|     3|
+------+------+

# Overall outcome

+----------------------------------------------------------+-------+
|Rule                                                      |Outcome|
+----------------------------------------------------------+-------+
|(ColumnValues "myCol1" > 1) OR (ColumnValues "myCol2" > 2)|Failed |
+----------------------------------------------------------+-------+
      

在上述範例中，AWS Glue Data Quality 會先評估 (ColumnValues "myCol1" > 1)，這會導致失敗。然後其會評估 (ColumnValues "myCol2" > 2)，但這也會失敗。這兩個結果的組合將記錄為 FAILED。

但是，如果您偏好 SQL 之類的行為，其中您需要評估整個資料列，則必須明確設定 ruleEvaluation.scope 參數，如下面的程式碼片段中的 additionalOptions 所示。

object GlueApp {
  val datasource = glueContext.getCatalogSource(
    database="<db>",
    tableName="<table>",
    transformationContext="datasource"
  ).getDynamicFrame()

  val ruleset = """
    Rules = [
        (ColumnValues "age" >= 26) OR (ColumnLength "name" >= 4)        
    ]
  """

  val dq_results = EvaluateDataQuality.processRows(
    frame=datasource,
    ruleset=ruleset,
    additionalOptions=JsonOptions("""
        {
          "compositeRuleEvaluation.method":"ROW"
        }
      """
    )
  )
}     
      

在 AWS Glue Data Catalog 中，您可以在使用者介面中輕鬆設定此選項，如下所示。

設定後，複合規則將作為評估整個資料列的單一規則。下列範例示範了此行為。

# Row Level outcome

+------+------+------------------------------------------------------------+---------------------------+
|myCol1|myCol2|DataQualityRulesPass                                        |DataQualityEvaluationResult|
+------+------+------------------------------------------------------------+---------------------------+
|2     |1     |[(ColumnValues "myCol1" > 1) OR (ColumnValues "myCol2" > 2)]|Passed                     |
|0     |3     |[(ColumnValues "myCol1" > 1) OR (ColumnValues "myCol2" > 2)]|Passed                     |
+------+------+------------------------------------------------------------+---------------------------+     
      

此功能不支援某些規則，因為整體結果取決於閾值或比率。將其列示如下。

依賴比率的規則：

相依於閾值的規則：

當下列規則包含閾值時，其不受支援。但是，不涉及 with threshold 的規則仍受支援。

Expressions

如果規則類型不會產生布林值回應，您必須提供運算式作為參數，才能建立布林值回應。例如，下列規則會根據表達式檢查欄中所有值的平均值，以傳回 true 或 false 結果。

Mean "colA" between 80 and 100

某些規則類型 (例如 IsUnique 和 IsComplete) 已傳回布林值回應。

下表列出您可以在 DQDL 規則中使用的運算式。

Completeness "colA" = "1.0",
ColumnValues "colA" = "2022-06-30"

ColumnValues "colA" != "a",
ColumnValues "colA" != "2022-06-30"

ColumnValues "colA" > 10

ColumnValues "colA" < 1000,
ColumnValues "colA" < "2022-06-30"

ColumnValues "colA" >= 10

ColumnValues "colA" <= 1000

Mean "colA" between 8 and 100,
ColumnValues "colA" between "2022-05-31" and "2022-06-30"

ColumnValues "colA" not between "2022-05-31" and "2022-06-30"

ColumnValues "colA" in [ 1, 2, 3 ],
ColumnValues "colA" in [ "a", "b", "c" ]

ColumnValues "colA" not in [ 1, 2, 3 ],
ColumnValues "colA" not in [ "a", "b", "c" ]

ColumnValues "colA" matches "[a-zA-Z]*"

ColumnValues "colA" not matches "[a-zA-Z]*"

ColumnValues "load_date" > (now() - 3 days)

ColumnValues "colA" in ["A", "B"] with threshold > 0.8,
ColumnValues "colA" matches "[a-zA-Z]*" with threshold between 0.2 and 0.9
ColumnDataType "colA" = "Timestamp" with threshold > 0.9

NULL、EMPTY 和 WHITESPACES_ONLY 的關鍵字

如果您想要驗證字串資料欄是否具有 null、空白或僅包含空格的字串，您可以使用下列關鍵字：

對於以數字或日期為基礎的表達式，如果您要驗證資料欄是否具有 null，您可以使用下列關鍵字。

使用 Where 子句進行篩選

您可以在撰寫規則時篩選資料。在您要套用條件式規則時，這會很有幫助。

<DQDL Rule> where "<valid SparkSQL where clause> "

必須使用 where 關鍵字指定篩選條件，後接以引號 ("") 括住的有效 SparkSQL 陳述式。

如果您想要將 where 子句新增至具有閾值的規則，則應在閾值條件之前指定 where 子句。

<DQDL Rule> where "valid SparkSQL statement>" with threshold <threshold condition>
        

使用此語法，您可以撰寫如下所示的規則。

Completeness "colA" > 0.5 where "colB = 10"
ColumnValues "colB" in ["A", "B"] where "colC is not null" with threshold > 0.9
ColumnLength "colC" > 10 where "colD != Concat(colE, colF)"

我們將驗證提供的 SparkSQL 陳述式是否有效。如果無效，規則評估將會失敗，我們將擲回格式如下的 IllegalArgumentException：

Rule <DQDL Rule> where "<invalid SparkSQL>" has provided an invalid where clause :
<SparkSQL Error>

開啟資料列層級錯誤記錄識別時的 Where 子句行為

透過 AWS Glue Data Quality，您可以識別失敗的特定記錄。將 where 子句套用至支援資料列層級結果的規則時，我們會將由 where 子句篩選的資料列標記為 Passed。

如果您偏好將篩選出的資料列單獨標記為 SKIPPED，可以為 ETL 任務設定下列 additionalOptions。

object GlueApp {
  val datasource = glueContext.getCatalogSource(
    database="<db>",
    tableName="<table>",
    transformationContext="datasource"
  ).getDynamicFrame()

  val ruleset = """
    Rules = [
       IsComplete "att2" where "att1 = 'a'"        
    ]
  """

  val dq_results = EvaluateDataQuality.processRows(
    frame=datasource,
    ruleset=ruleset,
    additionalOptions=JsonOptions("""
        {
          "rowLevelConfiguration.filteredRowLabel":"SKIPPED"
        }
      """
    )
  )
}

例如，請參閱下列規則和資料框：

IsComplete att2 where "att1 = 'a'"

動態規則

您現在可以編寫動態規則，將規則產生的目前指標與其歷史值進行比較。這些歷史比較是透過在表達式中使用 last() 運算子來啟用。例如，當目前執行中的資料列數目大於相同資料集的最近先前一個資料列計數時，規則 RowCount > last() 便會成功。last() 採用可選的自然數引數，描述要考慮的先前指標；last(k) 中 k >= 1 將參考最後 k 個指標。

為了形成使用 last(k) 的有效表達式，k > 1 需要彙總函數將多個歷史結果簡化為一個數字。例如，RowCount > avg(last(5)) 將檢查目前資料集的資料列計數是否嚴格大於相同資料集最後五個資料列計數的平均值。RowCount > last(5) 將產生錯誤，因為當前資料集的資料列計數不能與清單進行有意義的比較。

支援的彙總函數：

範例表達式

ColumnCorrelation

DistinctValuesCount

大多數具有數值條件或閾值的規則類型都支援動態規則；請參閱提供的資料表分析器和規則，判斷規則類型是否支援動態規則。

從動態規則排除統計資料

有時，您將需要從動態規則計算中排除資料統計資料。假設您執行了歷史資料載入，而且不想影響您的平均值。若要這樣做，請在 AWS Glue ETL 中開啟任務並選擇資料品質索引標籤，選擇統計資料，然後選取您要排除的統計資料。您將可以看到趨勢圖表以及統計資料表。選取您要排除的值，然後選擇排除統計資料。現在，排除的統計資料不會包含在動態規則計算中。

分析器

DQDL 規則使用名為 Analyzers 的函數來收集與資料有關的資訊。規則的布林表達式會使用此資訊來判斷規則是成功或是失敗。例如，RowCount 規則 RowCount > 5 會使用資料列計數分析器來探索資料集中的資料列數目，並將該計數與表達式 > 5 進行比較，從而檢查目前資料集中是否存在五個以上的資料列。

有時候，我們建議您建立分析器而不是撰寫規則，然後讓這些分析器產生可用來偵測異常的統計資料。對於這種情況，您可以建立分析器。分析器與規則有下列不同之處。

分析器可以在沒有規則的情況下獨立存在，因此您可以快速設定這些分析器並逐步建置資料品質規則。

您可以在規則集的 Analyzers 區塊中輸入某些規則類型，以執行分析器所需的規則並收集資訊，而無需對任何條件套用檢查。某些分析器不會與規則相關聯，在 Analyzers 區塊中只能作為輸入。下表指出每個項目是否受到規則或獨立分析器的支援，以及每個規則類型的其他詳細資訊。

使用分析器的範例規則集

以下規則集使用：

您可以在作業執行的「資料品質」索引標籤中檢視分析器指標結果。

Rules = [
   RowCount > avg(last(3))
]
Analyzers = [
   DistinctValuesCount "Name",
   ColumnLength "Name"
]     
        

AWS Glue Data Quality 支援下列分析器。

說明

您可以使用 '#' 字元將註解新增至 DQDL 文件。DQDL 會忽略 '#' 字元之後直到行尾的任何內容。

Rules = [
    # More items should generally mean a higher price, so correlation should be positive
    ColumnCorrelation "price" "num_items" > 0
]