A Python-facing Arrow array.
-This is a wrapper around an [ArrayRef] and a [FieldRef].
- - - - -method descriptor
-
-
-¶__arrow_c_array__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.array() to convert this array
-into a pyarrow array, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowArrayExportable) -> Self
-Construct this object from an existing Arrow object.
-It can be called on anything that exports the Arrow data interface
-(__arrow_c_array__).
Parameters:
-input
- (ArrowArrayExportable)
- –
- Arrow array to use for constructing this object
-Returns:
-Self
- –
- Self
-A Python-facing Arrow chunked array.
-This is a wrapper around a [FieldRef] and a Vec of [ArrayRef].
method descriptor
-
-
-¶__arrow_c_stream__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example (as of the upcoming pyarrow v16), you can call
-pyarrow.chunked_array() to convert this array into a
-pyarrow array, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowStreamExportable) -> Self
-Construct this from an existing Arrow object.
-It can be called on anything that exports the Arrow stream interface
-(__arrow_c_stream__). All batches will be materialized in memory.
A Python-facing Arrow field.
-This is a wrapper around a [FieldRef].
- - - - -method descriptor
-
-
-¶__arrow_c_schema__() -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.field() to convert this array
-into a pyarrow field, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowSchemaExportable) -> Self
-Construct this from an existing Arrow object.
-It can be called on anything that exports the Arrow schema interface
-(__arrow_c_schema__).
A Python-facing Arrow array.
-This is a wrapper around an [ArrayRef] and a [FieldRef].
- - - - -method descriptor
-
-
-¶__arrow_c_array__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.array() to convert this array
-into a pyarrow array, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowArrayExportable) -> Self
-Construct this object from an existing Arrow object.
-It can be called on anything that exports the Arrow data interface
-(__arrow_c_array__).
Parameters:
-input
- (ArrowArrayExportable)
- –
- Arrow array to use for constructing this object
-Returns:
-Self
- –
- Self
-A Python-facing Arrow chunked array.
-This is a wrapper around a [FieldRef] and a Vec of [ArrayRef].
method descriptor
-
-
-¶__arrow_c_stream__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example (as of the upcoming pyarrow v16), you can call
-pyarrow.chunked_array() to convert this array into a
-pyarrow array, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowStreamExportable) -> Self
-Construct this from an existing Arrow object.
-It can be called on anything that exports the Arrow stream interface
-(__arrow_c_stream__). All batches will be materialized in memory.
A Python-facing Arrow field.
-This is a wrapper around a [FieldRef].
- - - - -method descriptor
-
-
-¶__arrow_c_schema__() -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.field() to convert this array
-into a pyarrow field, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowSchemaExportable) -> Self
-Construct this from an existing Arrow object.
-It can be called on anything that exports the Arrow schema interface
-(__arrow_c_schema__).
A Python-facing Arrow record batch.
-This is a wrapper around a [RecordBatch].
- - - - -method descriptor
-
-
-¶__arrow_c_array__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.array() to convert this array
-into a pyarrow array, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowArrayExportable) -> Self
-Construct this from an existing Arrow RecordBatch.
-It can be called on anything that exports the Arrow data interface
-(__arrow_c_array__) and returns a StructArray..
Parameters:
-input
- (ArrowArrayExportable)
- –
- Arrow array to use for constructing this object
-Returns:
-Self
- –
- Self
-A Python-facing Arrow record batch reader.
-This is a wrapper around a [RecordBatchReader].
- - - - -schema = <attribute 'schema' of 'arro3.core._rust.RecordBatchReader' objects>
-Access the schema of this table
-method descriptor
-
-
-¶__arrow_c_stream__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.table() to convert this array
-into a pyarrow table, without copying memory.
method descriptor
-
-
-¶closed()
-Returns true if this reader has already been consumed.
builtin
-
-
-¶from_arrow(input: ArrowStreamExportable) -> Self
-Construct this from an existing Arrow object.
-It can be called on anything that exports the Arrow stream interface
-(__arrow_c_stream__), such as a Table or RecordBatchReader.
A Python-facing Arrow schema.
-This is a wrapper around a [SchemaRef].
- - - - -method descriptor
-
-
-¶__arrow_c_schema__() -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.schema() to convert this array
-into a pyarrow schema, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowSchemaExportable) -> Self
-Construct this object from an existing Arrow object
-It can be called on anything that exports the Arrow data interface
-(__arrow_c_array__) and returns a struct field.
Parameters:
-input
- (ArrowSchemaExportable)
- –
- Arrow array to use for constructing this object
-Returns:
-Self
- –
- Self
-A Python-facing Arrow table.
-This is a wrapper around a [SchemaRef] and a Vec of [RecordBatch].
num_columns = <attribute 'num_columns' of 'arro3.core._rust.Table' objects>
-Number of columns in this table.
-schema = <attribute 'schema' of 'arro3.core._rust.Table' objects>
-Access the schema of this table
-method descriptor
-
-
-¶__arrow_c_stream__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.table() to convert this array
-into a pyarrow table, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowStreamExportable) -> Self
-Construct this object from an existing Arrow object.
-It can be called on anything that exports the Arrow stream interface
-(__arrow_c_stream__) and yields a StructArray for each item. This Table will materialize
-all items from the iterator in memory at once. Use RecordBatchReader if you don't wish to
-materialize all batches in memory at once.
Parameters:
-input
- (ArrowStreamExportable)
- –
- Arrow array to use for constructing this object
-Returns:
-Self
- –
- Self
-A Python-facing Arrow record batch reader.
-This is a wrapper around a [RecordBatchReader].
- - - - -schema = <attribute 'schema' of 'arro3.core._rust.RecordBatchReader' objects>
-Access the schema of this table
-method descriptor
-
-
-¶__arrow_c_stream__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.table() to convert this array
-into a pyarrow table, without copying memory.
method descriptor
-
-
-¶closed()
-Returns true if this reader has already been consumed.
builtin
-
-
-¶from_arrow(input: ArrowStreamExportable) -> Self
-Construct this from an existing Arrow object.
-It can be called on anything that exports the Arrow stream interface
-(__arrow_c_stream__), such as a Table or RecordBatchReader.
A Python-facing Arrow record batch.
-This is a wrapper around a [RecordBatch].
- - - - -method descriptor
-
-
-¶__arrow_c_array__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.array() to convert this array
-into a pyarrow array, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowArrayExportable) -> Self
-Construct this from an existing Arrow RecordBatch.
-It can be called on anything that exports the Arrow data interface
-(__arrow_c_array__) and returns a StructArray..
Parameters:
-input
- (ArrowArrayExportable)
- –
- Arrow array to use for constructing this object
-Returns:
-Self
- –
- Self
-A Python-facing Arrow schema.
-This is a wrapper around a [SchemaRef].
- - - - -method descriptor
-
-
-¶__arrow_c_schema__() -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.schema() to convert this array
-into a pyarrow schema, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowSchemaExportable) -> Self
-Construct this object from an existing Arrow object
-It can be called on anything that exports the Arrow data interface
-(__arrow_c_array__) and returns a struct field.
Parameters:
-input
- (ArrowSchemaExportable)
- –
- Arrow array to use for constructing this object
-Returns:
-Self
- –
- Self
-A Python-facing Arrow table.
-This is a wrapper around a [SchemaRef] and a Vec of [RecordBatch].
num_columns = <attribute 'num_columns' of 'arro3.core._rust.Table' objects>
-Number of columns in this table.
-schema = <attribute 'schema' of 'arro3.core._rust.Table' objects>
-Access the schema of this table
-method descriptor
-
-
-¶__arrow_c_stream__(requested_schema=None) -> object
-An implementation of the Arrow PyCapsule -Interface. -This dunder method should not be called directly, but enables zero-copy -data transfer to other Python libraries that understand Arrow memory.
-For example, you can call pyarrow.table() to convert this array
-into a pyarrow table, without copying memory.
builtin
-
-
-¶from_arrow(input: ArrowStreamExportable) -> Self
-Construct this object from an existing Arrow object.
-It can be called on anything that exports the Arrow stream interface
-(__arrow_c_stream__) and yields a StructArray for each item. This Table will materialize
-all items from the iterator in memory at once. Use RecordBatchReader if you don't wish to
-materialize all batches in memory at once.
Parameters:
-input
- (ArrowStreamExportable)
- –
- Arrow array to use for constructing this object
-Returns:
-Self
- –
- Self
-
- Bases: Protocol
A C-level reference to an Arrow Array or RecordBatch.
- - - - -