brk-code

iceberg-python の API リファレンス

iceberg-python (apache/iceberg-python) の公開 API 359 件 —— クラス 124、関数 88、メソッド 147。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: apache/iceberg-python

種別件数
クラス124
関数88
メソッド147

API 一覧

classpyiceberg.avro.codecs.codec.Codec
Abstract base class for all Avro codec classes.
classpyiceberg.avro.decoder.BinaryDecoder
Decodes bytes into Python physical primitives.
methodpyiceberg.avro.decoder.BinaryDecoder.read(n:int) -> bytes
Read n bytes.
methodpyiceberg.avro.decoder.BinaryDecoder.read_boolean() -> bool
Read a value from the stream as a boolean.
methodpyiceberg.avro.decoder.BinaryDecoder.read_double() -> float
Read a value from the stream as a double.
methodpyiceberg.avro.decoder.BinaryDecoder.read_float() -> float
Read a value from the stream as a float.
methodpyiceberg.avro.decoder.BinaryDecoder.read_int() -> int
Read an int/long value.
methodpyiceberg.avro.decoder.BinaryDecoder.read_ints(n:int) -> tuple[int, ...]
Read a list of integers.
methodpyiceberg.avro.decoder.BinaryDecoder.read_utf8() -> str
Read an utf-8 encoded string from the stream.
methodpyiceberg.avro.decoder.BinaryDecoder.skip(n:int) -> None
Skip n bytes.
methodpyiceberg.avro.decoder.BinaryDecoder.tell() -> int
Return the current position.
classpyiceberg.avro.decoder.StreamingBinaryDecoder
Decodes bytes into Python physical primitives.
methodpyiceberg.avro.decoder.StreamingBinaryDecoder.read(n:int) -> bytes
Read n bytes.
methodpyiceberg.avro.decoder.StreamingBinaryDecoder.tell() -> int
Return the current stream position.
classpyiceberg.avro.encoder.BinaryEncoder
Encodes Python physical types into bytes.
methodpyiceberg.avro.encoder.BinaryEncoder.write_bytes(b:bytes) -> None
Bytes are encoded as a long followed by that many bytes of data.
methodpyiceberg.avro.encoder.BinaryEncoder.write_double(f:float) -> None
Write a double as 8 bytes.
methodpyiceberg.avro.encoder.BinaryEncoder.write_float(f:float) -> None
Write a float as 4 bytes.
methodpyiceberg.avro.encoder.BinaryEncoder.write_int(integer:int) -> None
Integer and long values are written using variable-length zig-zag coding.
methodpyiceberg.avro.encoder.BinaryEncoder.write_unknown(_:Any) -> None
Nulls are written as 0 bytes in avro, so we do nothing.
methodpyiceberg.avro.encoder.BinaryEncoder.write_uuid(uuid:UUID) -> None
Write UUID as a fixed[16].
classpyiceberg.avro.reader.BinaryReader
Read a binary value.
classpyiceberg.avro.reader.DateReader
Reads a day granularity date from the stream.
classpyiceberg.avro.reader.DecimalReader
Reads a value as a decimal.
classpyiceberg.avro.reader.TimeReader
Reads a microsecond granularity timestamp from the stream.
classpyiceberg.avro.reader.TimestampReader
Reads a microsecond granularity timestamp from the stream.
classpyiceberg.avro.resolver.ConstructWriter
Construct a writer tree from an Iceberg schema.
methodpyiceberg.avro.resolver.ConstructWriter.visit_geography(geography_type:'GeographyType') -> Writer
Geography is written as WKB bytes in Avro.
methodpyiceberg.avro.resolver.ConstructWriter.visit_geometry(geometry_type:'GeometryType') -> Writer
Geometry is written as WKB bytes in Avro.
classpyiceberg.avro.resolver.EnumReader
An Enum reader to wrap primitive values into an Enum.
funcpyiceberg.avro.resolver.construct_reader(file_schema:Schema | IcebergType, read_types:dict[int, Callable[..., StructProtocol]]=EMPTY_DICT) -> Reader
Construct a reader from a file schema.
funcpyiceberg.avro.resolver.construct_writer(file_schema:Schema | IcebergType) -> Writer
Construct a writer from a file schema.
funcpyiceberg.avro.resolver.resolve_writer(record_schema:Schema | IcebergType, file_schema:Schema | IcebergType) -> Writer
Resolve the file and read schema to produce a reader.
classpyiceberg.avro.writer.BinaryWriter
Variable byte length writer.
methodpyiceberg.catalog.Catalog.close() -> None
Close the catalog and release any resources.
methodpyiceberg.catalog.Catalog.commit_table(table:Table, requirements:tuple[TableRequirement, ...], updates:tuple[TableUpdate, ...]) -> CommitTableResponse
Commit updates to a table.
methodpyiceberg.catalog.Catalog.create_namespace(namespace:str | Identifier, properties:Properties=EMPTY_DICT) -> None
Create a namespace in the catalog.
methodpyiceberg.catalog.Catalog.create_namespace_if_not_exists(namespace:str | Identifier, properties:Properties=EMPTY_DICT) -> None
Create a namespace if it does not exist.
methodpyiceberg.catalog.Catalog.create_table(identifier:str | Identifier, schema:Schema | pa.Schema, location:str | None=None, partition_spec:PartitionSpec=UNPARTITIONED_PARTITION_SPEC, sort_order:SortOrder=UNSORTED_SORT_ORDER, properties:Properties=EMPTY_DICT) -> Table
Create a table.
methodpyiceberg.catalog.Catalog.create_view(identifier:str | Identifier, schema:Schema | pa.Schema, view_version:ViewVersion, location:str | None=None, properties:Properties=EMPTY_DICT) -> View
Create a view.
methodpyiceberg.catalog.Catalog.drop_namespace(namespace:str | Identifier) -> None
Drop a namespace.
methodpyiceberg.catalog.Catalog.drop_table(identifier:str | Identifier) -> None
Drop a table.
methodpyiceberg.catalog.Catalog.drop_view(identifier:str | Identifier) -> None
Drop a view.
methodpyiceberg.catalog.Catalog.identifier_to_tuple(identifier:str | Identifier) -> Identifier
Parse an identifier to a tuple.
methodpyiceberg.catalog.Catalog.list_namespaces(namespace:str | Identifier=()) -> list[Identifier]
List namespaces from the given namespace.
methodpyiceberg.catalog.Catalog.list_tables(namespace:str | Identifier) -> list[Identifier]
List tables under the given namespace in the catalog.
methodpyiceberg.catalog.Catalog.list_views(namespace:str | Identifier) -> list[Identifier]
List views under the given namespace in the catalog.
methodpyiceberg.catalog.Catalog.load_namespace_properties(namespace:str | Identifier) -> Properties
Get properties for a namespace.
methodpyiceberg.catalog.Catalog.load_table(identifier:str | Identifier) -> Table
Load the table's metadata and returns the table instance.
methodpyiceberg.catalog.Catalog.load_view(identifier:str | Identifier) -> View
Load the view's metadata and returns the view instance.
methodpyiceberg.catalog.Catalog.namespace_exists(namespace:str | Identifier) -> bool
Check if a namespace exists.
methodpyiceberg.catalog.Catalog.namespace_from(identifier:str | Identifier) -> Identifier
Extract table namespace from a table identifier.
methodpyiceberg.catalog.Catalog.namespace_to_string(identifier:str | Identifier, err:type[ValueError] | type[NoSuchNamespaceError]=ValueError) -> str
Transform a namespace identifier into a string.
methodpyiceberg.catalog.Catalog.purge_table(identifier:str | Identifier) -> None
Drop a table and purge all data and metadata files.
methodpyiceberg.catalog.Catalog.register_table(identifier:str | Identifier, metadata_location:str, overwrite:bool=False) -> Table
Register a new table using existing metadata.
methodpyiceberg.catalog.Catalog.register_view(identifier:str | Identifier, metadata_location:str) -> View
Register a new view using existing metadata.
methodpyiceberg.catalog.Catalog.rename_table(from_identifier:str | Identifier, to_identifier:str | Identifier) -> Table
Rename a fully classified table name.
methodpyiceberg.catalog.Catalog.table_exists(identifier:str | Identifier) -> bool
Check if a table exists.
methodpyiceberg.catalog.Catalog.table_name_from(identifier:str | Identifier) -> str
Extract table name from a table identifier.
methodpyiceberg.catalog.Catalog.view_exists(identifier:str | Identifier) -> bool
Check if a view exists.
funcpyiceberg.catalog.delete_data_files(io:FileIO, manifests_to_delete:list[ManifestFile]) -> None
Delete data files linked to given manifests.
funcpyiceberg.catalog.delete_files(io:FileIO, files_to_delete:set[str], file_type:str) -> None
Delete files.
funcpyiceberg.catalog.infer_catalog_type(name:str, catalog_properties:RecursiveDict) -> CatalogType | None
Try to infer the type based on the dict.
funcpyiceberg.catalog.load_catalog(name:str | None=None, **properties:str | None) -> Catalog
Load the catalog based on the properties.
classpyiceberg.catalog.rest.auth.LegacyOAuth2AuthManager
Legacy OAuth2 AuthManager implementation.
classpyiceberg.catalog.rest.auth.NoopAuthManager
Auth Manager implementation with no auth.
classpyiceberg.catalog.rest.scan_planning.CountMap
Map of field IDs to counts.
classpyiceberg.catalog.rest.scan_planning.FetchScanTasksRequest
Request body for fetching scan tasks endpoint.
classpyiceberg.catalog.rest.scan_planning.PlanCancelled
Planning was cancelled.
classpyiceberg.catalog.rest.scan_planning.PlanCompleted
Completed scan plan result.
classpyiceberg.catalog.rest.scan_planning.PlanFailed
Planning failed with error.
classpyiceberg.catalog.rest.scan_planning.PlanSubmitted
Scan plan submitted, poll for completion.
classpyiceberg.catalog.rest.scan_planning.PlanTableScanRequest
Request body for planning a REST scan.
classpyiceberg.catalog.rest.scan_planning.RESTContentFile
Base model for data and delete files from REST API.
classpyiceberg.catalog.rest.scan_planning.RESTDataFile
Data file from REST API.
classpyiceberg.catalog.rest.scan_planning.RESTEqualityDeleteFile
Equality delete file from REST API.
classpyiceberg.catalog.rest.scan_planning.RESTFileScanTask
A file scan task from the REST server.
classpyiceberg.catalog.rest.scan_planning.RESTPositionDeleteFile
Position delete file from REST API.
classpyiceberg.catalog.rest.scan_planning.ScanTasks
Container for scan tasks returned by the server.
classpyiceberg.catalog.rest.scan_planning.StorageCredential
Storage credential for accessing content files.
classpyiceberg.catalog.sql.SqlCatalog
Implementation of a SQL based catalog.
methodpyiceberg.catalog.sql.SqlCatalog.close() -> None
Close the catalog and release database connections.
methodpyiceberg.catalog.sql.SqlCatalog.commit_table(table:Table, requirements:tuple[TableRequirement, ...], updates:tuple[TableUpdate, ...]) -> CommitTableResponse
Commit updates to a table.
methodpyiceberg.catalog.sql.SqlCatalog.create_namespace(namespace:str | Identifier, properties:Properties=EMPTY_DICT) -> None
Create a namespace in the catalog.
methodpyiceberg.catalog.sql.SqlCatalog.drop_namespace(namespace:str | Identifier) -> None
Drop a namespace.
methodpyiceberg.catalog.sql.SqlCatalog.drop_table(identifier:str | Identifier) -> None
Drop a table.
methodpyiceberg.catalog.sql.SqlCatalog.list_namespaces(namespace:str | Identifier=()) -> list[Identifier]
List namespaces from the given namespace.
methodpyiceberg.catalog.sql.SqlCatalog.list_tables(namespace:str | Identifier) -> list[Identifier]
List tables under the given namespace in the catalog.
methodpyiceberg.catalog.sql.SqlCatalog.load_namespace_properties(namespace:str | Identifier) -> Properties
Get properties for a namespace.
methodpyiceberg.catalog.sql.SqlCatalog.load_table(identifier:str | Identifier) -> Table
Load the table's metadata and return the table instance.
methodpyiceberg.catalog.sql.SqlCatalog.register_table(identifier:str | Identifier, metadata_location:str, overwrite:bool=False) -> Table
Register a new table using existing metadata.
methodpyiceberg.catalog.sql.SqlCatalog.rename_table(from_identifier:str | Identifier, to_identifier:str | Identifier) -> Table
Rename a fully classified table name.
funcpyiceberg.cli.console.create() -> None
Operation to create a namespace.
funcpyiceberg.cli.console.describe(ctx:Context, entity:Literal['name', 'namespace', 'table'], identifier:str) -> None
Describe a namespace or a table.
funcpyiceberg.cli.console.drop() -> None
Operations to drop a namespace or table.
funcpyiceberg.cli.console.files(ctx:Context, identifier:str, history:bool) -> None
List all the files of the table.
funcpyiceberg.cli.console.get() -> None
Fetch properties on tables/namespaces.
funcpyiceberg.cli.console.get_namespace(ctx:Context, identifier:str, property_name:str) -> None
Fetch properties on a namespace.
funcpyiceberg.cli.console.get_table(ctx:Context, identifier:str, property_name:str) -> None
Fetch properties on a table.
funcpyiceberg.cli.console.list(ctx:Context, parent:str | None) -> None
List tables or namespaces.
funcpyiceberg.cli.console.list_refs(ctx:Context, identifier:str, type:str, verbose:bool) -> None
List all the refs in the provided table.
funcpyiceberg.cli.console.location(ctx:Context, identifier:str) -> None
Return the location of the table.
funcpyiceberg.cli.console.namespace(ctx:Context, identifier:str) -> None
Create a namespace.
funcpyiceberg.cli.console.properties() -> None
Properties on tables/namespaces.
funcpyiceberg.cli.console.remove() -> None
Remove a property from tables/namespaces.
funcpyiceberg.cli.console.rename(ctx:Context, from_identifier:str, to_identifier:str) -> None
Rename a table.
funcpyiceberg.cli.console.schema(ctx:Context, identifier:str) -> None
Get the schema of the table.
funcpyiceberg.cli.console.set() -> None
Set a property on tables/namespaces.
funcpyiceberg.cli.console.spec(ctx:Context, identifier:str) -> None
Return the partition spec of the table.
funcpyiceberg.cli.console.table(ctx:Context, identifier:str) -> None
Drop a table.
funcpyiceberg.cli.console.uuid(ctx:Context, identifier:str) -> None
Return the UUID of the table.
funcpyiceberg.cli.console.version(ctx:Context) -> None
Print the installed pyiceberg package version.
classpyiceberg.cli.output.ConsoleOutput
Writes to the console.
classpyiceberg.cli.output.JsonOutput
Writes json to stdout.
classpyiceberg.cli.output.JsonOutput.FauxTable
Just to encode it using Pydantic.
classpyiceberg.cli.output.Output
Output interface for exporting.
funcpyiceberg.conversions.from_bytes(primitive_type:PrimitiveType, b:bytes) -> L
Convert bytes to a built-in python value.
funcpyiceberg.conversions.from_json(primitive_type:PrimitiveType, val:Any) -> L
Convert JSON value types into built-in python values.
funcpyiceberg.conversions.to_bytes(primitive_type:PrimitiveType, _:bool | bytes | Decimal | date | datetime | float | int | str | time | uuid.UUID) -> bytes
Convert a built-in python value to bytes.
funcpyiceberg.conversions.to_json(primitive_type:PrimitiveType, val:Any) -> L
Convert built-in python values into JSON value types.
classpyiceberg.exceptions.BadRequestError
Raises when an invalid request is being made.
classpyiceberg.exceptions.CommitFailedException
Commit failed, refresh and try again.
classpyiceberg.exceptions.CommitStateUnknownException
Commit failed due to unknown reason.
classpyiceberg.exceptions.NamespaceNotEmptyError
Raised when a name-space being dropped is not empty.
classpyiceberg.exceptions.NoSuchNamespaceError
Raised when a referenced name-space is not found.
classpyiceberg.exceptions.NoSuchPlanTaskError
Raised when a scan plan task is not found.
classpyiceberg.exceptions.NoSuchPropertyException
When a property is missing.
classpyiceberg.exceptions.NoSuchTableError
Raises when the table can't be found in the REST catalog.
classpyiceberg.exceptions.NoSuchViewError
Raises when the view can't be found in the REST catalog.
classpyiceberg.exceptions.NotInstalledError
When an optional dependency is not installed.
classpyiceberg.exceptions.OAuthError
Raises when there is an error with the OAuth call.
classpyiceberg.exceptions.RESTError
Raises when there is an unknown response from the REST Catalog.
classpyiceberg.exceptions.ServiceUnavailableError
Raises when the service doesn't respond.
classpyiceberg.exceptions.SignError
Raises when unable to sign a S3 request.
classpyiceberg.exceptions.UnauthorizedError
Raises when you don't have the proper authorization.
classpyiceberg.exceptions.ValidationError
Raises when there is an issue with the schema.
classpyiceberg.exceptions.ValidationException
Raised when validation fails.
classpyiceberg.exceptions.WaitingForLockException
Need to wait for a lock, try again.
classpyiceberg.expressions.AlwaysFalse
FALSE expression.
classpyiceberg.expressions.AlwaysTrue
TRUE expression.
classpyiceberg.expressions.And
AND operation expression - logical conjunction.
classpyiceberg.expressions.BooleanExpression
An expression that evaluates to a boolean.
classpyiceberg.expressions.Bound
Represents a bound value expression.
classpyiceberg.expressions.BoundReference
A reference bound to a field in a schema.
classpyiceberg.expressions.BoundTerm
Represents a bound term.
methodpyiceberg.expressions.BoundTerm.ref() -> BoundReference
Return the bound reference.
classpyiceberg.expressions.Not
NOT operation expression - logical negation.
classpyiceberg.expressions.Or
OR operation expression - logical disjunction.
classpyiceberg.expressions.Reference
A reference not yet bound to a field in a schema.
methodpyiceberg.expressions.Reference.bind(schema:Schema, case_sensitive:bool=True) -> BoundReference
Bind the reference to an Iceberg schema.
classpyiceberg.expressions.Term
A simple expression that evaluates to a value.
classpyiceberg.expressions.Unbound
Represents an unbound value expression.
classpyiceberg.expressions.UnboundTerm
Represents an unbound term.
funcpyiceberg.expressions.literals.literal(value:L) -> Literal[L]
Construct an Iceberg Literal based on Python primitive data type.
funcpyiceberg.expressions.parser.parse(expr:str) -> BooleanExpression
Parse a boolean expression.
classpyiceberg.io.FileIO
A base class for FileIO implementations.
methodpyiceberg.io.FileIO.delete(location:str | InputFile | OutputFile) -> None
Delete the file at the given path.
classpyiceberg.io.InputFile
A base class for InputFile implementations.
methodpyiceberg.io.InputFile.exists() -> bool
Check whether the location exists.
methodpyiceberg.io.InputFile.location() -> str
The fully-qualified location of the input file.
methodpyiceberg.io.InputFile.open(seekable:bool=True) -> InputStream
Return an object that matches the InputStream protocol.
classpyiceberg.io.OutputFile
A base class for OutputFile implementations.
methodpyiceberg.io.OutputFile.create(overwrite:bool=False) -> OutputStream
Return an object that matches the OutputStream protocol.
methodpyiceberg.io.OutputFile.exists() -> bool
Check whether the location exists.
methodpyiceberg.io.OutputFile.location() -> str
The fully-qualified location of the output file.
classpyiceberg.io.fileformat.FileFormatFactory
Registry of FileFormatModel implementations.
classpyiceberg.io.fileformat.FileFormatModel
Represents a file format's capabilities.
methodpyiceberg.io.fileformat.FileFormatModel.add_field_metadata(field:NestedField, metadata:dict[bytes, bytes], include_field_ids:bool) -> None
Add format-specific Arrow field metadata.
methodpyiceberg.io.fileformat.FileFormatModel.file_extension() -> str
Return file extension without dot, e.g.
classpyiceberg.io.fileformat.FileFormatWriter
Writes data to a single file in a specific format.
methodpyiceberg.io.fileformat.FileFormatWriter.close() -> DataFileStatistics
Finalize the file and return statistics.
methodpyiceberg.io.fileformat.FileFormatWriter.result() -> DataFileStatistics
Return statistics from a previous close() call.
methodpyiceberg.io.fileformat.FileFormatWriter.write(table:pa.Table) -> None
Write a batch of data.
classpyiceberg.io.fsspec.FsspecFileIO
A FileIO implementation that uses fsspec.
methodpyiceberg.io.fsspec.FsspecFileIO.delete(location:str | InputFile | OutputFile) -> None
Delete the file at the given location.
methodpyiceberg.io.fsspec.FsspecFileIO.get_fs(scheme:str, hostname:str | None=None) -> AbstractFileSystem
Get a filesystem for a specific scheme, cached per thread.
classpyiceberg.io.fsspec.FsspecInputFile
An input file implementation for the FsspecFileIO.
methodpyiceberg.io.fsspec.FsspecInputFile.exists() -> bool
Check whether the location exists.
methodpyiceberg.io.fsspec.FsspecInputFile.open(seekable:bool=True) -> InputStream
Create an input stream for reading the contents of the file.
classpyiceberg.io.fsspec.FsspecOutputFile
An output file implementation for the FsspecFileIO.
methodpyiceberg.io.fsspec.FsspecOutputFile.create(overwrite:bool=False) -> OutputStream
Create an output stream for reading the contents of the file.
methodpyiceberg.io.fsspec.FsspecOutputFile.exists() -> bool
Check whether the location exists.
classpyiceberg.io.fsspec.S3RequestSigner
Abstract base class for S3 request signers.
classpyiceberg.io.pyarrow.ParquetFormatModel
Format model for Apache Parquet.
classpyiceberg.io.pyarrow.ParquetFormatWriter
Writes Arrow tables to a Parquet file.
funcpyiceberg.io.pyarrow.compute_statistics_plan(schema:Schema, table_properties:dict[str, str]) -> dict[int, StatisticsCollector]
Compute the statistics plan for all columns.
funcpyiceberg.io.pyarrow.parquet_path_to_id_mapping(schema:Schema) -> dict[str, int]
Compute the mapping of parquet column path to Iceberg ID.
funcpyiceberg.manifest.clear_manifest_cache() -> None
Clear cached ManifestFile objects.
funcpyiceberg.manifest.read_manifest_list(input_file:InputFile) -> Iterator[ManifestFile]
Read the manifests from the manifest list.
methodpyiceberg.schema.Accessor.get(container:StructProtocol) -> Any
Return the value at self.position in `container`.
classpyiceberg.schema.Schema
A table Schema.
methodpyiceberg.schema.Schema.accessor_for_field(field_id:int) -> Accessor
Find a schema position accessor given a field ID.
methodpyiceberg.schema.Schema.as_arrow() -> pa.Schema
Return the schema as an Arrow schema.
methodpyiceberg.schema.Schema.as_struct() -> StructType
Return the schema as a struct.
methodpyiceberg.schema.Schema.columns() -> tuple[NestedField, ...]
A tuple of the top-level fields.
methodpyiceberg.schema.Schema.field_ids() -> set[int]
Return the IDs of the current schema.
methodpyiceberg.schema.Schema.find_column_name(column_id:int) -> str | None
Find a column name given a column ID.
methodpyiceberg.schema.Schema.find_field(name_or_id:str | int, case_sensitive:bool=True) -> NestedField
Find a field using a field name or field ID.
methodpyiceberg.schema.Schema.find_type(name_or_id:str | int, case_sensitive:bool=True) -> IcebergType
Find a field type using a field name or field ID.
methodpyiceberg.schema.Schema.identifier_field_names() -> set[str]
Return the names of the identifier fields.
methodpyiceberg.schema.Schema.select(*case_sensitive:bool=True, *names:str) -> Schema
Return a new schema instance pruned to a subset of columns.
funcpyiceberg.schema.assign_fresh_schema_ids(schema_or_type:Schema | IcebergType, next_id:Callable[[], int] | None=None) -> Schema
Traverses the schema, and sets new IDs.
funcpyiceberg.schema.index_by_id(schema_or_type:Schema | IcebergType) -> dict[int, NestedField]
Generate an index of field IDs to NestedField instances.
funcpyiceberg.schema.index_by_name(schema_or_type:Schema | IcebergType) -> dict[str, int]
Generate an index of field names to field IDs.
funcpyiceberg.schema.index_name_by_id(schema_or_type:Schema | IcebergType) -> dict[int, str]
Generate an index of field IDs full field names.
funcpyiceberg.schema.make_compatible_name(name:str) -> str
Make a field name compatible with Avro specification.
funcpyiceberg.schema.pre_order_visit(obj:Schema | IcebergType, visitor:PreOrderSchemaVisitor[T]) -> T
Apply a schema visitor to any point within a schema.
funcpyiceberg.schema.promote(file_type:IcebergType, read_type:IcebergType) -> IcebergType
Promotes reading a file type to a read type.
funcpyiceberg.schema.prune_columns(schema:Schema, selected:set[int], select_full_types:bool=True) -> Schema
Prunes a column by only selecting a set of field-ids.
funcpyiceberg.schema.sanitize_column_names(schema:Schema) -> Schema
Sanitize column names to make them compatible with Avro.
funcpyiceberg.schema.visit(obj:Schema | IcebergType, visitor:SchemaVisitor[T]) -> T
Apply a schema visitor to any point within a schema.
methodpyiceberg.serializers.Compressor.bytes_compressor() -> Callable[[bytes], bytes]
Return a function to compress bytes.
methodpyiceberg.serializers.Compressor.stream_decompressor(inp:InputStream) -> InputStream
Return a stream decompressor.
classpyiceberg.table.BaseScan
A base class for all table scans.
methodpyiceberg.table.BaseScan.to_duckdb(table_name:str, connection:DuckDBPyConnection | None=None) -> DuckDBPyConnection
Shorthand for loading the Iceberg Table in DuckDB.
methodpyiceberg.table.BaseScan.to_pandas(**kwargs:Any) -> pd.DataFrame
Read a Pandas DataFrame eagerly from this Iceberg table.
methodpyiceberg.table.BaseScan.to_polars() -> pl.DataFrame
Read a Polars DataFrame from this Iceberg table.
methodpyiceberg.table.BaseScan.to_ray() -> ray.data.dataset.Dataset
Read a Ray Dataset eagerly from this Iceberg table.
methodpyiceberg.table.BaseScan.update(**overrides:Any) -> A
Create a copy of this table scan with updated fields.
classpyiceberg.table.CommitTableRequest
A pydantic BaseModel for a table commit request.
classpyiceberg.table.CommitTableResponse
A pydantic BaseModel for a table commit response.
classpyiceberg.table.CreateTableTransaction
A transaction that involves the creation of a new table.
methodpyiceberg.table.CreateTableTransaction.commit_transaction() -> Table
Commit the changes to the catalog.
methodpyiceberg.table.FileScanTask.from_rest_response(rest_task:RESTFileScanTask, delete_files:list[RESTDeleteFile]) -> FileScanTask
Convert a RESTFileScanTask to a FileScanTask.
classpyiceberg.table.ManifestGroupPlanner
Plans the scan tasks for a group of manifests.
classpyiceberg.table.Namespace
Reference to one or more levels of a namespace.
classpyiceberg.table.Table
An Iceberg table.
methodpyiceberg.table.Table.history() -> list[SnapshotLogEntry]
Get the snapshot history of this table.
methodpyiceberg.table.Table.location() -> str
Return the table's base location.
methodpyiceberg.table.Table.location_provider() -> LocationProvider
Return the table's location provider.
methodpyiceberg.table.Table.maintenance() -> MaintenanceTable
Return the MaintenanceTable object for maintenance.
methodpyiceberg.table.Table.name() -> Identifier
Return the identifier of this table.
methodpyiceberg.table.Table.name_mapping() -> NameMapping | None
Return the table's field-id NameMapping.
methodpyiceberg.table.Table.properties() -> dict[str, str]
Properties of the table.
methodpyiceberg.table.Table.refresh() -> Table
Refresh the current table metadata.
methodpyiceberg.table.Table.refs() -> dict[str, SnapshotRef]
Return the snapshot references in the table.
methodpyiceberg.table.Table.schema() -> Schema
Return the schema for this table.
methodpyiceberg.table.Table.schemas() -> dict[int, Schema]
Return a dict of the schema of this table.
methodpyiceberg.table.Table.sort_order() -> SortOrder
Return the sort order of this table.
methodpyiceberg.table.Table.sort_orders() -> dict[int, SortOrder]
Return a dict of the sort orders of this table.
methodpyiceberg.table.Table.spec() -> PartitionSpec
Return the partition spec of this table.
methodpyiceberg.table.Table.specs() -> dict[int, PartitionSpec]
Return a dict the partition specs this table.
methodpyiceberg.table.Table.to_bodo() -> bd.DataFrame
Read a bodo DataFrame lazily from this Iceberg table.
methodpyiceberg.table.Table.to_daft() -> daft.DataFrame
Read a Daft DataFrame lazily from this Iceberg table.
methodpyiceberg.table.Table.to_polars() -> pl.LazyFrame
Lazily read from this Apache Iceberg table.
classpyiceberg.table.TableIdentifier
Fully Qualified identifier to a table.
classpyiceberg.table.TableScan
A base class for table scans targeting a single snapshot.
methodpyiceberg.table.Transaction.commit_transaction() -> Table
Commit the changes to the catalog.
methodpyiceberg.table.Transaction.remove_properties(*removals:str) -> Transaction
Remove properties.
methodpyiceberg.table.Transaction.set_properties(properties:Properties=EMPTY_DICT, **kwargs:Any) -> Transaction
Set properties.
methodpyiceberg.table.Transaction.update_location(location:str) -> Transaction
Set the new table location.
methodpyiceberg.table.Transaction.upgrade_table_version(format_version:TableVersion) -> Transaction
Set the table to a certain version.
classpyiceberg.table.UpsertResult
Summary the upsert operation.
classpyiceberg.table.WriteTask
Task with the parameters for writing a DataFile.
classpyiceberg.table.metadata.TableMetadataUtil
Helper class for parsing TableMetadata.
classpyiceberg.table.metadata.TableMetadataV1
Represents version 1 of the Table Metadata.
methodpyiceberg.table.metadata.TableMetadataV1.construct_partition_specs(data:dict[str, Any]) -> dict[str, Any]
Convert the partition_spec into partition_specs.
methodpyiceberg.table.metadata.TableMetadataV1.construct_schemas(data:dict[str, Any]) -> dict[str, Any]
Convert the schema into schemas.
methodpyiceberg.table.metadata.TableMetadataV1.set_sort_orders(data:dict[str, Any]) -> dict[str, Any]
Set the sort_orders if not provided.
classpyiceberg.table.metadata.TableMetadataV2
Represents version 2 of the Table Metadata.
classpyiceberg.table.metadata.TableMetadataV3
Represents version 3 of the Table Metadata.
funcpyiceberg.table.metadata.check_partition_specs(table_metadata:TableMetadata) -> TableMetadata
Check if the default-spec-id is present in partition-specs.
funcpyiceberg.table.metadata.cleanup_snapshot_id(data:dict[str, Any]) -> dict[str, Any]
Run before validation.
funcpyiceberg.table.metadata.construct_refs(table_metadata:TableMetadata) -> TableMetadata
Set the main branch if missing.
classpyiceberg.table.snapshots.Operation
Describes the operation.
methodpyiceberg.table.snapshots.Snapshot.manifests(io:FileIO) -> list[ManifestFile]
Return the manifests for the given snapshot.
classpyiceberg.table.snapshots.Summary
A class that stores the summary information for a Snapshot.
classpyiceberg.table.sorting.SortField
Sort order field.
classpyiceberg.table.sorting.SortOrder
Describes how the data is sorted within the table.
classpyiceberg.table.update.AssertTableUUID
The table UUID must match the requirement's `uuid`.
classpyiceberg.table.update.snapshot.ExpireSnapshots
Expire snapshots by ID.
methodpyiceberg.table.update.snapshot.ExpireSnapshots.by_id(snapshot_id:int) -> ExpireSnapshots
Expire a snapshot by its ID.
methodpyiceberg.table.update.snapshot.ExpireSnapshots.by_ids(snapshot_ids:list[int]) -> ExpireSnapshots
Expire multiple snapshots by their IDs.
classpyiceberg.table.update.snapshot.ManageSnapshots
Run snapshot management operations using APIs.
methodpyiceberg.table.update.snapshot.ManageSnapshots.remove_branch(branch_name:str) -> ManageSnapshots
Remove a branch.
methodpyiceberg.table.update.snapshot.ManageSnapshots.remove_tag(tag_name:str) -> ManageSnapshots
Remove a tag.
methodpyiceberg.table.update.snapshot.ManageSnapshots.rollback_to_snapshot(snapshot_id:int) -> ManageSnapshots
Rollback the table to the given snapshot id.
classpyiceberg.table.update.statistics.UpdateStatistics
Run statistics management operations using APIs.
classpyiceberg.transforms.BoundTransform
A transform expression.
classpyiceberg.transforms.DayTransform
Transforms a datetime value into a day value.
methodpyiceberg.transforms.DayTransform.result_type(source:IcebergType) -> IcebergType
Return the result type of a day transform.
classpyiceberg.transforms.HourTransform
Transforms a datetime value into a hour value.
classpyiceberg.transforms.IdentityTransform
Transforms a value into itself.
classpyiceberg.transforms.MonthTransform
Transforms a datetime value into a month value.
classpyiceberg.transforms.Transform
Transform base class for concrete transforms.
classpyiceberg.transforms.TruncateTransform
A transform for truncating a value to a specified width.
classpyiceberg.transforms.VoidTransform
A transform that always returns None.
classpyiceberg.transforms.YearTransform
Transforms a datetime value into a year value.
classpyiceberg.typedef.IcebergBaseModel
This class extends the Pydantic BaseModel to set default values by overriding them.
classpyiceberg.types.DecimalType
A decimal data type in Iceberg.
methodpyiceberg.types.DecimalType.precision() -> int
Return the precision of the decimal.
methodpyiceberg.types.DecimalType.scale() -> int
Return the scale of the decimal.
methodpyiceberg.types.DecimalType.ser_model() -> str
Serialize the model to a string.
classpyiceberg.types.FixedType
A fixed data type in Iceberg.
methodpyiceberg.types.GeographyType.algorithm() -> str
Return the algorithm used for geographic calculations.
methodpyiceberg.types.GeographyType.minimum_format_version() -> TableVersion
Geography type requires Iceberg format version 3.
methodpyiceberg.types.GeographyType.ser_model() -> str
Serialize the model to a string.
methodpyiceberg.types.GeometryType.minimum_format_version() -> TableVersion
Geometry type requires Iceberg format version 3.
methodpyiceberg.types.GeometryType.ser_model() -> str
Serialize the model to a string.
classpyiceberg.types.IcebergType
Base type for all Iceberg Types.
classpyiceberg.types.ListType
A list type in Iceberg.
classpyiceberg.types.MapType
A map type in Iceberg.
classpyiceberg.types.PrimitiveType
Base class for all Iceberg Primitive Types.
classpyiceberg.types.StructType
A struct type in Iceberg.
funcpyiceberg.types.strtobool(val:str) -> bool
Convert a string representation of truth to true (1) or false (0).
funcpyiceberg.types.transform_dict_value_to_str(dict:dict[str, Any]) -> dict[str, str]
Transform all values in the dictionary to string.
methodpyiceberg.utils.config.Config.get_default_catalog_name() -> str
Return the default catalog name.
funcpyiceberg.utils.config.merge_config(lhs:RecursiveDict, rhs:RecursiveDict) -> RecursiveDict
Merge right-hand side into the left-hand side.
funcpyiceberg.utils.datetime.date_str_to_days(date_str:str) -> int
Convert an ISO-8601 formatted date to days from 1970-01-01.
funcpyiceberg.utils.datetime.date_to_days(date_val:date) -> int
Convert a Python date object to days from 1970-01-01.
funcpyiceberg.utils.datetime.datetime_to_micros(dt:datetime) -> int
Convert a datetime to microseconds from 1970-01-01T00:00:00.000000.
funcpyiceberg.utils.datetime.datetime_to_millis(dt:datetime) -> int
Convert a datetime to milliseconds from 1970-01-01T00:00:00.000000.
funcpyiceberg.utils.datetime.days_to_date(days:int) -> date
Create a date from the number of days from 1970-01-01.
funcpyiceberg.utils.datetime.micros_to_days(timestamp:int) -> int
Convert a timestamp in microseconds to a date in days.
funcpyiceberg.utils.datetime.micros_to_hours(micros:int) -> int
Convert a timestamp in microseconds to hours from 1970-01-01T00:00.
funcpyiceberg.utils.datetime.micros_to_time(micros:int) -> time
Convert a timestamp in microseconds to a time.
funcpyiceberg.utils.datetime.micros_to_timestamp(micros:int) -> datetime
Convert microseconds from epoch to a timestamp.
funcpyiceberg.utils.datetime.micros_to_timestamptz(micros:int) -> datetime
Convert microseconds from epoch to an utc timestamp.
funcpyiceberg.utils.datetime.millis_to_datetime(millis:int) -> datetime
Convert milliseconds from epoch to a timestamp.
funcpyiceberg.utils.datetime.nanos_to_days(nanos:int) -> int
Convert a timestamp in nanoseconds to a date in days.
funcpyiceberg.utils.datetime.nanos_to_hours(nanos:int) -> int
Convert a timestamp in nanoseconds to hours from 1970-01-01T00:00.
funcpyiceberg.utils.datetime.nanos_to_time(nanos:int) -> time
Convert a timestamp in nanoseconds to a microsecond precision time.
funcpyiceberg.utils.datetime.nanos_to_timestamp(nanos:int) -> datetime
Convert nanoseconds from epoch to a microsecond timestamp.
funcpyiceberg.utils.datetime.time_str_to_micros(time_str:str) -> int
Convert an ISO-8601 formatted time to microseconds from midnight.
funcpyiceberg.utils.datetime.time_str_to_nanos(time_str:str) -> int
Convert an ISO-8601 formatted time to nanoseconds from midnight.
funcpyiceberg.utils.datetime.time_to_micros(t:time) -> int
Convert a datetime.time object to microseconds from midnight.
funcpyiceberg.utils.datetime.time_to_nanos(t:time) -> int
Convert a datetime.time object to nanoseconds from midnight.
funcpyiceberg.utils.datetime.to_human_day(day_ordinal:int) -> str
Convert a DateType value to human string.
funcpyiceberg.utils.datetime.to_human_hour(hour_ordinal:int) -> str
Convert a DateType value to human string.
funcpyiceberg.utils.datetime.to_human_month(month_ordinal:int) -> str
Convert a DateType value to human string.
funcpyiceberg.utils.datetime.to_human_time(micros_from_midnight:int) -> str
Convert a TimeType value to human string.
funcpyiceberg.utils.datetime.to_human_timestamp(timestamp_micros:int) -> str
Convert a TimestampType value to human string.
funcpyiceberg.utils.datetime.to_human_timestamptz(timestamp_micros:int) -> str
Convert a TimestamptzType value to human string.
funcpyiceberg.utils.datetime.to_human_year(year_ordinal:int) -> str
Convert a DateType value to human string.
funcpyiceberg.utils.decimal.bytes_to_decimal(value:bytes, scale:int) -> Decimal
Return a decimal from the bytes.
funcpyiceberg.utils.decimal.decimal_required_bytes(precision:int) -> int
Compute the number of bytes required to store a precision.
funcpyiceberg.utils.decimal.decimal_to_bytes(value:Decimal, byte_length:int | None=None) -> bytes
Return a byte representation of a decimal.
funcpyiceberg.utils.decimal.decimal_to_unscaled(value:Decimal) -> int
Get an unscaled value given a Decimal value.
funcpyiceberg.utils.decimal.truncate_decimal(value:Decimal, width:int) -> Decimal
Get a truncated Decimal value given a decimal value and a width.
funcpyiceberg.utils.decimal.unscaled_to_decimal(unscaled:int, scale:int) -> Decimal
Get a scaled Decimal value given an unscaled value and a scale.
funcpyiceberg.utils.deprecated.deprecated(deprecated_in:str, removed_in:str, help_message:str | None=None) -> Callable
Mark functions as deprecated.
funcpyiceberg.utils.deprecated.deprecation_message(deprecated_in:str, removed_in:str, help_message:str | None) -> None
Mark properties or behaviors as deprecated.
funcpyiceberg.utils.deprecated.deprecation_notice(deprecated_in:str, removed_in:str, help_message:str | None) -> str
Return a deprecation notice.
classpyiceberg.utils.lazydict.LazyDict
Lazily build a dictionary from an array of items.
classpyiceberg.utils.schema_conversion.ConvertSchemaToAvro
Convert an Iceberg schema to an Avro schema.
classpyiceberg.view.View
An Iceberg view.
methodpyiceberg.view.View.current_version() -> ViewVersion
Get the version of this view.
methodpyiceberg.view.View.history() -> list[ViewHistoryEntry]
Get the version of this history view.
methodpyiceberg.view.View.location() -> str
Return the view's base location.
methodpyiceberg.view.View.name() -> Identifier
Return the identifier of this view.
methodpyiceberg.view.View.properties() -> dict[str, str]
Return a map of string properties for this view.
methodpyiceberg.view.View.schema() -> Schema
Return the schema for this view.
methodpyiceberg.view.View.schemas() -> dict[int, Schema]
Return the schemas for this view.
methodpyiceberg.view.View.uuid() -> UUID
Return the view's UUID.
methodpyiceberg.view.View.versions() -> list[ViewVersion]
Get the versions of this view.
classpyiceberg.view.metadata.SQLViewRepresentation
Represents the SQL query that defines the view.
classpyiceberg.view.metadata.ViewHistoryEntry
A log entry of a view version change.
classpyiceberg.view.metadata.ViewMetadata
The metadata for a view.
classpyiceberg.view.metadata.ViewVersion
A version of the view definition.

この情報について

掲載しているシグネチャは apache/iceberg-python の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・ 型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。 詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る