Reference documentation and code samples for the Google Cloud Dataplex V1 Client class 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()}
Generated from protobuf message google.cloud.dataplex.v1.DataQualityRule.DebugQuery
Namespace
Google \ Cloud \ Dataplex \ V1 \ DataQualityRuleMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ description |
string
Optional. Specifies the description of the debug query. * * The maximum length is 1,024 characters. |
↳ sql_statement |
string
Required. Specifies the SQL statement to be executed. |
getDescription
Optional. Specifies the description of the debug query.
- The maximum length is 1,024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Specifies the description of the debug query.
- The maximum length is 1,024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSqlStatement
Required. Specifies the SQL statement to be executed.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSqlStatement
Required. Specifies the SQL statement to be executed.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|