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 IcebergTableOptions	createForMerge(@NotNull String namespace, @NotNull String tableName, @NotNull BuildCatalogOptions catalogOptions, @NotNull org.apache.iceberg.catalog.TableIdentifier tableIdentifier, @NotNull TableDefinition tableDefinition)	Helper method to create a new Iceberg table in this catalog with the given tableIdentifier and tableDefinition intended for subsequent writes using a Deephaven merge job.
static void	deployEndpoint(IcebergEndpoint.Named endpoint, boolean overwriteExisting)	Deprecated.
static void	deploySchemaWithEmbeddedEndpoint(@NotNull DiscoveryResult discovery)	Deprecated.
static void	deploySchemaWithEndpointReference(@NotNull DiscoveryResult discovery)	Deprecated.
static @NotNull DiscoveryResult	discover(@NotNull DiscoveryConfig config)	Deprecated.
static IcebergEndpoint.Named	getEndpointByName(@NotNull String endpointName)	Deprecated.
static IcebergEndpoint.Builder	newEndpoint()	Deprecated.

Methods inherited from class java.lang.Object

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

Method Details

discover

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

Deprecated.

Discover a table from iceberg.

Parameters:

config - the configuration to use for discovery.

Returns:

a DiscoveryResult containing the resolved Table information.

deployEndpoint

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

Deprecated.

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

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

Deprecated.

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

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

Deprecated.

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

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

Deprecated.

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

@Deprecated
@NotNull
public static IcebergEndpoint.Builder newEndpoint()

Deprecated.

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

Returns:

a new IcebergEndpoint.Builder

createForMerge

public static IcebergTableOptions createForMerge(@NotNull
 @NotNull String namespace,
 @NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull BuildCatalogOptions catalogOptions,
 @NotNull
 @NotNull org.apache.iceberg.catalog.TableIdentifier tableIdentifier,
 @NotNull
 @NotNull TableDefinition tableDefinition)

Helper method to create a new Iceberg table in this catalog with the given tableIdentifier and tableDefinition intended for subsequent writes using a Deephaven merge job. It returns an IcebergTableOptions instance that can be used to IcebergTableOptions.deploy() the schema.

Note that this method will create a new Iceberg namespace if the namespace from the tableIdentifier does not already exist.

Parameters:

namespace - The namespace to use for the new Deephaven table.

tableName - The name of the new Deephaven table.

catalogOptions - The options to use for connecting to the Iceberg catalog.

tableIdentifier - The identifier of the new Iceberg table.

tableDefinition - The definition of the new Deephaven table, which will be converted to an Iceberg schema and spec.

Returns:

an IcebergTableOptions instance representing the created table.

Throws:

org.apache.iceberg.exceptions.AlreadyExistsException - if the Iceberg table already exists

See Also:

• IcebergCatalogAdapter.createTable(String, TableDefinition)
• IcebergTableOptions.deploy()