case class FileWriterOptions(path: Option[String], catalogName: Option[String], schemaName: Option[String], tableName: Option[String], saveMode: SaveMode = SaveMode.Append, partitionBy: Option[Seq[String]], format: String, alwaysUpdateSchemaInCatalog: Boolean, sort: Option[SortOptions], iceberg: Option[IcebergOutputOptions], metastoreUris: Option[String], warehousePath: Option[String], icebergCatalogType: Option[String], options: Map[String, String]) extends Product with Serializable
A case class that represents the configuration options for writing data to files.
- path
The optional base path for the files to be written.
- catalogName
The optional name of the catalog.
- schemaName
The optional name of the schema.
- tableName
The optional name of the table.
- saveMode
The SaveMode used for writing data to files (default is Append).
- partitionBy
The optional list of column names to partition the data by.
- format
The file format to be used for writing data (e.g., parquet, csv, etc.).
- alwaysUpdateSchemaInCatalog
A flag indicating whether to always update the schema in the catalog.
- sort
The optional configuration for sorting the data before writing.
- iceberg
The optional configuration options for writing data in Iceberg format.
- metastoreUris
The optional URI(s) for the Hive metastore.
- warehousePath
The optional base path for the warehouse storage.
- icebergCatalogType
The optional type of the Iceberg catalog.
- options
Additional options as key-value pairs to configure the writer.
- Alphabetic
- By Inheritance
- FileWriterOptions
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
FileWriterOptions(path: Option[String], catalogName: Option[String], schemaName: Option[String], tableName: Option[String], saveMode: SaveMode = SaveMode.Append, partitionBy: Option[Seq[String]], format: String, alwaysUpdateSchemaInCatalog: Boolean, sort: Option[SortOptions], iceberg: Option[IcebergOutputOptions], metastoreUris: Option[String], warehousePath: Option[String], icebergCatalogType: Option[String], options: Map[String, String])
- path
The optional base path for the files to be written.
- catalogName
The optional name of the catalog.
- schemaName
The optional name of the schema.
- tableName
The optional name of the table.
- saveMode
The SaveMode used for writing data to files (default is Append).
- partitionBy
The optional list of column names to partition the data by.
- format
The file format to be used for writing data (e.g., parquet, csv, etc.).
- alwaysUpdateSchemaInCatalog
A flag indicating whether to always update the schema in the catalog.
- sort
The optional configuration for sorting the data before writing.
- iceberg
The optional configuration options for writing data in Iceberg format.
- metastoreUris
The optional URI(s) for the Hive metastore.
- warehousePath
The optional base path for the warehouse storage.
- icebergCatalogType
The optional type of the Iceberg catalog.
- options
Additional options as key-value pairs to configure the writer.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val alwaysUpdateSchemaInCatalog: Boolean
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val catalogName: Option[String]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- val format: String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getTableName: String
Returns the fully qualified name of the table in the format 'catalogName.schemaName.tableName'.
Returns the fully qualified name of the table in the format 'catalogName.schemaName.tableName'.
- returns
The fully qualified name of the table.
-
def
getTablePath: String
Returns the full path to the table's location in the warehouse.
Returns the full path to the table's location in the warehouse.
- returns
The full path to the table's location in the warehouse.
- val iceberg: Option[IcebergOutputOptions]
- val icebergCatalogType: Option[String]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val metastoreUris: Option[String]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val options: Map[String, String]
- val partitionBy: Option[Seq[String]]
- val path: Option[String]
- val saveMode: SaveMode
- val schemaName: Option[String]
- val sort: Option[SortOptions]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val tableName: Option[String]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val warehousePath: Option[String]