pyflink.table.table_environment.TableEnvironment.from_path

TableEnvironment.from_path(path: str) → Table

Reads a registered table and returns the resulting Table.

A table to scan must be registered in the TableEnvironment.

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

Examples:

Reading a table from default catalog and database.

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

Reading a table from a registered catalog.

>>> tab = table_env.from_path("catalogName.dbName.tableName")

Reading a table from a registered catalog with escaping. (Table is a reserved keyword). Dots in e.g. a database name also must be escaped.

>>> tab = table_env.from_path("catalogName.`db.Name`.`Table`")

Parameters

path – The path of a table API object to scan.

Returns

Either a table or virtual table (=view).

See also

use_catalog()

See also

use_database()

New in version 1.10.0.