Bases: _Weakrefable
A named field, with a data type, nullability, and optional metadata.
Notes
Do not use this classâs constructor directly; use pyarrow.field
Examples
Create an instance of pyarrow.Field:
>>> import pyarrow as pa >>> pa.field('key', pa.int32()) pyarrow.Field<key: int32> >>> pa.field('key', pa.int32(), nullable=False) pyarrow.Field<key: int32 not null> >>> field = pa.field('key', pa.int32(), ... metadata={"key": "Something important"}) >>> field pyarrow.Field<key: int32> >>> field.metadata {b'key': b'Something important'}
Use the field to create a struct type:
>>> pa.struct([field]) StructType(struct<key: int32>)
Methods
Attributes
Test if this field is equal to the other
pyarrow.Field
False
Whether Field metadata equality should be checked as well.
Examples
>>> import pyarrow as pa >>> f1 = pa.field('key', pa.int32()) >>> f2 = pa.field('key', pa.int32(), nullable=False) >>> f1.equals(f2) False >>> f1.equals(f1) True
Flatten this field. If a struct field, individual child fields will be returned with their names prefixed by the parentâs name.
List
[pyarrow.Field
]
Examples
>>> import pyarrow as pa >>> f1 = pa.field('bar', pa.float64(), nullable=False) >>> f2 = pa.field('foo', pa.int32()).with_metadata({"key": "Something important"}) >>> ff = pa.field('ff', pa.struct([f1, f2]), nullable=False)
Flatten a struct field:
>>> ff pyarrow.Field<ff: struct<bar: double not null, foo: int32> not null> >>> ff.flatten() [pyarrow.Field<ff.bar: double not null>, pyarrow.Field<ff.foo: int32>]
The field metadata (if any is set).
dict
or None
Examples
>>> import pyarrow as pa >>> field = pa.field('key', pa.int32(), ... metadata={"key": "Something important"}) >>> field.metadata {b'key': b'Something important'}
The field name.
Examples
>>> import pyarrow as pa >>> field = pa.field('key', pa.int32()) >>> field.name 'key'
The field nullability.
Examples
>>> import pyarrow as pa >>> f1 = pa.field('key', pa.int32()) >>> f2 = pa.field('key', pa.int32(), nullable=False) >>> f1.nullable True >>> f2.nullable False
Create new field without metadata, if any
pyarrow.Field
Examples
>>> import pyarrow as pa >>> field = pa.field('key', pa.int32(), ... metadata={"key": "Something important"}) >>> field.metadata {b'key': b'Something important'}
Create new field by removing the metadata from the existing one:
>>> field_new = field.remove_metadata() >>> field_new.metadata
Add metadata as dict of string keys and values to Field
dict
Keys and values must be string-like / coercible to bytes
pyarrow.Field
Examples
>>> import pyarrow as pa >>> field = pa.field('key', pa.int32())
Create new field by adding metadata to existing one:
>>> field_new = field.with_metadata({"key": "Something important"}) >>> field_new pyarrow.Field<key: int32> >>> field_new.metadata {b'key': b'Something important'}
A copy of this field with the replaced name
str
pyarrow.Field
Examples
>>> import pyarrow as pa >>> field = pa.field('key', pa.int32()) >>> field pyarrow.Field<key: int32>
Create new field by replacing the name of an existing one:
>>> field_new = field.with_name('lock') >>> field_new pyarrow.Field<lock: int32>
A copy of this field with the replaced nullability
pyarrow.Field
Examples
>>> import pyarrow as pa >>> field = pa.field('key', pa.int32()) >>> field pyarrow.Field<key: int32> >>> field.nullable True
Create new field by replacing the nullability of an existing one:
>>> field_new = field.with_nullable(False) >>> field_new pyarrow.Field<key: int32 not null> >>> field_new.nullable False
A copy of this field with the replaced type
pyarrow.DataType
pyarrow.Field
Examples
>>> import pyarrow as pa >>> field = pa.field('key', pa.int32()) >>> field pyarrow.Field<key: int32>
Create new field by replacing type of an existing one:
>>> field_new = field.with_type(pa.int64()) >>> field_new pyarrow.Field<key: int64>
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4