com.logicalclocks.hsfs

Class FeatureStoreBase<T2 extends QueryBase>

java.lang.Object

com.logicalclocks.hsfs.FeatureStoreBase<T2>

Direct Known Subclasses:

FeatureStore, FeatureStore

public abstract class FeatureStoreBase<T2 extends QueryBase>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static Integer	DEFAULT_VERSION
protected FeatureGroupApi	featureGroupApi
protected static org.slf4j.Logger	LOGGER
protected StorageConnectorApi	storageConnectorApi
protected TrainingDatasetApi	trainingDatasetApi

Constructor Summary

Constructors

Constructor and Description
FeatureStoreBase()

Method Summary

Modifier and Type	Method and Description
abstract Object	createExternalFeatureGroup()
abstract Object	createFeatureGroup()
abstract Object	createFeatureView()
abstract Object	createStreamFeatureGroup()
abstract Object	getAdlsConnector(String name)
abstract Object	getBigqueryConnector(String name)
abstract Object	getExternalFeatureGroup(String name) Get a external feature group object with default version `1` from the feature store.
abstract Object	getExternalFeatureGroup(@NonNull String name, @NonNull Integer version) Get a external feature group object from the feature store.
abstract Object	getExternalFeatureGroups(@NonNull String name)
abstract Object	getFeatureGroups(@NonNull String name)
abstract Object	getFeatureView(String name)
abstract Object	getFeatureView(@NonNull String name, @NonNull Integer version)
abstract Object	getGcsConnector(String name)
abstract Object	getHopsFsConnector(String name)
abstract Object	getJdbcConnector(String name)
abstract Object	getKafkaConnector(String name)
abstract Object	getOnlineStorageConnector()
abstract Object	getOrCreateFeatureGroup(String name, Integer version)
abstract Object	getOrCreateFeatureGroup(String name, Integer version, List<String> primaryKeys, boolean onlineEnabled, String eventTime)
abstract Object	getOrCreateFeatureGroup(String name, Integer version, List<String> primaryKeys, List<String> partitionKeys, boolean onlineEnabled, String eventTime)
abstract Object	getOrCreateFeatureGroup(String name, Integer version, String description, List<String> primaryKeys, List<String> partitionKeys, String hudiPrecombineKey, boolean onlineEnabled, TimeTravelFormat timeTravelFormat, StatisticsConfig statisticsConfig, String eventTime)
abstract Object	getOrCreateFeatureView(String name, T2 query, Integer version)
abstract Object	getOrCreateFeatureView(String name, T2 query, Integer version, String description, List<String> labels)
abstract Object	getOrCreateStreamFeatureGroup(String name, Integer version)
abstract Object	getOrCreateStreamFeatureGroup(String name, Integer version, List<String> primaryKeys, boolean onlineEnabled, String eventTime)
abstract Object	getOrCreateStreamFeatureGroup(String name, Integer version, List<String> primaryKeys, List<String> partitionKeys, boolean onlineEnabled, String eventTime)
abstract Object	getOrCreateStreamFeatureGroup(String name, Integer version, String description, List<String> primaryKeys, List<String> partitionKeys, String hudiPrecombineKey, boolean onlineEnabled, StatisticsConfig statisticsConfig, String eventTime)
abstract Object	getRedshiftConnector(String name)
abstract Object	getS3Connector(String name)
abstract Object	getSnowflakeConnector(String name)
abstract StorageConnector	getStorageConnector(String name) Get a list of all versions of an external feature group from the feature store.
abstract Object	getStreamFeatureGroup(String name) Get a feature group object with default version `1` from the feature store.
abstract Object	getStreamFeatureGroup(@NonNull String name, @NonNull Integer version) Get a feature group object from the feature store.
abstract TrainingDatasetBase	getTrainingDataset(String name) Get a training dataset object with the default version `1` from the selected feature store.
abstract TrainingDatasetBase	getTrainingDataset(@NonNull String name, @NonNull Integer version) Get a training dataset object from the selected feature store.
abstract Object	getTrainingDatasets(@NonNull String name) Get all versions of a training dataset object from the selected feature store.
abstract Object	sql(String query)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

featureGroupApi

protected FeatureGroupApi featureGroupApi

trainingDatasetApi

protected TrainingDatasetApi trainingDatasetApi

storageConnectorApi

protected StorageConnectorApi storageConnectorApi

LOGGER

protected static final org.slf4j.Logger LOGGER

DEFAULT_VERSION

