Skip to main content

Quick start

This is a short quick start guide to get you up and running with SA Engine in under 5 minutes. 🚀

1. Download SA Engine

Go to https://studio.streamanalyze.com/download and download SA Engine for your platform. It is free to download but requires email registration.

Open a terminal and unpack the downloaded archive.

unzip sa_engine_core_win_x64.zip

This will unpack a folder sa.engine with the SA Engine executable in the bin subdirectory.

2. Create an OSQL script

Save the following OSQL file to your computer.

quickstart.osql
print("Hello World");
print(timeout(simstream(0.1),1));
quit;

3. Run the script in SA Engine

Open a terminal and run the OSQL script with SA Engine.

sa.engine\bin\sa.engine -O quickstart.osql

The output should be a string that says "Hello World", and a stream of values emitted every 1/10th of a second.

Database image: C:/Users/username/src/sa.engine/bin/sa.engine.dmp
Release 5, v6, 64 bits
Reading OSQL statements from "C:/Users/username/quickstart.osql"
Hello World
0.0
0.135167884385361
-0.0324930499646796
0.112810435340008
0.81064465289327
1.05985752222502
0.269298018030197
-0.175364301400894
0.838084629438005
1.96788004638127

Congratulations! You have now run your first OSQL script in SA Engine.

What's next?

Now that you have run your first OSQL script in SA Engine, we suggest to look at the following resources to learn more about the Stream Analyze platform.

  • Learn more about OSQL in the OSQL tutorial.
  • Learn to use SA VSCode -- the recommended development environment for SA Engine.
  • Read one of our many guides to further expand your knowledge of SA Engine and what it is capable of.