listColumns

Возвращает список столбцов для заданной таблицы или представления в указанной базе данных.

Синтаксис

listColumns(tableName: str, dbName: str = None)

Параметры

Параметр Тип Описание
tableName str Имя таблицы для списка столбцов. Может быть квалифицировано с именем каталога, если dbName имеет значение None.
dbName str, необязательный Имя базы данных, чтобы найти таблицу для перечисления столбцов.

Возвраты

list из Column

Примечания

Порядок аргументов отличается от порядка аргументов своего аналога JVM, так как Python не поддерживает перегрузку метода.

Если база данных не указана, используется текущая база данных и каталог. Этот API включает все временные представления.

Примеры

_ = spark.sql("DROP TABLE IF EXISTS tbl1")
_ = spark.sql("CREATE TABLE tblA (name STRING, age INT) USING parquet")
spark.catalog.listColumns("tblA")
# [Column(name='name', description=None, dataType='string', nullable=True, ...
_ = spark.sql("DROP TABLE tblA")