tiled.client.xarray.DatasetClient

class tiled.client.xarray.DatasetClient(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)

__init__(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)

This is not user-facing. Use Node.from_uri.

Methods

__class_getitem__	Represent a PEP 585 generic type
__contains__(key)
__dask_tokenize__()
__delattr__(name, /)	Implement delattr(self, name).
__dir__(/)	Default dir() implementation.
__eq__(other)	Return self==value.
__format__(format_spec, /)	Default object formatter.
__ge__(value, /)	Return self>=value.
__getattribute__(name, /)	Return getattr(self, name).
__getitem__(keys[, _ignore_inlined_contents])
__getstate__(/)	Helper for pickle.
__gt__(value, /)	Return self>value.
__init__(context, *, item, structure_clients)	This is not user-facing.
__init_subclass__	This method is called when a class is subclassed.
__iter__([_ignore_inlined_contents])
__le__(value, /)	Return self<=value.
__len__()
__length_hint__()
__lt__(value, /)	Return self<value.
__ne__(value, /)	Return self!=value.
__new__(*args, **kwargs)
__reduce__(/)	Helper for pickle.
__reduce_ex__(protocol, /)	Helper for pickle.
__repr__()	Return repr(self).
__setattr__(name, value, /)	Implement setattr(self, name, value).
__sizeof__(/)	Size of object in memory, in bytes.
__str__(/)	Return str(self).
__subclasshook__(C)	Abstract classes can override this to customize issubclass().
_build_arrays(variables, optimize_wide_table)
_build_json_patch(origin, update_patch)	Lower level method to construct a JSON patch from an origin and update_patch.
_build_metadata_revisions()
_discover_entrypoints(entrypoint_name)
_ipython_key_completions_()	Provide method for the key-autocompletions in IPython.
_items_slice(start, stop, direction[, ...])
_keys_slice(start, stop, direction[, ...])
_repr_pretty_(p, cycle)	Provide "pretty" display in IPython/Jupyter.
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.
create_appendable_table(schema[, ...])	Initialize a table whose rows can be appended to a partition.
create_container([key, metadata, specs, ...])	Create a new, empty container.
data_sources()
delete([recursive, external_only])	Delete the node and its contents, if any.
delete_contents([keys, recursive, external_only])	Delete the contents of this Container.
discover_clients_from_entrypoints()	Search the software environment for libraries that register structure clients.
distinct(*metadata_keys[, ...])	Get the unique values and optionally counts of metadata_keys, structure_families, and specs in this Node's entries
export(filepath[, fields, format])	Download metadata and data below this node in some format and write to a file.
get(k[,d])
include_data_sources()	Ensure that data source and asset information is fetched.
items()
keys()
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(structure_family, data_sources, *[, ...])	Create a new item within this Node.
new_variation(*[, structure_clients, ...])	Create a copy of this Node, optionally varying some parameters.
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([variables, optimize_wide_table])
refresh()
replace_metadata([metadata, specs, ...])	EXPERIMENTAL: Replace metadata entirely (see update_metadata).
search(query)	Make a Node with a subset of this Node's entries, filtered by query.
sort(*sorting)	Make a Node with the same entries but sorted according to sorting.
structure()	Return a dataclass describing the structure of the data.
subscribe([executor])	Subscribe to streaming updates about this container.
update_metadata([metadata, specs, ...])	EXPERIMENTAL: Update metadata via a dict.update- like interface.
values()
write_array(array, *[, key, metadata, dims, ...])	EXPERIMENTAL: Write an array.
write_awkward(array, *[, key, metadata, ...])	Write an AwkwardArray.
write_dataframe(data, *[, key, metadata, ...])
write_sparse(coords, data, shape, *[, key, ...])	EXPERIMENTAL: Write a sparse array.
write_table(data, *[, key, metadata, specs, ...])	Write tabular data.

Attributes

STRUCTURE_CLIENTS_FROM_ENTRYPOINTS
URL_CHARACTER_LIMIT
_SUGGESTED_MAX_UPLOAD_SIZE
__abstractmethods__
__annotations__
__dict__
__doc__
__hash__
__module__
__reversed__
__slots__
__weakref__	list of weak references to the object
_abc_impl
access_blob	Authorization information about this node, in blob form
context
formats	List formats that the server can export this data as.
item	JSON payload describing this item.
items_indexer
keys_indexer
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.
sorting	The current sorting of this Node
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
values_indexer
fn