pyflink.table.table_environment.TableEnvironment.scan

TableEnvironment.scan(*table_path: str) → Table

Scans a registered table and returns the resulting Table. A table to scan must be registered in the TableEnvironment. It can be either directly registered or be an external member of a Catalog.

See the documentation of use_database() or use_catalog() for the rules on the path resolution.

Examples:

Scanning a directly registered table

>>> tab = table_env.scan("tableName")

Scanning a table from a registered catalog

>>> tab = table_env.scan("catalogName", "dbName", "tableName")

Parameters:

table_path – The path of the table to scan.

Throws:

Exception if no table is found using the given table path.

Returns:

The resulting table.

Note

Deprecated in 1.10. Use from_path() instead.