Skip to main content
Ctrl+K
PyFlink 1.20+vvr.11.7.dev0 documentation - Home PyFlink 1.20+vvr.11.7.dev0 documentation - Home
  • API Reference
  • Examples
  • API Reference
  • Examples

Section Navigation

  • PyFlink Table
    • TableEnvironment
    • Table
    • Data Types
    • Window
    • Expressions
    • User Defined Functions
    • Descriptors
    • StatementSet
    • Catalog
  • PyFlink DataStream
  • PyFlink DataFrame
  • PyFlink Common
  • API Reference
  • PyFlink Table
  • TableEnvironment
  • pyflink.table.table_environment.StreamTableEnvironment.from_path

pyflink.table.table_environment.StreamTableEnvironment.from_path#

StreamTableEnvironment.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()

Added in version 1.10.0.

previous

pyflink.table.table_environment.StreamTableEnvironment.from_pandas

next

pyflink.table.table_environment.StreamTableEnvironment.from_table_source

On this page
  • StreamTableEnvironment.from_path()

This Page

  • Show Source

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.16.1.