The siddhi-io-file extension is an extension to Siddhi which used to receive/publish event data from/to file. It supports both binary and text formats.
For information on Siddhi and it's features refer Siddhi Documentation.
- 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 is 2.0.5.
- isDirectory (Function)
This function checks for a given file path points to a directory
- isExist (Function)
This function checks whether a file or a folder exists in a given path
- isFile (Function)
This function checks for a given file path points to a file
- lastModifiedTime (Function)
Checks for the last modified time for a given file path
- size (Function)
This function checks for a given file's size
- archive (Stream Function)
Archives files and folders as a zip or in tar format that are available in the given file uri.
- copy (Stream Function)
This function performs copying file from one directory to another.
- create (Stream Function)
Create a file or a folder in the given location
- delete (Stream Function)
Deletes file/files in a particular path
- move (Stream Function)
This function performs copying file from one directory to another.
- search (Stream Function)
Searches files in a given folder and lists.
- searchInArchive (Stream Function)
This.
- unarchive (Stream Function)
This function decompresses a given file
- file (Sink)
File Sink can be used to publish (write) event data which is processed within siddhi to files.
Siddhi-io-file sink provides support to write both textual and binary data into files - file (Source)
File Source provides the functionality for user to feed data to siddhi from files. Both text and binary files are supported by file source.
There are no other dependencies needed for this extension.
For installing this extension and to add the dependent jars on various siddhi execution environments refer Siddhi documentation section on adding extensions and jars.
-
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.