protected static final Integer DEFAULT_VERSION

Constructor Detail

FeatureStoreBase

public FeatureStoreBase()

Method Detail

createFeatureGroup

public abstract Object createFeatureGroup()

getFeatureGroups

public abstract Object getFeatureGroups(@NonNull
                                        @NonNull String name)
                                 throws FeatureStoreException,
                                        IOException

Throws:

FeatureStoreException

IOException

getOrCreateFeatureGroup

public abstract Object getOrCreateFeatureGroup(String name,
                                               Integer version)
                                        throws IOException,
                                               FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateFeatureGroup

public abstract Object getOrCreateFeatureGroup(String name,
                                               Integer version,
                                               List<String> primaryKeys,
                                               List<String> partitionKeys,
                                               boolean onlineEnabled,
                                               String eventTime)
                                        throws IOException,
                                               FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateFeatureGroup

public abstract Object getOrCreateFeatureGroup(String name,
                                               Integer version,
                                               List<String> primaryKeys,
                                               boolean onlineEnabled,
                                               String eventTime)
                                        throws IOException,
                                               FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateFeatureGroup

public abstract Object getOrCreateFeatureGroup(String name,
                                               Integer version,
                                               String description,
                                               List<String> primaryKeys,
                                               List<String> partitionKeys,
                                               String hudiPrecombineKey,
                                               boolean onlineEnabled,
                                               TimeTravelFormat timeTravelFormat,
                                               StatisticsConfig statisticsConfig,
                                               String eventTime)
                                        throws IOException,
                                               FeatureStoreException

Throws:

IOException

FeatureStoreException

getStreamFeatureGroup

public abstract Object getStreamFeatureGroup(@NonNull
                                             @NonNull String name,
                                             @NonNull
                                             @NonNull Integer version)
                                      throws FeatureStoreException,
                                             IOException

Get a feature group object from the feature store.

Parameters:

name - the name of the feature group

version - the version of the feature group

Returns:

FeatureGroup

Throws:

FeatureStoreException

IOException

getStreamFeatureGroup

public abstract Object getStreamFeatureGroup(String name)
                                      throws FeatureStoreException,
                                             IOException

Get a feature group object with default version `1` from the feature store.

Parameters:

name - the name of the feature group

Returns:

FeatureGroup

Throws:

FeatureStoreException

IOException

createStreamFeatureGroup

public abstract Object createStreamFeatureGroup()

getOrCreateStreamFeatureGroup

public abstract Object getOrCreateStreamFeatureGroup(String name,
                                                     Integer version)
                                              throws IOException,
                                                     FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateStreamFeatureGroup

public abstract Object getOrCreateStreamFeatureGroup(String name,
                                                     Integer version,
                                                     List<String> primaryKeys,
                                                     boolean onlineEnabled,
                                                     String eventTime)
                                              throws IOException,
                                                     FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateStreamFeatureGroup

public abstract Object getOrCreateStreamFeatureGroup(String name,
                                                     Integer version,
                                                     List<String> primaryKeys,
                                                     List<String> partitionKeys,
                                                     boolean onlineEnabled,
                                                     String eventTime)
                                              throws IOException,
                                                     FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateStreamFeatureGroup

public abstract Object getOrCreateStreamFeatureGroup(String name,
                                                     Integer version,
                                                     String description,
                                                     List<String> primaryKeys,
                                                     List<String> partitionKeys,
                                                     String hudiPrecombineKey,
                                                     boolean onlineEnabled,
                                                     StatisticsConfig statisticsConfig,
                                                     String eventTime)
                                              throws IOException,
                                                     FeatureStoreException

Throws:

IOException

FeatureStoreException

createExternalFeatureGroup

public abstract Object createExternalFeatureGroup()

createFeatureView

public abstract Object createFeatureView()

getFeatureView

public abstract Object getFeatureView(String name)
                               throws FeatureStoreException,
                                      IOException

Throws:

FeatureStoreException

IOException

getFeatureView

public abstract Object getFeatureView(@NonNull
                                      @NonNull String name,
                                      @NonNull
                                      @NonNull Integer version)
                               throws FeatureStoreException,
                                      IOException

Throws:

FeatureStoreException

IOException

getOrCreateFeatureView

public abstract Object getOrCreateFeatureView(String name,
                                              T2 query,
                                              Integer version)
                                       throws FeatureStoreException,
                                              IOException

Throws:

FeatureStoreException

IOException

getOrCreateFeatureView

