API Reference

Reference for the importable Python API, generated from the NumPy-style docstrings.

iceberg-ops is alpha software: until 1.0, any release may change these APIs. The schema-migration modules are the core of the project. The data migrator and the Apache Polaris policy executor are experimental, and the maintenance helpers are basic and frozen in scope; their pages say what each one does not cover.

Schema migrations

• Migration Context
  • iceberg_ops.migration
  • MigrationContext
  • BaseMigration
• Migration Runner
  • iceberg_ops.runner
  • normalize_version()
  • MigrationRunner
• Migration History
  • iceberg_ops.history
  • ConcurrentMigrationError
  • MigrationHistory
• Scaffolding
  • iceberg_ops.scaffolding
  • init_project()
  • create_revision()
• Autogenerate
  • iceberg_ops.autogen
  • MigrationOp
  • properties_diff_to_ops()
  • render_migration_body()
  • render_migration_file()
  • schema_diff_to_ops()
  • sort_order_diff_to_ops()
  • spec_diff_to_ops()
  • write_autogenerated_revision()
• CLI Module
  • iceberg_ops.cli

Core helpers

• Catalog Factory
  • iceberg_ops.core.catalog
  • default_local_paths()
  • CatalogFactory
• Schema Helpers
  • iceberg_ops.core.schema
  • FieldChange
  • SchemaDiff
  • diff_schemas()
  • ColumnSpec
  • SchemaContractViolation
  • SchemaContract
  • SchemaEvolutionHelper
• Arrow / Iceberg Type Bridge
  • iceberg_ops.core.types
  • arrow_type_to_iceberg()
  • is_allowed_promotion()
  • iceberg_type_to_arrow()
• Core Utilities
  • iceberg_ops.core.utils
  • create_arrow_table()
  • upsert_streaming()
  • rollback_to_snapshot()
  • get_snapshots()
  • print_time_travel()
  • trace_field_history()

Experimental

• Data Migration
  • Package
  • Schema Reconciler
  • Checkpoint Store
  • Migrator
• Maintenance
  • Package
  • Compaction
  • Snapshot Expiry
  • Orphan Cleanup
  • Health Report
• Polaris
  • Package
  • Client
  • Policies
  • Dispatcher

Testing

• Testing
  • iceberg_ops.testing
  • FakeResponse
  • FakeSession