Deprecated API

Contents

• Interfaces
• Classes
• Fields
• Methods
• Constructors

Deprecated Interfaces

Interface	Description
org.apache.iceberg.encryption.KmsClient	the API will be removed in v2.0.0 (replaced with KeyManagementClient interface).
org.apache.iceberg.encryption.NativelyEncryptedFile	will be removed in 2.0.0
org.apache.iceberg.io.CredentialSupplier	since 1.10.0, will be removed in 2.0.0
org.apache.iceberg.metrics.MetricsContext.Counter	will be removed in 2.0.0, use Counter instead.

Deprecated Classes

Class	Description
org.apache.iceberg.encryption.NativeFileCryptoParameters	will be removed in 2.0.0
org.apache.iceberg.flink.source.FlinkSource	since 1.7.0, will be removed in 2.0.0. Use IcebergSource instead, which implement the newer FLIP-27 source interface. This class implements the old SourceFunction that has been marked as deprecated in Flink since Aug 2023.
org.apache.iceberg.flink.source.reader.AvroGenericRecordReaderFunction	since 1.7.0. Will be removed in 2.0.0; use IcebergSource.forOutputType(RowDataConverter) and AvroGenericRecordConverter instead.
org.apache.iceberg.parquet.ParquetWriteAdapter	use ParquetWriter

Deprecated Fields

Field	Description
org.apache.iceberg.rest.RESTCatalogProperties.SIGNER_ENDPOINT	since 1.12.0, will be removed in 1.13.0; there is no replacement
org.apache.iceberg.rest.RESTCatalogProperties.SIGNER_URI	since 1.12.0, will be removed in 1.13.0; there is no replacement
org.apache.iceberg.SystemConfigs.NETFLIX_UNSAFE_PARQUET_ID_FALLBACK_ENABLED	will be removed in 2.0.0; use name mapping instead
org.apache.iceberg.TableProperties.OBJECT_STORE_PATH	will be removed in 2.0.0, use TableProperties.WRITE_DATA_LOCATION instead.
org.apache.iceberg.TableProperties.SPARK_WRITE_ACCEPT_ANY_SCHEMA	will be removed in 1.14.0, use SparkTableProperties.WRITE_ACCEPT_ANY_SCHEMA in iceberg-spark instead.
org.apache.iceberg.TableProperties.SPARK_WRITE_ACCEPT_ANY_SCHEMA_DEFAULT	will be removed in 1.14.0, use SparkTableProperties.WRITE_ACCEPT_ANY_SCHEMA_DEFAULT in iceberg-spark instead.
org.apache.iceberg.TableProperties.SPARK_WRITE_ADVISORY_PARTITION_SIZE_BYTES	will be removed in 1.14.0, use SparkTableProperties.WRITE_ADVISORY_PARTITION_SIZE_BYTES in iceberg-spark instead.
org.apache.iceberg.TableProperties.SPARK_WRITE_AUTO_SCHEMA_EVOLUTION	will be removed in 1.14.0, use SparkTableProperties.WRITE_AUTO_SCHEMA_EVOLUTION in iceberg-spark instead.
org.apache.iceberg.TableProperties.SPARK_WRITE_AUTO_SCHEMA_EVOLUTION_DEFAULT	will be removed in 1.14.0, use SparkTableProperties.WRITE_AUTO_SCHEMA_EVOLUTION_DEFAULT in iceberg-spark instead.
org.apache.iceberg.TableProperties.SPARK_WRITE_PARTITIONED_FANOUT_ENABLED	will be removed in 1.14.0, use SparkTableProperties.WRITE_PARTITIONED_FANOUT_ENABLED in iceberg-spark instead.
org.apache.iceberg.TableProperties.SPARK_WRITE_PARTITIONED_FANOUT_ENABLED_DEFAULT	will be removed in 1.14.0, use SparkTableProperties.WRITE_PARTITIONED_FANOUT_ENABLED_DEFAULT in iceberg-spark instead.
org.apache.iceberg.TableProperties.WRITE_FOLDER_STORAGE_LOCATION	will be removed in 2.0.0, use TableProperties.WRITE_DATA_LOCATION instead.
org.apache.spark.sql.catalyst.parser.extensions.IcebergSqlExtensionsLexer.tokenNames	Use IcebergSqlExtensionsLexer.VOCABULARY instead.
org.apache.spark.sql.catalyst.parser.extensions.IcebergSqlExtensionsParser.tokenNames	Use IcebergSqlExtensionsParser.VOCABULARY instead.

Deprecated Methods