public abstract Object getOrCreateFeatureView(String name,
                                              T2 query,
                                              Integer version,
                                              String description,
                                              List<String> labels)
                                       throws FeatureStoreException,
                                              IOException

Throws:

FeatureStoreException

IOException

getExternalFeatureGroup

public abstract Object getExternalFeatureGroup(@NonNull
                                               @NonNull String name,
                                               @NonNull
                                               @NonNull Integer version)
                                        throws FeatureStoreException,
                                               IOException

Get a external feature group object from the feature store.

Parameters:

name - the name of the feature group

version - the version of the feature group

Returns:

ExternalFeatureGroup

Throws:

FeatureStoreException

IOException

getExternalFeatureGroup

public abstract Object getExternalFeatureGroup(String name)
                                        throws FeatureStoreException,
                                               IOException

Get a external feature group object with default version `1` from the feature store.

Parameters:

name - the name of the feature group

Returns:

ExternalFeatureGroup

Throws:

FeatureStoreException

IOException

getStorageConnector

public abstract StorageConnector getStorageConnector(String name)
                                              throws FeatureStoreException,
                                                     IOException

Get a list of all versions of an external feature group from the feature store.

Parameters:

name - the name of the feature group

Returns:

ExternalFeatureGroup

Throws:

FeatureStoreException

IOException

getHopsFsConnector

public abstract Object getHopsFsConnector(String name)
                                   throws FeatureStoreException,
                                          IOException

Throws:

FeatureStoreException

IOException

getExternalFeatureGroups

public abstract Object getExternalFeatureGroups(@NonNull
                                                @NonNull String name)
                                         throws FeatureStoreException,
                                                IOException

Throws:

FeatureStoreException

IOException

sql

public abstract Object sql(String query)

getJdbcConnector

public abstract Object getJdbcConnector(String name)
                                 throws FeatureStoreException,
                                        IOException

Throws:

FeatureStoreException

IOException

getS3Connector

public abstract Object getS3Connector(String name)
                               throws FeatureStoreException,
                                      IOException

Throws:

FeatureStoreException

IOException

getRedshiftConnector

public abstract Object getRedshiftConnector(String name)
                                     throws FeatureStoreException,
                                            IOException

Throws:

FeatureStoreException

IOException

getSnowflakeConnector

public abstract Object getSnowflakeConnector(String name)
                                      throws FeatureStoreException,
                                             IOException

Throws:

FeatureStoreException

IOException

getAdlsConnector

public abstract Object getAdlsConnector(String name)
                                 throws FeatureStoreException,
                                        IOException

Throws:

FeatureStoreException

IOException

getKafkaConnector

public abstract Object getKafkaConnector(String name)
                                  throws FeatureStoreException,
                                         IOException

Throws:

FeatureStoreException

IOException

getBigqueryConnector

public abstract Object getBigqueryConnector(String name)
                                     throws FeatureStoreException,
                                            IOException

Throws:

FeatureStoreException

IOException

getOnlineStorageConnector

public abstract Object getOnlineStorageConnector()
                                          throws FeatureStoreException,
                                                 IOException

Throws:

FeatureStoreException

IOException

getGcsConnector

public abstract Object getGcsConnector(String name)
                                throws FeatureStoreException,
                                       IOException

Throws:

FeatureStoreException

IOException

getTrainingDataset

public abstract TrainingDatasetBase getTrainingDataset(@NonNull
                                                       @NonNull String name,
                                                       @NonNull
                                                       @NonNull Integer version)
                                                throws FeatureStoreException,
                                                       IOException

Get a training dataset object from the selected feature store.

Parameters:

name - name of the training dataset

version - version to get

Returns:

TrainingDataset

Throws:

FeatureStoreException

IOException

getTrainingDataset

public abstract TrainingDatasetBase getTrainingDataset(String name)
                                                throws FeatureStoreException,
                                                       IOException

Get a training dataset object with the default version `1` from the selected feature store.

Parameters:

name - name of the training dataset

Returns:

TrainingDataset

Throws:

FeatureStoreException

IOException

getTrainingDatasets

public abstract Object getTrainingDatasets(@NonNull
                                           @NonNull String name)
                                    throws FeatureStoreException,
                                           IOException

Get all versions of a training dataset object from the selected feature store.

Parameters:

name - name of the training dataset

Returns:

TrainingDataset

Throws:

FeatureStoreException

IOException

toString

public String toString()

Overrides:

toString in class Object