Sloupec metadat souboru

  • Článek

Pomocí sloupce můžete získat informace o metadatech pro vstupní soubory _metadata . Sloupec _metadata je skrytý sloupec a je k dispozici pro všechny formáty vstupních souborů. Pokud chcete do vráceného datového rámce zahrnout _metadata sloupec, musíte na něj v dotazu explicitně odkazovat.

Pokud zdroj dat obsahuje sloupec s názvem _metadata, dotazy vrátí sloupec ze zdroje dat, nikoli metadata souboru.

Upozorňující

Nová pole se můžou přidat do _metadata sloupce v budoucích verzích. Aby se zabránilo chybám vývoje schématu _metadata v případě aktualizace sloupce, doporučuje Databricks vybrat konkrétní pole ze sloupce v dotazech. Podívejte se na příklady.

Podporovaná metadata

Sloupec _metadata obsahuje STRUCT následující pole:

Name Typ Popis Příklad Minimální verze Databricks Runtime
file_path STRING Cesta k souboru vstupního souboru. file:/tmp/f0.csv 10.5
file_name STRING Název vstupního souboru spolu s jeho příponou. f0.csv 10.5
file_size LONG Délka vstupního souboru v bajtech 628 10.5
file_modification_time TIMESTAMP Časové razítko poslední změny vstupního souboru 2021-12-20 20:05:21 10.5
file_block_start LONG Začátek posunu čtení bloku v bajtech 0 13.0
file_block_length LONG Délka čteného bloku v bajtech. 628 13.0

Příklady

Použití v základní čtečce zdrojů dat založených na souborech

Python

df = spark.read \
  .format("csv") \
  .schema(schema) \
  .load("dbfs:/tmp/*") \
  .select("*", "_metadata")

display(df)

'''
Result:
+---------+-----+----------------------------------------------------+
|   name  | age |                 _metadata                          |
+=========+=====+====================================================+
|         |     | {                                                  |
|         |     |    "file_path": "dbfs:/tmp/f0.csv",                |
| Debbie  | 18  |    "file_name": "f0.csv",                          |
|         |     |    "file_size": 12,                                |
|         |     |    "file_block_start": 0,                          |
|         |     |    "file_block_length": 12,                        |
|         |     |    "file_modification_time": "2021-07-02 01:05:21" |
|         |     | }                                                  |
+---------+-----+----------------------------------------------------+
|         |     | {                                                  |
|         |     |    "file_path": "dbfs:/tmp/f1.csv",                |
| Frank   | 24  |    "file_name": "f1.csv",                          |
|         |     |    "file_size": 12,                                |
|         |     |    "file_block_start": 0,                          |
|         |     |    "file_block_length": 12,                        |
|         |     |    "file_modification_time": "2021-12-20 02:06:21" |
|         |     | }                                                  |
+---------+-----+----------------------------------------------------+
'''

Scala

val df = spark.read
  .format("csv")
  .schema(schema)
  .load("dbfs:/tmp/*")
  .select("*", "_metadata")

display(df_population)

/* Result:
+---------+-----+----------------------------------------------------+
|   name  | age |                 _metadata                          |
+=========+=====+====================================================+
|         |     | {                                                  |
|         |     |    "file_path": "dbfs:/tmp/f0.csv",                |
| Debbie  | 18  |    "file_name": "f0.csv",                          |
|         |     |    "file_size": 12,                                |
|         |     |    "file_block_start": 0,                          |
|         |     |    "file_block_length": 12,                        |
|         |     |    "file_modification_time": "2021-07-02 01:05:21" |
|         |     | }                                                  |
+---------+-----+----------------------------------------------------+
|         |     | {                                                  |
|         |     |    "file_path": "dbfs:/tmp/f1.csv",                |
| Frank   | 24  |    "file_name": "f1.csv",                          |
|         |     |    "file_size": 10,                                |
|         |     |    "file_block_start": 0,                          |
|         |     |    "file_block_length": 12,                        |
|         |     |    "file_modification_time": "2021-12-20 02:06:21" |
|         |     | }                                                  |
+---------+-----+----------------------------------------------------+
*/

Výběr konkrétních polí

Python

spark.read \
  .format("csv") \
  .schema(schema) \
  .load("dbfs:/tmp/*") \
  .select("_metadata.file_name", "_metadata.file_size")

Scala

spark.read
  .format("csv")
  .schema(schema)
  .load("dbfs:/tmp/*")
  .select("_metadata.file_name", "_metadata.file_size")

Použití ve filtrech

Python

spark.read \
  .format("csv") \
  .schema(schema) \
  .load("dbfs:/tmp/*") \
  .select("*") \
  .filter(col("_metadata.file_name") == lit("test.csv"))

Scala

spark.read
  .format("csv")
  .schema(schema)
  .load("dbfs:/tmp/*")
  .select("*")
  .filter(col("_metadata.file_name") === lit("test.csv"))

Použití v příkazu COPY INTO

COPY INTO my_delta_table
FROM (
  SELECT *, _metadata FROM 'abfss://my-container-name@storage-account-name.dfs.core.windows.net/csvData'
)
FILEFORMAT = CSV

Použití v automatickém zavaděče

Poznámka:

Při psaní _metadata sloupce ho přejmenujeme na source_metadata. Zápis tak, jak _metadata by znemožnil přístup ke sloupci metadat v cílové tabulce, protože pokud zdroj dat obsahuje sloupec s názvem _metadata, dotazy vrátí sloupec ze zdroje dat, a ne metadata souboru.

Python

spark.readStream \
  .format("cloudFiles") \
  .option("cloudFiles.format", "csv") \
  .schema(schema) \
  .load("abfss://my-container-name@storage-account-name.dfs.core.windows.net/csvData") \
  .selectExpr("*", "_metadata as source_metadata") \
  .writeStream \
  .option("checkpointLocation", checkpointLocation) \
  .start(targetTable)

Scala

spark.readStream
  .format("cloudFiles")
  .option("cloudFiles.format", "csv")
  .schema(schema)
  .load("abfss://my-container-name@storage-account-name.dfs.core.windows.net/csvData")
  .selectExpr("*", "_metadata as source_metadata")
  .writeStream
  .option("checkpointLocation", checkpointLocation)
  .start(targetTable)