@@ -115,10 +115,20 @@ pub trait SchemaMapper: Debug + Send + Sync {
115115
116116/// Deprecated: Default [`SchemaAdapterFactory`] for mapping schemas.
117117///
118- /// This struct has been removed. Use [`PhysicalExprAdapterFactory`] instead.
118+ /// This struct has been removed.
119+ ///
120+ /// Use [`PhysicalExprAdapterFactory`] instead to customize scans via
121+ /// [`FileScanConfigBuilder`], i.e. if you had implemented a custom [`SchemaAdapter`]
122+ /// and passed that into [`FileScanConfigBuilder`] / [`ParquetSource`].
123+ /// Use [`BatchAdapter`] if you want to map a stream of [`RecordBatch`]es
124+ /// between one schema and another, i.e. if you were calling [`SchemaMapper::map_batch`] manually.
125+ ///
119126/// See `upgrading.md` for more details.
120127///
121128/// [`PhysicalExprAdapterFactory`]: datafusion_physical_expr_adapter::PhysicalExprAdapterFactory
129+ /// [`FileScanConfigBuilder`]: crate::file_scan_config::FileScanConfigBuilder
130+ /// [`ParquetSource`]: https://docs.rs/datafusion-datasource-parquet/latest/datafusion_datasource_parquet/source/struct.ParquetSource.html
131+ /// [`BatchAdapter`]: datafusion_physical_expr_adapter::BatchAdapter
122132#[ deprecated(
123133 since = "52.0.0" ,
124134 note = "DefaultSchemaAdapterFactory has been removed. Use PhysicalExprAdapterFactory instead. See upgrading.md for more details."
@@ -178,10 +188,20 @@ impl SchemaAdapter for DeprecatedSchemaAdapter {
178188
179189/// Deprecated: The SchemaMapping struct held a mapping from the file schema to the table schema.
180190///
181- /// This struct has been removed. Use [`PhysicalExprAdapterFactory`] instead.
191+ /// This struct has been removed.
192+ ///
193+ /// Use [`PhysicalExprAdapterFactory`] instead to customize scans via
194+ /// [`FileScanConfigBuilder`], i.e. if you had implemented a custom [`SchemaAdapter`]
195+ /// and passed that into [`FileScanConfigBuilder`] / [`ParquetSource`].
196+ /// Use [`BatchAdapter`] if you want to map a stream of [`RecordBatch`]es
197+ /// between one schema and another, i.e. if you were calling [`SchemaMapper::map_batch`] manually.
198+ ///
182199/// See `upgrading.md` for more details.
183200///
184201/// [`PhysicalExprAdapterFactory`]: datafusion_physical_expr_adapter::PhysicalExprAdapterFactory
202+ /// [`FileScanConfigBuilder`]: crate::file_scan_config::FileScanConfigBuilder
203+ /// [`ParquetSource`]: https://docs.rs/datafusion-datasource-parquet/latest/datafusion_datasource_parquet/source/struct.ParquetSource.html
204+ /// [`BatchAdapter`]: datafusion_physical_expr_adapter::BatchAdapter
185205#[ deprecated(
186206 since = "52.0.0" ,
187207 note = "SchemaMapping has been removed. Use PhysicalExprAdapterFactory instead. See upgrading.md for more details."
0 commit comments