Package io.deephaven.enterprise.iceberg

Class IcebergTools

java.lang.Object

io.deephaven.enterprise.iceberg.IcebergTools

public final class IcebergTools
extends Object

Common utilities for loading Iceberg tables as Deephaven Tables

Method Summary

Modifier and Type	Method	Description
static void	deployEndpoint(IcebergEndpoint.Named endpoint, boolean overwriteExisting)	Deploy the discovered endpoint to Deephaven's configuration service.
static void	deploySchemaWithEmbeddedEndpoint(@NotNull DiscoveryResult discovery)	Deploy the discovered schema to deephaven, embedding the endpoint directly in the schema
static void	deploySchemaWithEndpointReference(@NotNull DiscoveryResult discovery)	Deploy the discovered schema to deephaven, referencing the endpoint by name.
static @NotNull DiscoveryResult	discover(@NotNull DiscoveryConfig config)	Discover a table from iceberg.
static IcebergEndpoint.Named	getEndpointByName(@NotNull String endpointName)	Get the IcebergEndpoint from Deephaven configuration by name.
static IcebergEndpoint.Builder	newEndpoint()	Get a new IcebergEndpoint.Builder to create an IcebergEndpoint for use with discovery.

Methods inherited from class java.lang.Object

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

Method Details

discover

@NotNull
public static @NotNull DiscoveryResult discover(@NotNull
 @NotNull DiscoveryConfig config)

Discover a table from iceberg.

Parameters:

config - the configuration to use for discovery.

Returns:

a DiscoveryResult containing the resolved Table information.

deployEndpoint

public static void deployEndpoint(@NotNull
 IcebergEndpoint.Named endpoint,
 boolean overwriteExisting)

Deploy the discovered endpoint to Deephaven's configuration service. The endpoint will be stored in the Configuration service as a JSON file named `endpoint_name.json`. Once deployed, the endpoint can be referenced by the Schema's Iceberg extended storage element. See deploySchemaWithEndpointReference(DiscoveryResult).

Parameters:

endpoint - The named endpoint to deploy.

overwriteExisting - if true, any existing endpoint will be overwritten.

deploySchemaWithEndpointReference

public static void deploySchemaWithEndpointReference(@NotNull
 @NotNull DiscoveryResult discovery)
                                              throws IOException

Deploy the discovered schema to deephaven, referencing the endpoint by name. This method requires that the IcebergEndpoint configured wth DiscoveryConfig.endpoint() was named, either during construction, or explicitly.

Parameters:

discovery - the result of a discover(DiscoveryConfig).

Throws:

IOException - if the IcebergEndpoint could not be serialized.

deploySchemaWithEmbeddedEndpoint

public static void deploySchemaWithEmbeddedEndpoint(@NotNull
 @NotNull DiscoveryResult discovery)
                                             throws IOException

Deploy the discovered schema to deephaven, embedding the endpoint directly in the schema

Parameters:

discovery - the result of a discover(DiscoveryConfig).

Throws:

IOException - if the IcebergEndpoint could not be deserialized.

getEndpointByName

@NotNull
public static IcebergEndpoint.Named getEndpointByName(@NotNull
 @NotNull String endpointName)
                                               throws IOException

Get the IcebergEndpoint from Deephaven configuration by name.

Parameters:

endpointName - the name of the endpoint

Returns:

the endpoint.

Throws:

IOException - if the endpoint could not be deserialized, or the configuration service could not be reached.

newEndpoint

@NotNull
public static IcebergEndpoint.Builder newEndpoint()

Get a new IcebergEndpoint.Builder to create an IcebergEndpoint for use with discovery.

Returns:

a new IcebergEndpoint.Builder