com.logicalclocks.hsfs.constructor

Class QueryBase<T extends QueryBase<T,T2,T3>,T2 extends FeatureGroupBase,T3>

java.lang.Object

com.logicalclocks.hsfs.constructor.QueryBase<T,T2,T3>

Direct Known Subclasses:

Query

public abstract class QueryBase<T extends QueryBase<T,T2,T3>,T2 extends FeatureGroupBase,T3>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected FilterLogic	filter
protected Boolean	hiveEngine
protected List<Join<T>>	joins
protected FeatureGroupBase	leftFeatureGroup
protected Long	leftFeatureGroupEndTime
protected Long	leftFeatureGroupStartTime
protected List<Feature>	leftFeatures
protected static org.slf4j.Logger	LOGGER
protected QueryConstructorApi	queryConstructorApi
protected StorageConnectorApi	storageConnectorApi

Constructor Summary

Constructors

Constructor and Description
QueryBase(T2 leftFeatureGroup, List<Feature> leftFeatures)

Method Summary

Modifier and Type	Method and Description
protected List<Feature>	addFeatureGroupToFeatures(FeatureGroupBase featureGroupBase, List<Feature> leftFeatures)
T	appendFeature(Feature feature)
T	asOf(String wallclockTime) Perform time travel on the given Query.
T	asOf(String wallclockTime, String excludeUntil) Perform time travel on the given Query.
T	filter(Filter filter)
T	filter(FilterLogic filter)
boolean	isTimeTravel()
T	join(T subquery)
T	join(T subquery, JoinType joinType)
T	join(T subquery, JoinType joinType, String prefix)
T	join(T subquery, List<String> on)
T	join(T subquery, List<String> on, JoinType joinType)
T	join(T subquery, List<String> on, JoinType joinType, String prefix)
T	join(T subquery, List<String> leftOn, List<String> rightOn)
T	join(T subquery, List<String> leftOn, List<String> rightOn, JoinType joinType)
T	join(T subquery, List<String> leftOn, List<String> rightOn, JoinType joinType, String prefix)
T	join(T subquery, List<String> leftOn, List<String> rightOn, String prefix)
T	join(T subquery, String prefix)
T	joinFeatures(T subquery, List<Feature> on)
T	joinFeatures(T subquery, List<Feature> on, JoinType joinType)
T	joinFeatures(T subquery, List<Feature> on, JoinType joinType, String prefix)
T	joinFeatures(T subquery, List<Feature> leftOn, List<Feature> rightOn)
T	joinFeatures(T subquery, List<Feature> leftOn, List<Feature> rightOn, JoinType joinType)
T	joinFeatures(T subquery, List<Feature> leftOn, List<Feature> rightOn, JoinType joinType, String prefix)
T	joinFeatures(T subquery, List<Feature> leftOn, List<Feature> rightOn, String prefix)
T	joinFeatures(T subquery, List<Feature> on, String prefix)
T	pullChanges(String wallclockStartTime, String wallclockEndTime) Deprecated. use asOf(wallclockEndTime, wallclockStartTime) instead
abstract Object	read()
abstract Object	read(boolean online)
abstract Object	read(boolean online, Map<String,String> readOptions)
protected void	setLeftFeatureGroup(T2 leftFeatureGroup)
abstract void	show(boolean online, int numRows)
abstract void	show(int numRows)
abstract String	sql()
abstract String	sql(Storage storage)
<T2> String	sql(Storage storage, Class<T2> fsQueryType)

Methods inherited from class java.lang.Object

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

Field Detail

leftFeatureGroup

protected FeatureGroupBase leftFeatureGroup

leftFeatures

protected List<Feature> leftFeatures

leftFeatureGroupStartTime

protected Long leftFeatureGroupStartTime

leftFeatureGroupEndTime

protected Long leftFeatureGroupEndTime

joins

protected List<Join<T extends QueryBase<T,T2,T3>>> joins

filter

protected FilterLogic filter

hiveEngine

protected Boolean hiveEngine

LOGGER

protected static final org.slf4j.Logger LOGGER

queryConstructorApi

protected QueryConstructorApi queryConstructorApi

storageConnectorApi

protected StorageConnectorApi storageConnectorApi

Constructor Detail

QueryBase

public QueryBase(T2 leftFeatureGroup,
                 List<Feature> leftFeatures)

Method Detail

setLeftFeatureGroup

