Package io.deephaven.enterprise.iceberg.discovery

Interface DiscoveryResult

All Known Implementing Classes:

DiscoveryResultImpl

public interface DiscoveryResult

The result of an Iceberg table discovery.

Method Summary

Modifier and Type	Method	Description
default void	deployWithEmbeddedEndpoint()	Deploy the discovered table as a Deephaven Schema, embedding the endpoint directly into the schema.
default void	deployWithEndpointReference()	Deploy the discovered table as a Deephaven Schema, referencing the endpoint by name.
@NotNull DiscoveryConfig	getConfig()	Get the DiscoveryConfig used for the discovery.
DataInstructionsProviderLoader	getDataInstructionsProvider()	Get the DataInstructionsProviderLoader for use with Iceberg locations.
@NotNull IcebergTableAdapter	getIcebergTableAdapter()	Get the discovered IcebergTableAdapter.
@NotNull String	getNamespace()	Get the namespace of the table.
@NotNull IcebergReadInstructions	getReadInstructions()	Get the completed IcebergReadInstructions that can be used to fetch Deephaven Tables.
org.apache.iceberg.catalog.TableIdentifier	getTableIdentifier()	Get the TableIdentifier used to discover the table.
@NotNull String	getTableName()	Get the name of the table.

Method Details

getConfig

@NotNull
@NotNull DiscoveryConfig getConfig()

Get the DiscoveryConfig used for the discovery.

Returns:

the configuration.

getNamespace

@NotNull
@NotNull String getNamespace()

Get the namespace of the table. If DiscoveryConfig.namespace() was not provided, then it is derived from the Iceberg Table Identifier

Returns:

the namespace of the table.

getTableName

@NotNull
@NotNull String getTableName()

Get the name of the table. If DiscoveryConfig.tableName() was not provided, then it is derived from the Iceberg Table Identifier.

Returns:

the table name.

getIcebergTableAdapter

@NotNull
@NotNull IcebergTableAdapter getIcebergTableAdapter()

Get the discovered IcebergTableAdapter.

Returns:

the Iceberg IcebergTableAdapter

getReadInstructions

@NotNull
@NotNull IcebergReadInstructions getReadInstructions()

Get the completed IcebergReadInstructions that can be used to fetch Deephaven Tables.

Returns:

the IcebergReadInstructions

getDataInstructionsProvider

DataInstructionsProviderLoader getDataInstructionsProvider()

Get the DataInstructionsProviderLoader for use with Iceberg locations.

Returns:

the DataInstructionsProviderLoader

getTableIdentifier

org.apache.iceberg.catalog.TableIdentifier getTableIdentifier()

Get the TableIdentifier used to discover the table.

Returns:

the TableIdentifier

deployWithEndpointReference

@FinalDefault
default void deployWithEndpointReference()
                                  throws IOException

Deploy the discovered table as a Deephaven Schema, referencing the endpoint by name. This will fail if the endpoint was not created with a IcebergEndpoint.Named.

Throws:

IOException - if the endpoint could not be desrialized

deployWithEmbeddedEndpoint

@FinalDefault
default void deployWithEmbeddedEndpoint()
                                 throws IOException

Deploy the discovered table as a Deephaven Schema, embedding the endpoint directly into the schema.

Throws:

IOException - if the endpoint could not be serialized.