Package io.deephaven.enterprise.iceberg

Class IcebergTableAccess

java.lang.Object

io.deephaven.enterprise.database.DatabaseTableAccessAclBase<IcebergTableAccess.Options,IcebergTable,Table>

io.deephaven.enterprise.iceberg.IcebergTableAccess

All Implemented Interfaces:

Database.DatabaseTableAccess<IcebergTableAccess.Options>, TableAccess<IcebergTableAccess.Options>

public final class IcebergTableAccess
extends DatabaseTableAccessAclBase<IcebergTableAccess.Options,IcebergTable,Table>

Iceberg table access, allows for more explicit Iceberg options than Database natively has.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IcebergTableAccess.IcebergResults	More advanced results, useful for IcebergUpdateMode.IcebergUpdateType.MANUAL_REFRESHING.
static interface	IcebergTableAccess.Options	The Iceberg specific table access options.

Nested classes/interfaces inherited from class io.deephaven.enterprise.database.DatabaseTableAccessAclBase

DatabaseTableAccessAclBase.AclAndAuditSupport, DatabaseTableAccessAclBase.IntermediateResults<Options,Pre extends Table>, DatabaseTableAccessAclBase.PreAndPostTable<Pre extends Table,Post extends Table>

Method Summary

Modifier and Type	Method	Description
protected String	event(IcebergTableAccess.Options options)	Extract the audit event access string from the type-specific options.
static Database.TableAccessFactory<IcebergTableAccess>	factory()	The Iceberg table access factory.
boolean	isRefreshing(@NotNull IcebergTableAccess.Options options)	Extract if the table should be refreshing from the type-specific options.
IcebergTableAccess.IcebergResults	manuallyRefreshingTable(String namespace, String tableName, IcebergReadInstructions readInstructions)	Fetches an Iceberg table results with manual refreshing support.
protected String	namespace(@NotNull IcebergTableAccess.Options options)	Extract the namespace from the type-specific options.
static IcebergTableAccess	of(Database db)	Create a new instance of the Iceberg table access.
protected Table	postAclTableApply(DatabaseTableAccessAclBase.IntermediateResults<IcebergTableAccess.Options,IcebergTable> intermediate)	Provides a hook for implementations to apply a post-ACL table filter or transformation.
Table	table(String namespace, String tableName, IcebergReadInstructions readInstructions)	Fetches an Iceberg table.
protected IcebergTable	tableImpl(@NotNull IcebergTableAccess.Options options)	The entrypoint for implementations to fetch an intermediate Table, which will subsequently have ACLs applied be being exposed to the user.
protected String	tableName(@NotNull IcebergTableAccess.Options options)	Extract the table name from the type-specific options.

Methods inherited from class io.deephaven.enterprise.database.DatabaseTableAccessAclBase

preAndPostTable, schemaFor, table

Methods inherited from class java.lang.Object

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

Method Details

factory

public static Database.TableAccessFactory<IcebergTableAccess> factory()

The Iceberg table access factory.

Returns:

the Iceberg table access factory

of

public static IcebergTableAccess of(Database db)

Create a new instance of the Iceberg table access. Equivalent to db.as(factory()).

Parameters:

db - the db

Returns:

the Iceberg table access

See Also:

• Database.as(TableAccessFactory)
• factory()

table

public Table table(String namespace,
 String tableName,
 IcebergReadInstructions readInstructions)

Fetches an Iceberg table. A helper for #table(Options) that loads the IcebergTableOptions from the namespace and tableName's Schema.

Parameters:

namespace - the namespace

tableName - the table name

readInstructions - the read instructions

Returns:

the table

manuallyRefreshingTable

public IcebergTableAccess.IcebergResults manuallyRefreshingTable(String namespace,
 String tableName,
 IcebergReadInstructions readInstructions)

Fetches an Iceberg table results with manual refreshing support. Loads the IcebergTableOptions from the namespace and tableName's Schema.

Parameters:

namespace - the namespace

tableName - the table name

readInstructions - the read instructions

Returns:

the Iceberg results

tableImpl

protected IcebergTable tableImpl(@NotNull
 @NotNull IcebergTableAccess.Options options)

Description copied from class: DatabaseTableAccessAclBase

The entrypoint for implementations to fetch an intermediate Table, which will subsequently have ACLs applied be being exposed to the user. Called from DatabaseTableAccessAclBase.table(Object).

Specified by:

tableImpl in class DatabaseTableAccessAclBase<IcebergTableAccess.Options,IcebergTable,Table>

Parameters:

options - the options

Returns:

the base table

postAclTableApply

protected Table postAclTableApply(DatabaseTableAccessAclBase.IntermediateResults<IcebergTableAccess.Options,IcebergTable> intermediate)

Description copied from class: DatabaseTableAccessAclBase

Provides a hook for implementations to apply a post-ACL table filter or transformation. The default implementations should return DatabaseTableAccessAclBase.IntermediateResults.aclOrPre(). Called from DatabaseTableAccessAclBase.table(Object).

Specified by:

postAclTableApply in class DatabaseTableAccessAclBase<IcebergTableAccess.Options,IcebergTable,Table>

Parameters:

intermediate - the intermediate results

Returns:

the table

namespace

protected String namespace(@NotNull
 @NotNull IcebergTableAccess.Options options)

Description copied from class: DatabaseTableAccessAclBase

Extract the namespace from the type-specific options.

Specified by:

namespace in class DatabaseTableAccessAclBase<IcebergTableAccess.Options,IcebergTable,Table>

Parameters:

options - the options

Returns:

the namespace

tableName

protected String tableName(@NotNull
 @NotNull IcebergTableAccess.Options options)

Description copied from class: DatabaseTableAccessAclBase

Extract the table name from the type-specific options.

Specified by:

tableName in class DatabaseTableAccessAclBase<IcebergTableAccess.Options,IcebergTable,Table>

Parameters:

options - the options

Returns:

the table name

event

protected String event(@NotNull
 IcebergTableAccess.Options options)

Description copied from class: DatabaseTableAccessAclBase

Extract the audit event access string from the type-specific options.

Specified by:

event in class DatabaseTableAccessAclBase<IcebergTableAccess.Options,IcebergTable,Table>

Parameters:

options - the options

Returns:

the audit event access string

isRefreshing

public boolean isRefreshing(@NotNull
 @NotNull IcebergTableAccess.Options options)

Description copied from class: DatabaseTableAccessAclBase

Extract if the table should be refreshing from the type-specific options.

Specified by:

isRefreshing in interface Database.DatabaseTableAccess<IcebergTableAccess.Options>

Specified by:

isRefreshing in class DatabaseTableAccessAclBase<IcebergTableAccess.Options,IcebergTable,Table>

Parameters:

options - the options

Returns:

if the table should be refreshing