Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/siddhi-io/siddhi-execution-time

Extension that provides time-related functionalities
https://github.com/siddhi-io/siddhi-execution-time

date execution extension siddhi time utility

Last synced: 2 months ago
JSON representation

Extension that provides time-related functionalities

Awesome Lists containing this project

README

        

Siddhi Execution Time
======================================

[![Jenkins Build Status](https://wso2.org/jenkins/job/siddhi/job/siddhi-execution-time/badge/icon)](https://wso2.org/jenkins/job/siddhi/job/siddhi-execution-time/)
[![GitHub Release](https://img.shields.io/github/release/siddhi-io/siddhi-execution-time.svg)](https://github.com/siddhi-io/siddhi-execution-time/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/siddhi-io/siddhi-execution-time.svg)](https://github.com/siddhi-io/siddhi-execution-time/releases)
[![GitHub Open Issues](https://img.shields.io/github/issues-raw/siddhi-io/siddhi-execution-time.svg)](https://github.com/siddhi-io/siddhi-execution-time/issues)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/siddhi-io/siddhi-execution-time.svg)](https://github.com/siddhi-io/siddhi-execution-time/commits/master)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

The **siddhi-execution-time extension** is a Siddhi extension that provides time related functionality such as getting current time, current date, manipulating/formatting dates, etc.

For information on Siddhi and it's features refer Siddhi Documentation.

## Download

* Versions 5.x and above with group id `io.siddhi.extension.*` from here.
* Versions 4.x and lower with group id `org.wso2.extension.siddhi.*` from here.

## Latest API Docs

Latest API Docs is 5.0.8.

## Features

* currentDate *(Function)*



Function returns the system time in yyyy-MM-dd format.



* currentTime *(Function)*


Function returns system time in the HH:mm:ss format.



* currentTimestamp *(Function)*


When no argument is provided, function returns the system current timestamp in yyyy-MM-dd HH:mm:ss format, and when a timezone is provided as an argument, it converts and return the current system time to the given timezone format.



* date *(Function)*


Extracts the date part of a date or date-time and return it in yyyy-MM-dd format.



* dateAdd *(Function)*


Adds the specified time interval to a date.



* dateDiff *(Function)*


Returns difference between two dates in days.



* dateFormat *(Function)*


Formats the data in string or milliseconds format to the given date format.



* dateSub *(Function)*


Subtracts the specified time interval from the given date.



* dayOfWeek *(Function)*


Extracts the day on which a given date falls.



* extract *(Function)*


Function extracts a date unit from the date.



* timestampInMilliseconds *(Function)*


Returns the system time or the given time in milliseconds.



* timezoneConvert *(Function)*


Converts source datetime to provided target timezone and return the datetime string



* utcTimestamp *(Function)*


Function returns the system current time in UTC timezone with given date format which defaults to yyyy-MM-dd HH:mm:ss if not provided.


## Dependencies

There are no other dependencies needed for this extension.

## Installation

For installing this extension on various siddhi execution environments refer Siddhi documentation section on adding extensions.

## Support and Contribution

* We encourage users to ask questions and get support via StackOverflow, make sure to add the `siddhi` tag to the issue for better response.

* If you find any issues related to the extension please report them on the issue tracker.

* For production support and other contribution related information refer Siddhi Community documentation.