Package io.deephaven.enterprise.iceberg

Class IcebergTableOptions

java.lang.Object

io.deephaven.enterprise.iceberg.IcebergTableOptions

@Immutable
public abstract class IcebergTableOptions
extends Object

The options to create a Table from Iceberg.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IcebergTableOptions.Builder	A builder for IcebergTableOptions.

Constructor Summary

Constructors

Constructor	Description
IcebergTableOptions()

Method Summary

Modifier and Type	Method	Description
boolean	allowMergeFromDeephaven()	Whether Deephaven merge jobs may write to the underlying Iceberg table.
static IcebergTableOptions.Builder	builder()	Constructs a new IcebergTableOptions.Builder.
abstract BuildCatalogOptions	catalogOptions()
final IcebergCatalogAdapter	createAdapter()	Load the IcebergCatalogAdapter.
final Optional<TableDefinition>	definition()	The TableDefinition.
final Schema	deploy()	Deploy the schema() to the default schema service.
final Schema	deploy(SchemaService schemaService)	Deploy the schema() to the schemaService.
final boolean	hasDefinition()	Returns true if tableOptions() has a TableDefinition.
static IcebergTableOptions	load(Schema schema)	Loads the options from the schema.
static IcebergTableOptions	load(Schema schema, boolean intraday)	Deprecated. use load(Schema)
static IcebergTableOptions	load(String namespace, String tableName)	Loads the options from the default schema service with a TableType.SYSTEM_PERMANENT table key.
final IcebergTableAdapter	loadTable()	Load the IcebergTableAdapter.
final IcebergTableOptions	materialize()	If hasDefinition() is true, will return this; otherwise, a new IcebergTableOptions with a definition will be inferred.
abstract String	namespace()	The namespace.
final Optional<Schema>	schema()	Constructs a new SYSTEM Schema if hasDefinition() is true, and empty otherwise.
static boolean	supports(Schema schema)	If the schema supports IcebergTableOptions.
final Table	table()	Load a static-mode Table.
final IcebergTable	table(IcebergReadInstructions readInstructions)	Load the Table with the given readInstructions.
final EnterpriseTableKey	tableKey()	Deprecated. prefer namespace() and tableName()
abstract String	tableName()	The table name.
abstract LoadTableOptions	tableOptions()

Methods inherited from class java.lang.Object

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

Constructor Details

IcebergTableOptions

public IcebergTableOptions()

Method Details

builder

public static IcebergTableOptions.Builder builder()

Constructs a new IcebergTableOptions.Builder.

Returns:

the builder

load

public static IcebergTableOptions load(String namespace,
 String tableName)

Loads the options from the default schema service with a TableType.SYSTEM_PERMANENT table key. The Schema must have a extended storage type of "iceberg" and have the namespace set NamespaceSet.SYSTEM.

Parameters:

namespace - the namespace

tableName - the tableName

Returns:

the options

See Also:

• load(Schema)

load

@Deprecated
public static IcebergTableOptions load(Schema schema,
 boolean intraday)

Deprecated.

use load(Schema)

Loads the options from the schema. The Schema must have an extended storage type of "iceberg" and have the namespace set SYSTEM.

Parameters:

schema - the schema

intraday - unused

Returns:

the options

supports

public static boolean supports(Schema schema)

If the schema supports IcebergTableOptions.

Parameters:

schema - the schema

Returns:

true if schema supports IcebergTableOptions.

load

public static IcebergTableOptions load(Schema schema)

Loads the options from the schema. The Schema must have an extended storage type of "iceberg" and have the namespace set SYSTEM.

Parameters:

schema - the schema

Returns:

the options

tableKey

@Deprecated
public final EnterpriseTableKey tableKey()

Deprecated.

prefer namespace() and tableName()

The table key, always of the type TableType.SYSTEM_PERMANENT. Equivalent to new EnterpriseTableKeyImpl(namespace(), tableName(), TableType.SYSTEM_PERMANENT).

Returns:

the table key

namespace

public abstract String namespace()

The namespace.

Returns:

the namespace

tableName

public abstract String tableName()

The table name.

Returns:

the table name

catalogOptions

@InternalUseOnly
public abstract BuildCatalogOptions catalogOptions()

tableOptions

@InternalUseOnly
public abstract LoadTableOptions tableOptions()

allowMergeFromDeephaven

@InternalUseOnly
@Default
public boolean allowMergeFromDeephaven()

Whether Deephaven merge jobs may write to the underlying Iceberg table. Disabled by default.

hasDefinition

public final boolean hasDefinition()

Returns true if tableOptions() has a TableDefinition.

Returns:

if this has a definition

definition

public final Optional<TableDefinition> definition()

The TableDefinition. Will return a value when hasDefinition() is true, and empty otherwise.

Returns:

the definition

schema

public final Optional<Schema> schema()

Constructs a new SYSTEM Schema if hasDefinition() is true, and empty otherwise. The Schema will have an extended storage type of "iceberg". This does not deploy the Schema to the SchemaService.

Returns:

the schema

materialize

public final IcebergTableOptions materialize()

If hasDefinition() is true, will return this; otherwise, a new IcebergTableOptions with a definition will be inferred. This is useful to ensure that calling schema() on the returned value will have a result.

When inferred, the resulting options will have the explicit IcebergTableAdapter.resolver() and functionally-equivalent IcebergTableAdapter.nameMapping() from loadTable() of this.

Returns:

options that has a definition

createAdapter

public final IcebergCatalogAdapter createAdapter()

Load the IcebergCatalogAdapter.

Returns:

the Iceberg catalog adapter

loadTable

public final IcebergTableAdapter loadTable()

Load the IcebergTableAdapter.

Returns:

the Iceberg table adapter

table

public final Table table()

Load a static-mode Table. Equivalent to table(IcebergReadInstructions.builder().updateMode(IcebergUpdateMode.staticMode()).build()).

Returns:

the table

See Also:

• table(IcebergReadInstructions)

table

public final IcebergTable table(IcebergReadInstructions readInstructions)

Load the Table with the given readInstructions.

Parameters:

readInstructions - the read instructions

Returns:

the table

deploy

public final Schema deploy()

Deploy the schema() to the default schema service. If the namespace does not exist, it will be created. If the Schema does not exist, it will be added; otherwise, it will be updated.

Delegates to deploy(SchemaService) using SchemaServiceFactory.getDefault().

Returns:

the deployed Schema

Throws:

IllegalArgumentException - if hasDefinition() is false

See Also:

• deploy(SchemaService)

deploy

public final Schema deploy(SchemaService schemaService)

Deploy the schema() to the schemaService. If the namespace does not exist, it will be created. If the Schema does not exist, it will be added; otherwise, it will be updated.

Parameters:

schemaService - the schema service

Returns:

the deployed Schema

Throws:

IllegalArgumentException - if hasDefinition() is false