withMetadata

Devuelve un nuevo dataframe actualizando una columna existente con metadatos.

Sintaxis

withMetadata(columnName: str, metadata: Dict[str, Any])

Parámetros

Parámetro Tipo Descripción
columnName str string, nombre de la columna existente para actualizar los metadatos.
metadata diccionario dict, nuevos metadatos que se asignarán a df.schema[columnName].metadata.

Devoluciones

DataFrame: DataFrame con la columna de metadatos actualizada.

Ejemplos

df = spark.createDataFrame([(2, "Alice"), (5, "Bob")], schema=["age", "name"])
df_meta = df.withMetadata('age', {'foo': 'bar'})
df_meta.schema['age'].metadata
# {'foo': 'bar'}