tiledbsoma.PointCloudDataFrame.read

PointCloudDataFrame.read(coords: Sequence[None | bytes | Slice[bytes] | Sequence[bytes] | float | Slice[float] | Sequence[float] | int | Slice[int] | Sequence[int] | slice | Slice[slice] | Sequence[slice] | str | Slice[str] | Sequence[str] | datetime64 | Slice[datetime64] | Sequence[datetime64] | TimestampType | Slice[TimestampType] | Sequence[TimestampType] | Array | ChunkedArray | ndarray[Any, dtype[integer]] | ndarray[Any, dtype[datetime64]]] = (), column_names: Sequence[str] | None = None, *, batch_size: BatchSize = BatchSize(count=None, bytes=None), partitions: ReadPartitions | None = None, result_order: ResultOrder | Literal['auto', 'row-major', 'column-major'] = ResultOrder.AUTO, value_filter: str | None = None, platform_config: Dict[str, Mapping[str, Any]] | object | None = None) → TableReadIter

Reads a user-defined slice of data into Arrow tables.

Parameters:

  • coords – for each index dimension, which rows to read. Defaults to (), meaning no constraint – all IDs.

  • column_names – the named columns to read and return. Defaults to None, meaning no constraint – all column names.

  • partitions – If present, specifies that this is part of a partitioned read, and which part of the data to include.

  • result_order – the order to return results, specified as a ResultOrder or its string value.

  • value_filter – an optional value filter to apply to the results. The default of None represents no filter. Value filter syntax is implementation-defined; see the documentation for the particular SOMA implementation for details.

Returns:

A ReadIter of :class:`pa.Table`s.

Lifecycle

Experimental.