IcebergReadInstructions
The IcebergReadInstructions class specifies the instructions for reading Iceberg tables into Deephaven. These include special instructions for loading files from cloud storage, the update mode, and the snapshot to read.
Note
The table_definition and column_renames parameters are deprecated and have no effect. Passing either one only raises a DeprecationWarning. To choose columns, set their types, or map Deephaven column names to Iceberg fields, pass an UnboundResolver to IcebergCatalogAdapter.load_table instead.
Syntax
Parameters
| Parameter | Type | Description |
|---|---|---|
| table_definition | Union[Dict[str, DType], List[Column]] | Deprecated. This parameter has no effect. |
| data_instructions | S3Instructions | Special instructions for reading data files from a non-local file system, such as S3. If not given, the data instructions are derived from the catalog. |
| column_renames | Dict[str, str] | Deprecated. This parameter has no effect. |
| update_mode | IcebergUpdateMode | The update mode for the table. Options include:
|
| snapshot_id | int | The snapshot ID to read. If not given, the most recent snapshot ID is used. |
| ignore_resolving_errors | bool | Whether to ignore unexpected errors when resolving columns. If |
Methods
None.
Constructors
An IcebergReadInstructions is constructed directly from the class.
Examples
The following example creates four IcebergReadInstructions objects. The first is for static Iceberg tables, the second is for Iceberg tables that can be manually refreshed, and the third and fourth are for Iceberg tables that will be refreshed automatically. The third uses the default value of 60 seconds, whereas the fourth sets the interval to 30 seconds.
The following example creates an IcebergReadInstructions object that tells a catalog adapter about the region, access information, and endpoint for reading Iceberg tables from S3 cloud storage: