NebulaStream  0.6.213
NebulaStream is a data and application management framework for the internet of things
NES::API Namespace Reference

The following declares API functions for windowing. More...

Classes

class  WindowAggregation
 

Typedefs

using WindowAggregationPtr = std::shared_ptr< WindowAggregation >
 

Functions

API::WindowAggregationPtr Sum (const ExpressionItem &onField)
 Defines a Sum Aggregation function on a particular field. More...
 
API::WindowAggregationPtr Min (const ExpressionItem &onField)
 Defines a Min Aggregation function on a particular field. More...
 
API::WindowAggregationPtr Max (const ExpressionItem &onField)
 Defines a Max Aggregation function on a particular field. More...
 
API::WindowAggregationPtr Count ()
 Defines a Count Aggregation function on a particular field. More...
 
API::WindowAggregationPtr Median (const ExpressionItem &onField)
 Defines a Median Aggregation function on a particular field. More...
 
API::WindowAggregationPtr Avg (const ExpressionItem &onField)
 Defines a Agg Aggregation function on a particular field. More...
 
Windowing::TimeCharacteristicPtr EventTime (const ExpressionItem &onField)
 Defines event time as a time characteristic for a window. More...
 
Windowing::TimeCharacteristicPtr EventTime (const ExpressionItem &onField, const Windowing::TimeUnit &unit)
 Defines event time as a time characteristic for a window. More...
 
Windowing::TimeCharacteristicPtr IngestionTime ()
 Defines a ingestion time as a time characteristic for a window. More...
 
Windowing::TimeMeasure Milliseconds (uint64_t milliseconds)
 A time measure in Milliseconds. More...
 
Windowing::TimeMeasure Seconds (uint64_t seconds)
 A time measure in Seconds. More...
 
Windowing::TimeMeasure Minutes (uint64_t minutes)
 A time measure in Minutes. More...
 
Windowing::TimeMeasure Hours (uint64_t hours)
 A time measure in Hours. More...
 
Windowing::TimeMeasure Days (uint64_t days)
 A time measure in Days. More...
 
Windowing::TimeUnit Milliseconds ()
 A time unit in Milliseconds. More...
 
Windowing::TimeUnit Seconds ()
 A time unit in Seconds. More...
 
Windowing::TimeUnit Minutes ()
 A time unit in Minutes. More...
 
Windowing::TimeUnit Hours ()
 A time unit in Hours. More...
 
Windowing::TimeUnit Days ()
 A time unit in Days. More...
 
ExpressionNodePtr RecordCreationTs ()
 This function provides access to the creation ts (ingestion ts) of an individual record. This is assigned by the data source. More...
 

Detailed Description

The following declares API functions for windowing.

Typedef Documentation

◆ WindowAggregationPtr

Function Documentation

◆ Avg()

API::WindowAggregationPtr NES::API::Avg ( const ExpressionItem onField)

Defines a Agg Aggregation function on a particular field.

Parameters
ExpressionItemAttribute("field-name") the field which should be aggregated.
Returns
A descriptor of the aggregation function.

References NES::ExpressionItem::getExpressionNode().

Referenced by NES::TEST_F(), and TEST_F().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Count()

API::WindowAggregationPtr NES::API::Count ( )

Defines a Count Aggregation function on a particular field.

Returns
A descriptor of the aggregation function.

Referenced by NES::TEST_F(), TEST_F(), and NES::Runtime::Execution::TEST_P().

Here is the caller graph for this function:

◆ Days() [1/2]

Windowing::TimeUnit NES::API::Days ( )

A time unit in Days.

Returns
TimeUnit

References NES::Windowing::TimeUnit::Days().

Here is the call graph for this function:

◆ Days() [2/2]

Windowing::TimeMeasure NES::API::Days ( uint64_t  days)

A time measure in Days.

Returns
TimeMeasure

References Hours().

Referenced by NES::TEST_F().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EventTime() [1/2]

Windowing::TimeCharacteristicPtr NES::API::EventTime ( const ExpressionItem onField)

Defines event time as a time characteristic for a window.

Parameters
ExpressionItemwhich defines the field name.
Returns
A descriptor of the time characteristic.

References NES::ExpressionItem::getExpressionNode().

Referenced by NES::Parsers::NesCEPQueryPlanCreator::addBinaryOperatorToQueryPlan(), NES::createRandomStatisticInfo(), NES::Parsers::NesCEPQueryPlanCreator::createTimeBasedWindow(), NES::Runtime::Execution::StreamIntervalJoinQueryExecutionTest::runSingleJoinQuery(), NES::Statistic::TEST_F(), NES::RequestProcessor::TEST_F(), NES::TEST_F(), TEST_F(), NES::Runtime::Execution::TEST_P(), NES::TEST_P(), and TEST_P().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EventTime() [2/2]

Windowing::TimeCharacteristicPtr NES::API::EventTime ( const ExpressionItem onField,
const Windowing::TimeUnit unit 
)

Defines event time as a time characteristic for a window.

Parameters
ExpressionItemwhich defines the field name.
Timeunit
Returns
A descriptor of the time characteristic.

