////
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: /pipeline/transforms/
:language: en_US
:description: The Get Table Names transform gets table names from a database connection.

= image:transforms/icons/gettablenames.svg[Get table names transform Icon, role="image-doc-icon"] Get table names

[%noheader,cols="3a,1a", role="table-no-borders" ]
|===
|
== Description

The Get Table Names transform gets table names from a database connection.
|
== Supported Engines
[%noheader,cols="2,1a",frame=none, role="table-supported-engines"]
!===
!Hop Engine! image:check_mark.svg[Supported, 24]
!Spark! image:question_mark.svg[Maybe Supported, 24]
!Flink! image:question_mark.svg[Maybe Supported, 24]
!Dataflow! image:question_mark.svg[Maybe Supported, 24]
!===
|===

== Options

[options="header"]
|===
|Option|Description
|Transform name|Name of this transform as it appears in the pipeline workspace
|Connection|The connection to use
|Schema name|The schema to use
|Get schema from field|Allows passing a field containing the schema name
|Schema name field|The field containing the schema name
|Include catalogs|Includes catalogs in the output
|Include schemas|Includes schemas in the output
|Include views|Includes views in the output
|Include procedures|Includes procedures in the output
|Include synonyms|Include synonyms in the output
|Add schema in object name|Adds the schema to the object name
|Tablename fieldname|Output field containing the table name
|Object type fieldname|Output field containing the object type (catalog, schema, table, ...)
|Is system object fieldname|Output field containing boolean: is object a system object
|Creation SQL fieldname|Output field containing create statement for object
|===
