Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3

Spark console

Spark console is an interactive tool where the users can enter any supported Spark queries to the console. Spark processes the entered query internally, and then displays the results in the screen immediately. Follow the steps below to use this tool.

  1. Log in to the WSO2 DAS management console.
  2. Click Main, and then click Console in the Spark menu as shown below.
    Spark menu in BAM management console
  3. In the Spark Console view, enter the Spark query and execute it as shown below.
    interactive Spark console

Anchor
Spark scripts
Spark scripts
Spark scripts

Spark scripts are used when you have to execute a set of Spark queries in a sequence. Also, you can schedule a Spark script, to trigger it to execute the query automatically in a given period of time. (E.g. fire at 12 (noon) every day, or fire at every minute starting at 2 p.m. and ending at 2:59 p.m. every day etc.). You need to configure this scheduled time using a cron expression. For more information about cron expressions, see Cron Trigger Tutorial.

You can add/edit/delete scripts, and also you can provide your schedule time for your script to execute as described below.

Adding a new script

Follow the steps below to add a new Spark script.

  1. Log in to the WSO2 DAS management console.
  2. Click Main, and then click Add in the Scripts menu as shown below.
    add new script menu
  3. Enter the following details related to your script as shown in the example below.
    add new Spark script

    Script NameMyFirstSparkScript
    Spark SQL Queries

    define table Log (server_name string, ip STRING, tenant INTEGER, sequence LONG, summary STRING);

    SELECT ip FROM Log;

    SELECT server_name, count(*) FROM Log GROUP BY server_name;

    SELECT COUNT(*) FROM Log WHERE summary LIKE '%Joe%';

    SELECT substr(summary, 1, 5) FROM Log;

    SELECT LAST(ip) FROM Log;

    Cron Expression

    0 * * * * ?

    Info

    This cron expression defines the schedule time of the script to execute it in every minute. From the time you save the script, the script will be executed at the beginning of every minute. (E.g:.10:21:00, 10:22:00, 10:23:00,..)

  4. Click Execute, to execute the provided queries. This will display the results as follows.
    executing the added new script
  5. Click Add, to add the configured script.

Editing a script

Follow the steps below to add a new Spark script.

  1. Log in to the WSO2 DAS management console.
  2. Click Main, and then click Scripts in the Spark menu.
  3. Click List, and click the Edit link of the corresponding script as shown below.
    edit option of the script in list view

  4. Change the content of the script as required. You can update the scheduling information as well. 

    Note

    When you do not enter any value for the scheduling time, then your script is not scheduled to execute. However, if you want to ensure that your script is valid, click Execute. This will execute the queries that you give in the queries window.

    For example, you can edit the script  created above to unschedule the scheduled time as shown below.

    update the edited script

  5. Click Update to save the changes as shown above.

Deleting a script

Follow the steps below to delete a Spark script.

  1. Log in to the WSO2 DAS management console.
  2. Click Main, and then click Scripts in the Spark menu.
  3. Click List, and click the Delete link of the corresponding script as shown below.
    delete script
  4.  Click Yes in the dialog box which appears to confirm deletion. 

    Note

    If you delete the script you cannot undo that operation, and it will be completely removed from the system. Also, deleting the script will delete the scheduled task associated with it.

Executing a script

You can execute the script manually when you are adding/editing the script, without using any scheduled task. This will trigger the execution of the script content provided in the queries window at that moment. Also, you can execute the script content out of the edit mode as shown below. During this operation, WSO2 DAS fetches the script content and gives it to Spark to execute all the queries in the script. Once the execution is completed the results are displayed.

...