Method	Description
org.apache.iceberg.aws.AwsClientFactories.configureEndpoint(T, String)	Not for public use. To configure the endpoint for a client, please use S3FileIOProperties.applyEndpointConfigurations(S3BaseClientBuilder), AwsProperties.applyGlueEndpointConfigurations(GlueClientBuilder), or AwsProperties.applyDynamoDbEndpointConfigurations(DynamoDbClientBuilder), or AwsProperties.applyKmsEndpointConfigurations(KmsClientBuilder) accordingly. It will be removed in 2.0.0
org.apache.iceberg.aws.AwsClientFactories.configureHttpClientBuilder(String)	Not for public use. To configure the httpClient for a client, please use HttpClientProperties.applyHttpClientConfigurations(AwsSyncClientBuilder). It will be removed in 2.0.0
org.apache.iceberg.aws.AwsClientFactories.s3Configuration(Boolean, Boolean)	Not for public use. To build an S3Configuration object, use S3Configuration.builder() directly. It will be removed in 2.0.0
org.apache.iceberg.connect.Committer.start(Catalog, IcebergSinkConfig, SinkTaskContext)	will be removed in 2.0.0. Use Committer.open(Catalog, IcebergSinkConfig, SinkTaskContext, Collection) instead.
org.apache.iceberg.connect.Committer.stop()	will be removed in 2.0.0. Use Committer.close(Collection) instead.
org.apache.iceberg.ContentFile.path()	since 1.7.0, will be removed in 2.0.0; use ContentFile.location() instead.
org.apache.iceberg.data.orc.GenericOrcReaders.struct(List<OrcValueReader<?>>, Types.StructType, Map<Integer, ?>)	Use GenericOrcReaders.struct(TypeDescription, List, Types.StructType, Map) instead. This method uses position-based binding which may cause field misalignment in MOR and lineage scenarios.
org.apache.iceberg.encryption.StandardEncryptionManager.addManifestListKeyMetadata(NativeEncryptionKeyMetadata)	since 1.12.0, will be removed in 1.13.0; use StandardEncryptionManager.registerKeyMetadata(NativeEncryptionKeyMetadata) instead.
org.apache.iceberg.ExpireSnapshots.cleanExpiredFiles(boolean)	since 1.11.0, will be removed in 2.0.0; use ExpireSnapshots.cleanupLevel(CleanupLevel) instead.
org.apache.iceberg.flink.FlinkSchemaUtil.convert(TableSchema)	will be removed in 2.0.0; use FlinkSchemaUtil.convert(ResolvedSchema) instead.
org.apache.iceberg.flink.FlinkSchemaUtil.convert(Schema, TableSchema)	since 1.10.0, will be removed in 2.0.0. Use FlinkSchemaUtil.convert(Schema, ResolvedSchema) instead.
org.apache.iceberg.flink.FlinkSchemaUtil.toSchema(RowType)	since 1.10.0, will be removed in 2.0.0. Use FlinkSchemaUtil.toResolvedSchema(RowType) instead
org.apache.iceberg.flink.FlinkSchemaUtil.toSchema(Schema)	since 1.10.0, will be removed in 2.0.0. Use FlinkSchemaUtil.toResolvedSchema(Schema) instead
org.apache.iceberg.flink.maintenance.api.TableMaintenance.forChangeStream(DataStream<TableChange>, TableLoader, TriggerLockFactory)	since 1.12.0, will be removed in 2.0.0. Use TableMaintenance.forChangeStream(DataStream, TableLoader) instead.
org.apache.iceberg.flink.maintenance.api.TableMaintenance.forTable(StreamExecutionEnvironment, TableLoader, TriggerLockFactory)	since 1.12.0, will be removed in 2.0.0. Use TableMaintenance.forTable(StreamExecutionEnvironment, TableLoader) instead.
org.apache.iceberg.flink.sink.dynamic.CompareSchemasVisitor.visit(Schema, Schema)
org.apache.iceberg.flink.sink.FlinkSink.forRow(DataStream<Row>, TableSchema)	since 1.10.0, will be removed in 2.0.0. Use FlinkSink.forRow(DataStream, ResolvedSchema) instead.
org.apache.iceberg.flink.sink.IcebergSink.Builder.compaction(boolean)	See rewriteDatafiles(..)
org.apache.iceberg.flink.sink.IcebergSink.forRow(DataStream<Row>, TableSchema)	Use IcebergSink.forRow(DataStream, ResolvedSchema) instead.
org.apache.iceberg.flink.source.FlinkSource.Builder.properties(Map<String, String>)	Use FlinkSource.Builder.setAll(java.util.Map<java.lang.String, java.lang.String>) instead.
org.apache.iceberg.flink.source.IcebergSource.builder()	since 1.7.0. Will be removed in 2.0.0; useIcebergSource.forRowData() or IcebergSource.forOutputType(RowDataConverter) instead
org.apache.iceberg.flink.source.IcebergSource.Builder.project(TableSchema)	since 1.10.0, will be removed in 2.0.0. Use IcebergSource.Builder.project(ResolvedSchema) instead.
org.apache.iceberg.flink.source.IcebergSource.Builder.properties(Map<String, String>)	will be removed in 2.0.0; use IcebergSource.Builder.setAll(java.util.Map<java.lang.String, java.lang.String>) instead.
org.apache.iceberg.flink.source.IcebergSource.Builder.readerFunction(ReaderFunction<T>)	since 1.7.0. Will be removed in 2.0.0; useIcebergSource.forOutputType(RowDataConverter) instead to produce output type other than RowData.
org.apache.iceberg.flink.util.FlinkCompatibilityUtil.isPhysicalColumn(TableColumn)	since 1.10.0, will be removed in 2.0.0.
org.apache.iceberg.io.BasePositionDeltaWriter.delete(CharSequence, long, T, PartitionSpec, StructLike)
org.apache.iceberg.io.PositionDeltaWriter.delete(CharSequence, long, T, PartitionSpec, StructLike)	since 1.12.0, will be removed in 1.13.0; use PositionDeltaWriter.delete(CharSequence, long, PartitionSpec, StructLike) instead, which will become the method implementations must override.
org.apache.iceberg.metrics.DefaultMetricsContext.counter(String, Class<T>, MetricsContext.Unit)	will be removed in 2.0.0, use Counter instead.
org.apache.iceberg.metrics.MetricsContext.counter(String, Class<T>, MetricsContext.Unit)	will be removed in 2.0.0, use MetricsContext.counter(String, Unit) instead.
org.apache.iceberg.metrics.MetricsContext.Counter.count()	Use MetricsContext.Counter.value()
org.apache.iceberg.MetricsConfig.fromProperties(Map<String, String>)	use MetricsConfig.forTable(Table). Will be removed in 1.13.0
org.apache.iceberg.parquet.Parquet.ReadBuilder.callInit()	will be removed in 2.0.0; use Parquet.ReadBuilder.createReaderFunc(Function) instead
org.apache.iceberg.parquet.Parquet.ReadBuilder.readSupport(ReadSupport<?>)	will be removed in 2.0.0; use Parquet.ReadBuilder.createReaderFunc(Function) instead
org.apache.iceberg.parquet.ParquetFormatModel.create(Class<D>, Class<S>, BaseFormatModel.WriterFunction<ParquetValueWriter<?>, S, MessageType>, BaseFormatModel.ReaderFunction<ParquetValueReader<?>, S, MessageType>, VariantShreddingAnalyzer<D, S>, UnaryOperator<D>)	Will be removed in 1.13.0; use ParquetFormatModel.create(Class, Class, WriterFunction, ReaderFunction, VariantShreddingAnalyzer, Function) instead.
org.apache.iceberg.rest.RESTSessionCatalog.newTableOps(RESTClient, String, Supplier<Map<String, String>>, Supplier<Map<String, String>>, FileIO, TableMetadata, Set<Endpoint>)	since 1.12.0, will be removed in 1.13.0; use RESTSessionCatalog.newTableOps(RESTClient, String, Supplier, Supplier, FileIO, TableMetadata, Set, Map) instead.
org.apache.iceberg.RewriteFiles.rewriteFiles(Set<DataFile>, Set<DataFile>)	since 1.3.0, will be removed in 2.0.0
org.apache.iceberg.RewriteFiles.rewriteFiles(Set<DataFile>, Set<DataFile>, long)	since 1.3.0, will be removed in 2.0.0
org.apache.iceberg.RewriteFiles.rewriteFiles(Set<DataFile>, Set<DeleteFile>, Set<DataFile>, Set<DeleteFile>)	since 1.3.0, will be removed in 2.0.0
org.apache.iceberg.RewriteTablePathUtil.rewriteDeleteManifest(ManifestFile, Set<Long>, OutputFile, FileIO, int, Map<Integer, PartitionSpec>, String, String, String)	since 1.12.0, will be removed in 1.13.0; use the overload that accepts the map of rewritten position delete file sizes. This overload records the original file_size_in_bytes, which can be inconsistent with the rewritten file size on disk once embedded data file paths change length.
org.apache.iceberg.RewriteTablePathUtil.rewritePositionDeleteFile(DeleteFile, OutputFile, FileIO, PartitionSpec, String, String, RewriteTablePathUtil.PositionDeleteReaderWriter)	since 1.12.0, will be removed in 1.13.0; use RewriteTablePathUtil.rewritePositionDelete(org.apache.iceberg.DeleteFile, org.apache.iceberg.io.OutputFile, org.apache.iceberg.io.FileIO, org.apache.iceberg.PartitionSpec, java.lang.String, java.lang.String, org.apache.iceberg.RewriteTablePathUtil.PositionDeleteReaderWriter) which returns the size of the rewritten file so callers can record an accurate file_size_in_bytes.
org.apache.iceberg.Snapshot.addedDataFiles(FileIO)	will be removed in 2.0.0; use SnapshotChanges#builderFor(Table) instead
org.apache.iceberg.Snapshot.addedDeleteFiles(FileIO)	will be removed in 2.0.0; use SnapshotChanges#builderFor(Table) instead
org.apache.iceberg.Snapshot.removedDataFiles(FileIO)	will be removed in 2.0.0; use SnapshotChanges#builderFor(Table) instead
org.apache.iceberg.Snapshot.removedDeleteFiles(FileIO)	will be removed in 2.0.0; use SnapshotChanges#builderFor(Table) instead
org.apache.iceberg.TableScan.appendsAfter(long)	since 1.0.0, will be removed in 2.0.0; use Table.newIncrementalAppendScan() instead.
org.apache.iceberg.TableScan.appendsBetween(long, long)	since 1.0.0, will be removed in 2.0.0; use Table.newIncrementalAppendScan() instead.
org.apache.iceberg.transforms.Transform.apply(S)	use Transform.bind(Type) instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transform.toHumanString(T)	use Transform.toHumanString(Type, Object) instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transforms.bucket(Type, int)	use Transforms.bucket(int) instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transforms.day(Type)	use Transforms.day() instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transforms.fromString(Type, String)	use Transforms.identity() instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transforms.hour(Type)	use Transforms.hour() instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transforms.identity(Type)	use Transforms.identity() instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transforms.month(Type)	use Transforms.month() instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transforms.truncate(Type, int)	use Transforms.truncate(int) instead; will be removed in 2.0.0
org.apache.iceberg.transforms.Transforms.year(Type)	use Transforms.year() instead; will be removed in 2.0.0
org.apache.iceberg.transforms.UnknownTransform.apply(S)	will be removed in 2.0.0; use UnknownTransform.bind(Type) instead
org.apache.iceberg.types.Types.NestedField.Builder.withInitialDefault(Object)	will be removed in 2.0.0; use Types.NestedField.Builder.withInitialDefault(Literal) instead.
org.apache.iceberg.types.Types.NestedField.Builder.withWriteDefault(Object)	will be removed in 2.0.0; use Types.NestedField.Builder.withWriteDefault(Literal) instead.
org.apache.iceberg.types.Types.NestedField.of(int, boolean, String, Type)	will be removed in 2.0.0; use Types.NestedField.builder() instead.
org.apache.iceberg.types.Types.NestedField.of(int, boolean, String, Type, String)	will be removed in 2.0.0; use Types.NestedField.builder() instead.
org.apache.iceberg.types.Types.NestedField.withFieldId(int)	will be removed in 2.0.0; use Types.NestedField.Builder.withId(int) instead
org.apache.iceberg.types.TypeUtil.SchemaVisitor.variant()	will be removed in 2.0.0; use TypeUtil.SchemaVisitor.variant(Types.VariantType) instead.
org.apache.iceberg.UpdateStatistics.setStatistics(long, StatisticsFile)	since 1.8.0, will be removed in 2.0.0, use UpdateStatistics.setStatistics(StatisticsFile).
org.apache.spark.sql.catalyst.parser.extensions.IcebergSqlExtensionsLexer.getTokenNames()
org.apache.spark.sql.catalyst.parser.extensions.IcebergSqlExtensionsParser.getTokenNames()

Deprecated Constructors

Constructor	Description
org.apache.iceberg.deletes.BaseDVFileWriter(Supplier<OutputFile>, Function<String, PositionDeleteIndex>)	since 1.12.0 and will be removed in 1.13.0
org.apache.iceberg.encryption.AesGcmInputFile(InputFile, byte[], byte[])	will be removed in 2.0.0 This API does not receive file length, and is therefore not safe
org.apache.iceberg.flink.IcebergTableSink(TableLoader, TableSchema, ReadableConfig, Map<String, String>)	since 1.10.0, will be removed in 2.0.0. Use IcebergTableSink(TableLoader, ResolvedSchema, ReadableConfig, Map) instead
org.apache.iceberg.orc.OrcValueReaders.StructReader(List<OrcValueReader<?>>, Types.StructType, Map<Integer, ?>)	Use StructReader(TypeDescription, List, Types.StructType, Map) instead. This constructor uses position-based binding which may cause field misalignment in MOR scenarios. This doesn't work lineage scenarios.