References NES::ExpressionItem::getExpressionNode().

Here is the call graph for this function:

◆ Hours() [1/2]

Windowing::TimeUnit NES::API::Hours ( )

A time unit in Hours.

Returns
TimeUnit

References NES::Windowing::TimeUnit::Hours().

Here is the call graph for this function:

◆ Hours() [2/2]

Windowing::TimeMeasure NES::API::Hours ( uint64_t  hours)

A time measure in Hours.

Returns
TimeMeasure

References Minutes().

Referenced by NES::Parsers::NesCEPQueryPlanCreator::createIntervalWindow(), Days(), TEST_F(), and NES::Parsers::NesCEPQueryPlanCreator::transformWindowToTimeMeasurements().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IngestionTime()

Windowing::TimeCharacteristicPtr NES::API::IngestionTime ( )

Defines a ingestion time as a time characteristic for a window.

Returns
A descriptor of the time characteristic.

Referenced by NES::StatisticIdsExtractorTest::SetUp(), NES::TEST_F(), and TEST_P().

Here is the caller graph for this function:

◆ Max()

API::WindowAggregationPtr NES::API::Max ( const ExpressionItem onField)

Defines a Max Aggregation function on a particular field.

Parameters
ExpressionItemAttribute("field-name") the field which should be aggregated.
Returns
A descriptor of the aggregation function.

References NES::ExpressionItem::getExpressionNode().

Referenced by NES::Parsers::NesCEPQueryPlanCreator::createQueryFromPatternList(), NES::TEST_F(), TEST_F(), and NES::CEPOperatorBuilder::Times::window().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Median()

API::WindowAggregationPtr NES::API::Median ( const ExpressionItem onField)

Defines a Median Aggregation function on a particular field.

Returns
A descriptor of the aggregation function.

References NES::ExpressionItem::getExpressionNode().

Referenced by NES::TEST_F().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Milliseconds() [1/2]

Windowing::TimeUnit NES::API::Milliseconds ( )

A time unit in Milliseconds.

Returns
TimeUnit

References NES::Windowing::TimeUnit::Milliseconds().

Here is the call graph for this function:

◆ Milliseconds() [2/2]

◆ Min()

API::WindowAggregationPtr NES::API::Min ( const ExpressionItem onField)

Defines a Min Aggregation function on a particular field.

Parameters
ExpressionItemAttribute("field-name") the field which should be aggregated.
Returns
A descriptor of the aggregation function.

References NES::ExpressionItem::getExpressionNode().

Referenced by NES::TEST_F(), and TEST_F().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Minutes() [1/2]

Windowing::TimeUnit NES::API::Minutes ( )

A time unit in Minutes.

Returns
TimeUnit

References NES::Windowing::TimeUnit::Minutes().

Here is the call graph for this function:

◆ Minutes() [2/2]

Windowing::TimeMeasure NES::API::Minutes ( uint64_t  minutes)

A time measure in Minutes.

Returns
TimeMeasure

References Seconds().

Referenced by NES::Parsers::NesCEPQueryPlanCreator::createIntervalWindow(), Hours(), NES::StatisticIdsExtractorTest::SetUp(), TEST_F(), NES::TEST_F(), and NES::Parsers::NesCEPQueryPlanCreator::transformWindowToTimeMeasurements().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RecordCreationTs()

ExpressionNodePtr NES::API::RecordCreationTs ( )

This function provides access to the creation ts (ingestion ts) of an individual record. This is assigned by the data source.

Returns
ExpressionNodePtr

References NES::Attribute(), NES::ExpressionItem::getExpressionNode(), and NES::UINT64.

Here is the call graph for this function:

◆ Seconds() [1/2]

Windowing::TimeUnit NES::API::Seconds ( )

A time unit in Seconds.

Returns
TimeUnit

References NES::Windowing::TimeUnit::Seconds().

Here is the call graph for this function:

◆ Seconds() [2/2]

Windowing::TimeMeasure NES::API::Seconds ( uint64_t  seconds)

A time measure in Seconds.

Returns
TimeMeasure

References Milliseconds().

Referenced by NES::Parsers::NesCEPQueryPlanCreator::createIntervalWindow(), Minutes(), NES::TEST_F(), TEST_F(), NES::TEST_P(), NES::Runtime::Execution::TEST_P(), and NES::Parsers::NesCEPQueryPlanCreator::transformWindowToTimeMeasurements().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Sum()

API::WindowAggregationPtr NES::API::Sum ( const ExpressionItem onField)

Defines a Sum Aggregation function on a particular field.

Parameters
ExpressionItemAttribute("field-name") the field which should be aggregated.
Returns
A descriptor of the aggregation function.

References NES::ExpressionItem::getExpressionNode().

Referenced by NES::Parsers::NesCEPQueryPlanCreator::createQueryFromPatternList(), TEST_F(), NES::TEST_F(), TEST_P(), NES::TEST_P(), and NES::CEPOperatorBuilder::Times::window().

Here is the call graph for this function:
Here is the caller graph for this function: