...

The #PROCEDURE allows to create stored procedures that are saved into the data dictionary and can be reused by any other scripts, see #EXECUTE how to use run them.

Usage

Like common if-statements in other programming languages, the structure of #IFDEF follows "if-then-else", where the "else" part is not necessary. Accordingly, the structure is as follows:

#IFDEF <variable-name>

<then-commands>

#ENDIF

or

#IFDEF <variable-name>

<then-commands>

#ELSE

<else-commands>

#ENDIF

So, if the variable named <variable-name> exists, the control flow runs the <then-commands>, if not and there is an else-part, the <else-commands> are executed. Look also add #DEFINE and #UNDEF to set or unset variables.

Example

Usage

Procedures can be compared to stored procedures in a database system or like methods in a programming language. It allows defining a snippet of Odysseus Script that is reusable. The structure for creating a new procedure is as follows:

#PROCEDURE <procedure-name>
<variable 1>
<variable 2>
...
<variable n>

BEGIN

    <arbitrary odysseus script commands>

END

First, the name, which must be after the #PROCEDURE in the same line, is defined. After that, there might be an ordered list of variables. The order is important! These variables will be used as the parameters. Finally, there can be any Odysseus-Script code including queries etc. between the BEGIN and END. The only exception are "global" variables. Between BEGIN and END, only variables are allowed that are defined before (after the procedure name).

You can execute the procedure by using the #EXECUTE command or delete a procedure by calling #DROPPROCEDURE

Example

The example creates a procedure with name "setSomething" and has two parameters (varX and attribute). Remeber, order is important! The procedure calls a #RUNQUERY-Command including both parameters. See #EXECUTE command how this example is used.

#PROCEDURE setSomething
varX
attribute
BEGIN
    #RUNQUERY
    SELECT 1 AS a, 2 AS ${attribute}, * FROM bid WHERE b>${varX}
END

#EXECUTE

The #EXECUTE command can be used for running installed procedures, which were created by using the #PROCEDURE command.

Usage

Procedures can be compared to stored procedures in a database system or like methods in a programming language. It allows defining a snippet of Odysseus Script that is reusable. The structure for creating a new procedure is as follows:

#EXECUTE <procedure-name>(<variable 1>, <variable 2>, ...,  <variable n>)

The usage is similar to function calls in programming languages like Java. After #EXECUTE the name of procedure with a comma-separated list of its parameters. The parameters must be according to the definition of the procedure. If there were two parameters defined by #PROCEDURE, here are also two parameters needed. Notice, the order is important!

You can create the procedure by using the #PROCEDURE command or delete a procedure by calling #DROPPROCEDURE

Example

The example creates a procedure with name "setSomething" and has two parameters (varX and attribute). Remeber, order is important! The procedure calls a #RUNQUERY-Command including both parameters. See #EXECUTE command how this example is The example defines a variable called latencyOn and uses the #IFDEF command to use either StandardLatency for the transformation configuration, if latencyOn is set or Standard if it is not set. Obviously, this example uses allways the <then-command>-part (since latencyOn is set), so you may switch to another transformation config by simply commenting the #DEFINE command out so that the <else-commands> are used.

#DEFINE latencyOn
....
#IFDEF latencyOn
	#TRANSCFG StandardLatency	
#ELSE
	#TRANSCFG Standard
#ENDIF#PROCEDURE setSomething
varX
attribute
BEGIN
    #RUNQUERY
    SELECT 1 AS a, 2 AS ${attribute}, * FROM bid WHERE b>${varX}
END

Commands

#ADDQUERY

This command executes a query in a certain langauge and is equal to #QUERY

...

The parameters are one or two values, which are separated by a blank or tab. Therefore, the parameters may not have any blanks or tabs. The first parameter is the name and the second paramter is the value that is assigned to the name. However, the second parameter (the value) is optional, because it a value for #IFDEF is not necessary, otherwise it cannot be used for replacement.

Example

The first variable is called "one" and has no value. The second variable is called "two" and has the value "1234". See at Variables or at #IFDEF for examples how to use a variable.

...

The parameter is a boolean: the parameter may be either "true" or "false".

Example

/// query sharing off
#DOQUERYSHARING false
/// query sharing on
#DOQUERYSHARING true

...

The parameter is a boolean: the parameter may be either "true" or "false".

Example

/// query rewrite off
#DOREWRITE false
/// query rewrite on
#DOREWRITE true

...

Parameters

It has no parameters.

Example

#DROPALLQUERIES

...

Parameters

It has no parameters.

Example

#DROPALLSINKS

...

Parameters

It has no parameters.

Example

#DROPALLSOURCES

...

There are two parameters: the username and the password.

Example

This example changes the user to "System" with password "manager"

...

Parameters

Has no parameters

Example

#LOGOUT

...

The parameters are: The name of the Odysseus configuration param and the new value

Example

#ODYSSEUS_PARAM scheduler_TimeSlicePerStrategy 10

...

The parser: Which parsers are available strongly depends on the current system setting and installed features. Normally in the default product, there is "PQL" for Procedural Query Language (PQL) and "CQL" for Continuous Query Language (CQL).

Example

#PARSER PQL

...

If #QName is defined before, the query will get this name.

Example

The example shows four queries after the parser is set to CQL and the transformation configuration is set to Standard. The first one uses #QUERY and it is executed as a CQL-Query, but not started. The second query is equal to the first one (it still uses CQL and is not started). The third query also uses CQL and the Standard transformation configuration, but is (in contrast to the first and second) started (it is directly running). Then, the parser is switched to PQL, so that the fourth query is parsed by the PQL-Parser and not  by the CQL-Parser anymore.

...

This command has no parameters.

Example

#RELOADFROMLOG

...

It needs two parameters: The scheduler and the scheduling-strategy. The available schedulers and strategies depends on the current system setting (additional features could be necessary!), because they are dynamically bound.

Example

Uses the "Single Thread Scheduler" with a "Round Robin" scheduling strategy

...

The parameter is a number. It defines the time in milliseconds for which the script execution should sleep.

Example

Waiting 2 seconds (2000 milliseconds) until the next command is invoked.

...

This command has no parameters.

Example

#STARTQUERIES

...

This command has no parameters.

Example

#STARTSCHEDULER

...

This command has no parameters.

Example

#STOPSCHEDULER

...

The configuration: Which configruations are available strongly depends on the current system setting and installed features. Normally in the default product, there is "Standard" for the default transformation configuration. If the latency feature is installed, there is also "StandardLatency" available, which invokes specific transformations so that the latency is automatically calculated.

Example

#TRANSCFG Standard

...

The configuration: Which configruations are available strongly depends on the current system setting and installed features. Normally in the default product, there is "Standard" for the default transformation configuration. If the latency feature is installed, there is also "StandardLatency" available, which invokes specific transformations so that the latency is automatically calculated.

Example

#TRANSCFG Standard

...