Field

arro3.core.Field

An Arrow Field.

metadata property

metadata: dict[bytes, bytes]

The schema's metadata.

metadata_str property

metadata_str: dict[str, str]

The schema's metadata where keys and values are str, not bytes.

name property

name: str

The field name.

nullable property

nullable: bool

The field nullability.

type property

type: DataType

Access the data type of this field.

__arrow_c_schema__

__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.

equals

equals(other: ArrowSchemaExportable) -> bool

Test if this field is equal to the other.

from_arrow classmethod

from_arrow(input: ArrowSchemaExportable) -> Field

Construct this from an existing Arrow object.

It can be called on anything that exports the Arrow schema interface (has an __arrow_c_schema__ method).

from_arrow_pycapsule classmethod

from_arrow_pycapsule(capsule) -> Field

Construct this object from a bare Arrow PyCapsule

remove_metadata

remove_metadata() -> Field

Create new field without metadata, if any.

with_metadata

with_metadata(metadata: dict[str, str] | dict[bytes, bytes]) -> Field

Add metadata as dict of string keys and values to Field.

with_name

with_name(name: str) -> Field

A copy of this field with the replaced name.

with_nullable

with_nullable(nullable: bool) -> Field

A copy of this field with the replaced nullability.

with_type

with_type(new_type: ArrowSchemaExportable) -> Field

A copy of this field with the replaced type