Package io.deephaven.iceberg.util

Class IcebergToolsS3

java.lang.Object

io.deephaven.iceberg.util.IcebergTools

io.deephaven.iceberg.util.IcebergToolsS3

public class IcebergToolsS3
extends IcebergTools

Tools for accessing tables in the Iceberg table format.

Constructor Summary

Constructors

Constructor	Description
IcebergToolsS3()

Method Summary

Modifier and Type	Method	Description
static IcebergCatalogAdapter	createGlue(@Nullable String name, @NotNull String catalogURI, @NotNull String warehouseLocation)	Create an Iceberg catalog adapter for an AWS Glue catalog.
static IcebergCatalogAdapter	createS3Rest(@Nullable String name, @NotNull String catalogURI, @NotNull String warehouseLocation, @Nullable String region, @Nullable String accessKeyId, @Nullable String secretAccessKey, @Nullable String endpointOverride)	Create an Iceberg catalog adapter for a REST catalog backed by S3 storage.

Methods inherited from class io.deephaven.iceberg.util.IcebergTools

createAdapter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IcebergToolsS3

public IcebergToolsS3()

Method Details

createS3Rest

public static IcebergCatalogAdapter createS3Rest(@Nullable
 @Nullable String name,
 @NotNull
 @NotNull String catalogURI,
 @NotNull
 @NotNull String warehouseLocation,
 @Nullable
 @Nullable String region,
 @Nullable
 @Nullable String accessKeyId,
 @Nullable
 @Nullable String secretAccessKey,
 @Nullable
 @Nullable String endpointOverride)

Create an Iceberg catalog adapter for a REST catalog backed by S3 storage. If null is provided for a value, the system defaults will be used.

Parameters:

name - the name of the catalog; if omitted, the catalog URI will be used to generate a name

catalogURI - the URI of the Iceberg REST catalog

warehouseLocation - the location of the S3 datafiles backing the catalog

region - the AWS region; if omitted, system defaults will be used

accessKeyId - the AWS access key ID; if omitted, system defaults will be used

secretAccessKey - the AWS secret access key; if omitted, system defaults will be used

endpointOverride - the S3 endpoint override; this is useful for testing with a S3-compatible local service such as MinIO or LocalStack

Returns:

the Iceberg catalog adapter

createGlue

public static IcebergCatalogAdapter createGlue(@Nullable
 @Nullable String name,
 @NotNull
 @NotNull String catalogURI,
 @NotNull
 @NotNull String warehouseLocation)

Create an Iceberg catalog adapter for an AWS Glue catalog. System defaults will be used to populate the region and credentials. These can be configured by following AWS Authentication and access credentials guide.

Parameters:

name - the name of the catalog; if omitted, the catalog URI will be used to generate a name

catalogURI - the URI of the AWS Glue catalog

warehouseLocation - the location of the S3 datafiles backing the catalog

Returns:

the Iceberg catalog adapter