Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataQualityRule::DebugQuery (v2.10.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataQualityRule::DebugQuery.

Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.

The SQL statement must use GoogleSQL syntax, and must not contain any semicolons.

You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter.

You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases.

Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM $\{data()}

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) —

    Optional. Specifies the description of the debug query.

    • The maximum length is 1,024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) —

    Optional. Specifies the description of the debug query.

    • The maximum length is 1,024 characters.
Returns
  • (::String) —

    Optional. Specifies the description of the debug query.

    • The maximum length is 1,024 characters.

#sql_statement

def sql_statement() -> ::String
Returns
  • (::String) — Required. Specifies the SQL statement to be executed.

#sql_statement=

def sql_statement=(value) -> ::String
Parameter
  • value (::String) — Required. Specifies the SQL statement to be executed.
Returns
  • (::String) — Required. Specifies the SQL statement to be executed.