protected void setLeftFeatureGroup(T2 leftFeatureGroup)

sql

public abstract String sql()

sql

public abstract String sql(Storage storage)

sql

public <T2> String sql(Storage storage,
                       Class<T2> fsQueryType)

join

public T join(T subquery)

join

public T join(T subquery,
              String prefix)

join

public T join(T subquery,
              List<String> on)

join

public T join(T subquery,
              List<String> leftOn,
              List<String> rightOn)

join

public T join(T subquery,
              List<String> leftOn,
              List<String> rightOn,
              String prefix)

join

public T join(T subquery,
              JoinType joinType)

join

public T join(T subquery,
              JoinType joinType,
              String prefix)

join

public T join(T subquery,
              List<String> on,
              JoinType joinType)

join

public T join(T subquery,
              List<String> on,
              JoinType joinType,
              String prefix)

join

public T join(T subquery,
              List<String> leftOn,
              List<String> rightOn,
              JoinType joinType)

join

public T join(T subquery,
              List<String> leftOn,
              List<String> rightOn,
              JoinType joinType,
              String prefix)

joinFeatures

public T joinFeatures(T subquery,
                      List<Feature> on)

joinFeatures

public T joinFeatures(T subquery,
                      List<Feature> on,
                      String prefix)

joinFeatures

public T joinFeatures(T subquery,
                      List<Feature> leftOn,
                      List<Feature> rightOn)

joinFeatures

public T joinFeatures(T subquery,
                      List<Feature> leftOn,
                      List<Feature> rightOn,
                      String prefix)

joinFeatures

public T joinFeatures(T subquery,
                      List<Feature> on,
                      JoinType joinType)

joinFeatures

public T joinFeatures(T subquery,
                      List<Feature> on,
                      JoinType joinType,
                      String prefix)

joinFeatures

public T joinFeatures(T subquery,
                      List<Feature> leftOn,
                      List<Feature> rightOn,
                      JoinType joinType)

joinFeatures

public T joinFeatures(T subquery,
                      List<Feature> leftOn,
                      List<Feature> rightOn,
                      JoinType joinType,
                      String prefix)

asOf

public T asOf(String wallclockTime)
       throws FeatureStoreException,
              ParseException

Perform time travel on the given Query. This method returns a new Query object at the specified point in time. This can then either be read into a Dataframe or used further to perform joins or construct a training dataset.

Parameters:

wallclockTime - point in time

Returns:

Query

Throws:

FeatureStoreException

ParseException

asOf

public T asOf(String wallclockTime,
              String excludeUntil)
       throws FeatureStoreException,
              ParseException

Perform time travel on the given Query. This method returns a new Query object at the specified point in time. This can then either be read into a Dataframe or used further to perform joins or construct a training dataset.

Parameters:

wallclockTime - point in time

excludeUntil - point in time

Returns:

Query

Throws:

FeatureStoreException

ParseException

pullChanges

public T pullChanges(String wallclockStartTime,
                     String wallclockEndTime)
              throws FeatureStoreException,
                     ParseException

Deprecated. use asOf(wallclockEndTime, wallclockStartTime) instead

Reads changes that occurred between specified points in time.

Parameters:

wallclockStartTime - start date.

wallclockEndTime - end date.

Returns:

Query

Throws:

FeatureStoreException

ParseException

filter

public T filter(Filter filter)

filter

public T filter(FilterLogic filter)

appendFeature

public T appendFeature(Feature feature)

isTimeTravel

public boolean isTimeTravel()

addFeatureGroupToFeatures

protected List<Feature> addFeatureGroupToFeatures(FeatureGroupBase featureGroupBase,
                                                  List<Feature> leftFeatures)

read

public abstract Object read()
                     throws FeatureStoreException,
                            IOException

Throws:

FeatureStoreException

IOException

read

public abstract Object read(boolean online)
                     throws FeatureStoreException,
                            IOException

Throws:

FeatureStoreException

IOException

read

public abstract Object read(boolean online,
                            Map<String,String> readOptions)
                     throws FeatureStoreException,
                            IOException

Throws:

FeatureStoreException

IOException

show

public abstract void show(int numRows)
                   throws FeatureStoreException,
                          IOException

Throws:

FeatureStoreException

IOException

show

public abstract void show(boolean online,
                          int numRows)
                   throws FeatureStoreException,
                          IOException

Throws:

FeatureStoreException

IOException