リスト列

指定されたデータベース内の、指定されたテーブル/ビューの列のリストを返します。

構文

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

パラメーター

パラメーター	Type	説明
tableName	str	列を一覧表示するテーブルの名前。dbNameがNoneの場合、カタログ名で修飾できます。
dbName	str、オプション	列を一覧表示するテーブルを検索するデータベースの名前。

戻り値

list / Column

注意

Pythonはメソッドのオーバーロードをサポートしていないため、ここでの引数の順序はJVMの場合とは異なります。

データベースが指定されていない場合は、現在のデータベースとカタログが使用されます。このAPIには、すべての一時ビューが含まれています。

例

Python

_ = 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")