pin_write

boards.BaseBoard.pin_write(
    x,
    name=None,
    type=None,
    title=None,
    description=None,
    metadata=None,
    versioned=None,
    created=None,
    *,
    force_identical_write=False,
)

Write a pin object to the board.

Parameters

Name	Type	Description	Default
x		An object (e.g. a pandas DataFrame) to pin.	required
name	str \| None	Pin name.	`None`
type	str \| None	File type used to save `x` to disk. May be “csv”, “arrow”, “parquet”, “joblib”, or “json”.	`None`
title	str \| None	A title for the pin; most important for shared boards so that others can understand what the pin contains. If omitted, a brief description of the contents will be automatically generated.	`None`
description	str \| None	A detailed description of the pin contents.	`None`
metadata	Mapping \| None	A dictionary containing additional metadata to store with the pin. This gets stored on the Meta.user field.	`None`
versioned	bool \| None	Whether the pin should be versioned. Defaults to versioning.	`None`
created	datetime \| None	A date to store in the Meta.created field. This field may be used as part of the pin version name.	`None`
force_identical_write	bool	Store the pin even if the pin contents are identical to the last version (compared using the hash). Only the pin contents are compared, not the pin metadata. Defaults to False.	`False`

Returns

Name	Type	Description
Meta	Meta	Metadata about the stored pin. If `force_identical_write` is False and the pin contents are identical to the last version, the last version’s metadata is returned.