指定したデータベース内の特定のテーブル/ビューの列の一覧を返します。
構文
listColumns(tableName: str, dbName: str = None)
パラメーター
| パラメーター | タイプ | 説明 |
|---|---|---|
tableName |
str | 列を一覧表示するテーブルの名前。
dbNameが None の場合、カタログ名で修飾できます。 |
dbName |
str、省略可能 | 列を一覧表示するテーブルを検索するデータベースの名前。 |
返品
list の Column
メモ
Pythonはメソッドのオーバーロードをサポートしていないため、ここでの引数の順序は JVM に対応する引数の順序とは異なります。
データベースが指定されていない場合は、現在のデータベースとカタログが使用されます。 この 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")