tiled.client.dataframe.DataFrameClient

class tiled.client.dataframe.DataFrameClient(context: Context, *, item, structure_clients, structure=None, include_data_sources=False)[source]

Client-side wrapper around a dataframe-like that returns in-memory dataframes

__init__(context: Context, *, item, structure_clients, structure=None, include_data_sources=False)

Methods

`__init__`(context, *, item, structure_clients)
`append_partition`(partition, dataframe)
`asset_manifest`(data_sources)	Return a manifest of the relative paths of the contents in each asset.
`build_metadata_patches`([metadata, specs, ...])	Build valid JSON Patches (RFC6902) for metadata and metadata validation specs accepted by patch_metadata.
`close_stream`()	Declare the end of a stream of writes to this node.
`data_sources`()
`delete`([recursive, external_only])	Delete the node and its contents, if any.
`export`(filepath[, columns, format])	Download data in some format and write to a file.
`include_data_sources`()	Ensure that data source and asset information is fetched.
`login`()	Depending on the server's authentication method, this will prompt for username/password:
`logout`()	Log out.
`metadata_copy`()	Generate a mutable copy of metadata, specs, and access_tags for validating metadata (useful with update_metadata())
`new_variation`([structure])	This is intended primarily for internal use and use by subclasses.
`patch_metadata`([metadata_patch, ...])	EXPERIMENTAL: Patch metadata using a JSON Patch (RFC6902).
`raw_export`([destination_directory, max_workers])	Download the raw assets backing this node.
`read`([columns])	Access the entire DataFrame.
`read_partition`(partition[, columns])	Access one partition of the DataFrame.
`refresh`()
`replace_metadata`([metadata, specs, ...])	EXPERIMENTAL: Replace metadata entirely (see update_metadata).
`structure`()	Return a dataclass describing the structure of the data.
`subscribe`([executor])	Subscribe to streaming updates about this table.
`update_metadata`([metadata, specs, ...])	EXPERIMENTAL: Update metadata via a dict.update- like interface.
`write`(dataframe)
`write_partition`(partition, dataframe)

Attributes

`URL_CHARACTER_LIMIT`
`access_blob`	Authorization information about this node, in blob form
`columns`
`context`
`formats`	List formats that the server can export this data as.
`item`	JSON payload describing this item.
`metadata`	Metadata about this data source.
`metadata_revisions`
`parent`	Returns a client for the parent of this node.
`path_parts`	Location of node in tree, given as list of path segments.
`specs`	List of specifications describing the structure of the metadata and/or data.
`structure_family`	Quick access to this entry
`uri`	Direct link to this entry