| //// |
| 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/transforms/ |
| :language: en_US |
| :page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/dynamicsqlrow/src/main/doc/dynamicsqlrow.adoc |
| = Dynamic SQL row |
| |
| == Description |
| |
| The Dynamic SQL row transform allows you to execute a SQL statement that is defined in a database field. The lookup values are added as new fields onto the stream |
| |
| == Options |
| |
| [width="90%", options="header"] |
| |=== |
| |Option|Description |
| |Transform name|Name of the transform; This name has to be unique in a single pipeline |
| |Connection|Select a database connection for the lookup |
| |SQL field name|Specify the field that contains the SQL to execute |
| |Number of rows to return|Specify the number of records to return. 0 means, return all rows |
| |Outer Join|- false: don't return rows where nothing is found - true: at least return one source row, the rest is NULL |
| |Replace variables|In case you want to use variables in the SQL, e.g. ${table_name}, this option needs to be checked. |
| |Query only on parameters change|If your SQL statements do not change a lot, check this option to reduce the number of physical database queries. |
| |Template SQL|In Hop meta and data are separate so you have to specify the meta part in template SQL (field name and type). |
| I mean any statement that returns the same row structure. |
| |=== |
