| //// |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| //// |
| :documentationPath: /plugins/actions/ |
| :language: en_US |
| :page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/actions/waitforsql/src/main/doc/waitforsql.adoc |
| = Wait for SQL |
| |
| == Description |
| |
| The Wait for SQL action scans a database and checks if the database meets user-defined conditions. |
| |
| == Options |
| |
| [width="90%", options="header"] |
| |=== |
| |Option|Description |
| |Workflow action name|The name of the workflow action. |
| |Connection|Identifies the database connection to use. |
| |Target schema|Name of the table schema to evaluate. |
| |Target table name|Name of the table to evaluate. |
| |Success when rows count|Defines the evaluation method used to compare the number of rows with the given value. |
| |Value|Defines the value used for the evaluation |
| |Maximum timeout|After this timeout period, the workflow action continues with a fail, by default, or success, if the Success on timeout option is checked. |
| |Check cycle time|Sets the amount time between evaluations. |
| |Success on timeout|Defines workflow action success behavior when timeout is reached---when checked, reaching the maximum timeout limit causes the workflow action to succeed. When left unchecked, reaching the maximum timeout limit causes the workflow action to fail. |
| |Custom SQL|Enables the use of custom SQL queries. |
| |Use variable substitution|Replaces environment variables in the SQL script with their actual value. |
| |Clear list of result rows before execution|Clears the list of result rows before running this workflow action. |
| |Add rows to result|Includes returned rows to the result set. |
| |=== |
