Kolumna metadanych pliku

  • Artykuł

Informacje o metadanych dla plików wejściowych można uzyskać za pomocą kolumny _metadata . Kolumna _metadata jest ukrytą kolumną i jest dostępna dla wszystkich formatów plików wejściowych. Aby dołączyć kolumnę _metadata do zwróconej ramki danych, musisz jawnie odwołać się do niej w zapytaniu.

Jeśli źródło danych zawiera kolumnę o nazwie _metadata, zapytania zwracają kolumnę ze źródła danych, a nie metadane pliku.

Ostrzeżenie

Nowe pola mogą zostać dodane do kolumny _metadata w przyszłych wersjach. Aby zapobiec błędom ewolucji schematu w przypadku _metadata zaktualizowania kolumny, usługa Databricks zaleca wybranie określonych pól z kolumny w zapytaniach. Zobacz przykłady.

Obsługiwane metadane

Kolumna _metadata zawiera STRUCT następujące pola:

Nazwa Typu Opis Przykład Minimalna wersja środowiska Databricks Runtime
file_path STRING Ścieżka pliku wejściowego. file:/tmp/f0.csv 10.5
Nazwa_pliku STRING Nazwa pliku wejściowego wraz z jego rozszerzeniem. f0.csv 10.5
file_size LONG Długość pliku wejściowego w bajtach. 628 10.5
file_modification_time TIMESTAMP Znacznik czasu ostatniej modyfikacji pliku wejściowego. 2021-12-20 20:05:21 10.5
file_block_start LONG Rozpocznij przesunięcie odczytywanego bloku w bajtach. 0 13.0
file_block_length LONG Długość odczytywanego bloku w bajtach. 628 13.0

Przykłady

Używanie w podstawowym czytniku źródeł danych opartym na plikach

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" |
|         |     | }                                                  |
+---------+-----+----------------------------------------------------+
*/

Wybieranie określonych pól

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

Używanie w filtrach

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

Używanie w funkcji 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

Używanie w automatycznym ładowaniu

Uwaga

Podczas pisania kolumny _metadata zmieniamy jej nazwę na source_metadata. Zapisanie go tak, jak _metadata uniemożliwiłoby uzyskanie dostępu do kolumny metadanych w tabeli docelowej, ponieważ jeśli źródło danych zawiera kolumnę o nazwie _metadata, zapytania będą zwracać kolumnę ze źródła danych, a nie metadane pliku.

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 \
  .format("delta") \
  .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
  .format("delta")
  .option("checkpointLocation", checkpointLocation)
  .start(targetTable)