Package io.deephaven.enterprise.controller.pqstorage

Class PqStorageEtcdV2Impl

java.lang.Object

io.deephaven.enterprise.controller.pqstorage.PqStorageEtcdV2Impl

All Implemented Interfaces:

PqStorage

public class PqStorageEtcdV2Impl
extends Object
implements PqStorage

A V2 implementation of PQ storage in ETCD. This implementation stores PQ data under the prefix /main/data/persistent-query-v2/configuration/ and uses a global revision number to maintain synchronization.

Constructor Summary

Constructors

Constructor	Description
PqStorageEtcdV2Impl()

Method Summary

Modifier and Type	Method	Description
boolean	addPersistentQueryConfiguration(@NotNull PersistentQueryConfiguration config)	Add the specified persistent query configuration.
void	commitCheckPoint()	Commit a checkpoint.
boolean	deletePersistentQueryConfiguration(@NotNull PersistentQueryConfiguration config)	Delete the specified persistent query configuration.
void	disconnect(boolean forceCheckpoint)	Disconnect from the storage mechanism.
@Nullable PersistentQueryConfiguration	getPersistentQueryConfiguration(long serial)	Return the PersistentQueryConfiguration for the specified serial.
void	initialize()	Do any initialization work required.
Set<Long>	keySet()	Return the Set of persisted serials.
boolean	updatePersistentQueryConfiguration(@NotNull PersistentQueryConfiguration config)	Update the specified persistent query configuration.
Collection<PersistentQueryConfiguration>	values()	Return a Collection containing all the persisted PersistentQueryConfiguration instances.

Methods inherited from class java.lang.Object

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

Constructor Details

PqStorageEtcdV2Impl

public PqStorageEtcdV2Impl()
                    throws PqStorageException

Throws:

PqStorageException

Method Details

initialize

public void initialize()
                throws PqStorageException

Description copied from interface: PqStorage

Do any initialization work required.

Specified by:

initialize in interface PqStorage

Throws:

PqStorageException

getPersistentQueryConfiguration

@Nullable
public @Nullable PersistentQueryConfiguration getPersistentQueryConfiguration(long serial)
                                                                       throws PqStorageException

Description copied from interface: PqStorage

Return the PersistentQueryConfiguration for the specified serial.

Specified by:

getPersistentQueryConfiguration in interface PqStorage

Parameters:

serial - the serial for the query

Returns:

the query, or null if it does not exist

Throws:

PqStorageException

addPersistentQueryConfiguration

public boolean addPersistentQueryConfiguration(@NotNull
 @NotNull PersistentQueryConfiguration config)
                                        throws PqStorageException

Description copied from interface: PqStorage

Add the specified persistent query configuration. If the configuration already exists, it will not be updated.

Specified by:

addPersistentQueryConfiguration in interface PqStorage

Parameters:

config - the configuration to add

Returns:

true if the configuration was added, false if it already existed

Throws:

PqStorageException

updatePersistentQueryConfiguration

public boolean updatePersistentQueryConfiguration(@NotNull
 @NotNull PersistentQueryConfiguration config)
                                           throws PqStorageException

Description copied from interface: PqStorage

Update the specified persistent query configuration. If the configuration does not exist, it will not be created.

Specified by:

updatePersistentQueryConfiguration in interface PqStorage

Parameters:

config - the configuration to update

Returns:

true if the (existing) configuration was updated, false if it did not exist

Throws:

PqStorageException

deletePersistentQueryConfiguration

public boolean deletePersistentQueryConfiguration(@NotNull
 @NotNull PersistentQueryConfiguration config)
                                           throws PqStorageException

Description copied from interface: PqStorage

Delete the specified persistent query configuration.

Specified by:

deletePersistentQueryConfiguration in interface PqStorage

Parameters:

config - the configuration to update

Returns:

true if the configuration was deleted, false if it did not exist

Throws:

PqStorageException

commitCheckPoint

public void commitCheckPoint()

Description copied from interface: PqStorage

Commit a checkpoint. This may be a no-op.

Specified by:

commitCheckPoint in interface PqStorage

disconnect

public void disconnect(boolean forceCheckpoint)

Description copied from interface: PqStorage

Disconnect from the storage mechanism.

Specified by:

disconnect in interface PqStorage

Parameters:

forceCheckpoint - if true, perform a checkpoint

keySet

public Set<Long> keySet()
                 throws PqStorageException

Description copied from interface: PqStorage

Return the Set of persisted serials. There are no guarantees on the type, mutability, serializability, or thread-safety of the Set returned.

Specified by:

keySet in interface PqStorage

Returns:

a Set of the serials

Throws:

PqStorageException

values

public Collection<PersistentQueryConfiguration> values()
                                                throws PqStorageException

Description copied from interface: PqStorage

Return a Collection containing all the persisted PersistentQueryConfiguration instances. Updates to these PersistentQueryConfiguration instances should be persisted via PqStorage.updatePersistentQueryConfiguration(com.illumon.iris.controller.PersistentQueryConfiguration). There are no guarantees on the type, mutability, serializability, or thread-safety of the Collection returned, or of the objects contained within the Collection.

Specified by:

values in interface PqStorage

Returns:

a Collection of persistent query configurations

Throws:

PqStorageException