diff --git a/README.md b/README.md index 6e719878a8..dcd6fedc67 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ Find the released Siddhi libraries 4.4.0. +Latest API Docs is 4.4.1. ## Jenkins Build Status diff --git a/docs/api/4.4.1.md b/docs/api/4.4.1.md new file mode 100644 index 0000000000..83ad00246c --- /dev/null +++ b/docs/api/4.4.1.md @@ -0,0 +1,2265 @@ +# API Docs - v4.4.1 + +## Core + +### and *(Aggregate Function)* + +
Returns the results of AND operation for all the events.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that needs to be AND operation. | ++ | BOOL | +No | +No | +
This will returns the result for AND operation of isFraud values as a boolean value for event chunk expiry by window length batch.
+ +### avg *(Aggregate Function)* + +Calculates the average for all the events.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that need to be averaged. | ++ | INT LONG DOUBLE FLOAT |
+ No | +No | +
avg(temp) returns the average temp value for all the events based on their arrival and expiry.
+ +### count *(Aggregate Function)* + +Returns the count of all the events.
+ +Syntax +``` +This will return the count of all the events for time batch in 10 seconds.
+ +### distinctCount *(Aggregate Function)* + +This returns the count of distinct occurrences for a given arg.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The object for which the number of distinct occurences needs to be counted. | ++ | INT LONG DOUBLE FLOAT STRING |
+ No | +No | +
distinctcount(pageID) for the following output returns '3' when the available values are as follows.
"WEB_PAGE_1"
"WEB_PAGE_1"
"WEB_PAGE_2"
"WEB_PAGE_3"
"WEB_PAGE_1"
"WEB_PAGE_2"
The three distinct occurences identified are 'WEB_PAGE_1', 'WEB_PAGE_2', and 'WEB_PAGE_3'.
Returns the maximum value for all the events.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that needs to be compared to find the maximum value. | ++ | INT LONG DOUBLE FLOAT |
+ No | +No | +
max(temp) returns the maximum temp value recorded for all the events based on their arrival and expiry.
+ +### maxForever *(Aggregate Function)* + +This is the attribute aggregator to store the maximum value for a given attribute throughout the lifetime of the query regardless of any windows in-front.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that needs to be compared to find the maximum value. | ++ | INT LONG DOUBLE FLOAT |
+ No | +No | +
maxForever(temp) returns the maximum temp value recorded for all the events throughout the lifetime of the query.
+ +### min *(Aggregate Function)* + +Returns the minimum value for all the events.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that needs to be compared to find the minimum value. | ++ | INT LONG DOUBLE FLOAT |
+ No | +No | +
min(temp) returns the minimum temp value recorded for all the events based on their arrival and expiry.
+ +### minForever *(Aggregate Function)* + +This is the attribute aggregator to store the minimum value for a given attribute throughout the lifetime of the query regardless of any windows in-front.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that needs to be compared to find the minimum value. | ++ | INT LONG DOUBLE FLOAT |
+ No | +No | +
minForever(temp) returns the minimum temp value recorded for all the events throughoutthe lifetime of the query.
+ +### or *(Aggregate Function)* + +Returns the results of OR operation for all the events.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that needs to be OR operation. | ++ | BOOL | +No | +No | +
This will returns the result for OR operation of isFraud values as a boolean value for event chunk expiry by window length batch.
+ +### stdDev *(Aggregate Function)* + +Returns the calculated standard deviation for all the events.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that should be used to calculate the standard deviation. | ++ | INT LONG DOUBLE FLOAT |
+ No | +No | +
stddev(temp) returns the calculated standard deviation of temp for all the events based on their arrival and expiry.
+ +### sum *(Aggregate Function)* + +Returns the sum for all the events.
+ +Syntax +``` +Name | +Description | +Default Value | +Possible Data Types | +Optional | +Dynamic | +
---|---|---|---|---|---|
arg | +The value that needs to be summed. | ++ | INT LONG DOUBLE FLOAT |
+ No | +No | +
This will returns the sum of volume values as a long value for each event arrival and expiry.
+ +### unionSet *(Aggregate Function)* + +Union multiple sets.
This attribute aggregator maintains a union of sets. The given input set is put into the union set and the union set is returned.