DOCUMENTATION  >  Table of contentsCHEETAH 4.4.0  |  DATA-PRISME
Getting Started Server Data manipulation SOAQL Environment Statement Container Scheduler Stack Oracle Database SQLServer MySQL MySQL Embedded PostgreSQL DB2 FireBird FireBird Embedded ODBC MaxDb Advantage Database H2 H2 Embedded HSQL HSQL Embedded Derby Derby Embedded Connection Pool Query and DML Aggregation Transaction SCRUD MAPPING ResultSet MongoDB EBP (Open Line) Sage IMAP POP3 SMTP PDF Excel (xls) Excel (xlsx) Word (doc) Word (docx) XML JSON Data Config File QlikView (qvx) Prompto (data.js) Facebook SSH FTP FTPS SFTP GoogleDrive RS232 HTTP - X509 SOAQL - RSA User OpenLDAP SOAP WSWINDEV REST Web server Web socket Web HTML Application Parallel Cluster definition Cluster node Cluster agent Tunnels Tree Compress OS Java Environment Hardware GeoLocation Sensor
Root   >   Getting Started
Gettingstarted (8) Basic_val (1) Example1 (6) Example2 (4)
Root   >   Getting Started   >   Gettingstarted
      This module contains basic informations for Cheetah installation and basic usage.

Root   >   Getting Started   >   Gettingstarted   >   documentation
To see the documentation,
Start a single server, and go to http://localhost:4480/docs

Return: A web page ...


Root   >   Getting Started   >   Gettingstarted   >   start a single server
Start a single server


Begin


0°) Embedded mode


MySQL is already embedded into Cheetah. By default Cheetah start in embedded mode.
Go to 2°) ...


1°) External database mode:


Create soaql database in MariaDB5 or MySQL5 server (the same database for all nodes and agents in a cluster environment)


mysql> create database soaql;
os> mysql -u root -pyourpassword soaql < INSTALL/soaql.sql
mysql> CREATE USER 'soaql'@'localhost' IDENTIFIED BY 'pwd';
mysql> GRANT ALL PRIVILEGES ON *.* TO 'soaql'@'localhost';


2°) Configure the server with the file 'etc/conf/cheetah.conf'.


In an embedded mode your default Cheetah configuration should be right.
In an external database, update the connection (used for load all connection pools) in the section "[CLIENT_SERVER]",
and set the field Embedded=0 in the section "[EMBEDDED]".


3°) See in the "cheetah/bin" directory, choose your OS and select the script start.sh (or .bat for Windows) ...


For example start a manager by default on Linux 32bits:
cd cheetah/bin/linux64
./start.sh


4°) Now you can connect to your server with the editor/terminal/console


Editor (Linux): cd cheetah/bin/linux64
Editor (Linux): ./editor.sh


Monitor (Windows): cd cheetah/bin/windows32
Monitor (Windows): ./terminal.bat


Web console: http://localhost:4480/console (user: cheetah, password: pwd)


Docs: http://localhost:4480/docs


End


Root   >   Getting Started   >   Gettingstarted   >   stop a server
To stop a Cheetah server,


1°) connect to your server with a user in the group 'Shutdown'. By default 'cheetah', and 'soaql' are in this group.
Execute the command 'stop()' or 'shutdown()'


2°) Or cd cheetah/bin/linux64
./shutdown.sh

Return: The server shutdown


Root   >   Getting Started   >   Gettingstarted   >   connect with the editor
Connect to Cheetah with the editor.

Editor (Linux): cd cheetah/bin/linux64
Editor (Linux): ./editor.sh

hostname - The host name - String - Cannot be null - Cannot be empty
port - The port number - Number - Cannot be null - Cannot be empty
user - The user - String - Cannot be null - Cannot be empty
password - The password ('pwd' by default) - String - Cannot be null - Cannot be empty

Root   >   Getting Started   >   Gettingstarted   >   connect with the terminal
Connect to Cheetah with the terminal.
(Warning: Commands end with ; in the terminal but NOT IN THE EDITOR).
Monitor (Windows): cd cheetah/bin/windows32
Monitor (Windows): ./terminal.bat

Return: soaql >

hostname - The host name - String - Cannot be null - Cannot be empty
port - The port number - Number - Cannot be null - Cannot be empty
user - The user - String - Cannot be null - Cannot be empty
password - The password ('pwd' by default) - String - Cannot be null - Cannot be empty

Root   >   Getting Started   >   Gettingstarted   >   connect with the console
Connect to Cheetah with the web console for manage all servers.
Go to http://localhost:4480/console (user: cheetah, password: pwd)

Return: A web page ...

user - The user - String - Cannot be null - Cannot be empty
password - The password ('pwd' by default) - String - Cannot be null - Cannot be empty

Root   >   Getting Started   >   Gettingstarted   >   connect with java
Connect to Cheetah with java (Download the connector 'lv2 javaconnector - X.X.X p.jar' and add it in your classpath).

public static void main(String[] args) {

//Initialization
com.dataprisme.soaql.SOAQLConnector_3_0 connector = null;

//Try to execute SOAQL requests
try {

//Server connection
connector = new com.dataprisme.soaql.SOAQLConnector_3_0("localhost", 4440); //for a node
//connector = new SOAQLConnector_3_0("host1", 4440, "host2", 4440); for a cluster with multiple agent

//User connection
if (connector.connect("soaql", "pwd")) {

//Connection informations
System.out.println(connector.serverConnectionState);
System.out.println(connector.userConnectionState);

try {

//Execute SOAQL requests
System.out.println(connector.execute("string.substr('123', 0, 1)"));
System.out.println(connector.execute(
"exe("+
" set_var('[counter]', 0),"+
" for(set_var('[i]', 0), <([i], 10), incr_var('[i]', 1),"+
" exe("+
" incr_var('[counter]', 2),"+
" [counter]"+
" )"+
" )"+
")"));

//Close the session properly
System.out.println(connector.execute("exit()"));

} catch (SOAQLException e) {

//SOAQL Exception
System.out.println(e.getMessage());

} catch (Exception e) {

//Other connection exception
System.out.println(e.getMessage());

}

} else {

//Connection informations
System.out.println(connector.serverConnectionState);
System.out.println(connector.userConnectionState);

}

} catch (Exception e) {

//An error was generated
System.out.println(e.getMessage());

} finally {

try {
//Close the connector
connector.close();
} catch (Exception e) {}

}

}



Root   >   Getting Started   >   Gettingstarted   >   customize with java
It is easy to create new java class usable with Cheetah.

Simply follow this 7 rules:

    1 - Class and function names must be write in upper case and cannot already exist (but not in use).

    2 - Create and save the .class file in the directory lib/com/dataprisme/soaql/functions .

package com.dataprisme.soaql.functions;


import com.dataprisme.soaql.SOAQLEngine;

import com.dataprisme.soaql.SOAQLEnvironmentVariables;


public class XXXXX {


@SuppressWarnings("unused")

private static boolean readyShortcuts = shortcutLoader();


//Load all shortcuts

private static boolean shortcutLoader() {


//XXXXX is your class name

//Shortcut is not required

SOAQLEngine.addShortcut("HELLO", "XXXXX");

SOAQLEngine.addShortcut("LENGTH2", "XXXXX");


return true;


}


//The hello world function

//Class.Method: XXXXX.hello() return 'Hello world!'

//Or with the shortcut: hello() return 'Hello world!'

public static String HELLO(SOAQLEnvironmentVariables env, String nothing) {


return "Hello world!";


}


//Another function

//Class.Method: XXXXX.length2('azerty') return '6'

//Or with the shortcut: length2('azerty') return '6'

public static String LENGTH2(SOAQLEnvironmentVariables env, String str) {


//If str is null then return null

if (str==null) {


return null;


} else {


//Get the length

return ""+str.length();


}


}


}


    3 - The function must be 'static'.

    4 - The function must return a string.

    5 - The function must take in first argument an object SOAQLEnvironmentVariables, and string for others.

    6 - The first string argument is required even if your function does not need argument (name it 'nothing' for example).

        See the function XXXXX.hello() ...

    7 - Restart your server.


Root   >   Getting Started   >   Basic_val
      This module contains basic commands.

Root   >   Getting Started   >   Basic_val   >   examples
Basic values

Return: A string.

1
2
3
4
5
6
7
8
9
10
exe(
  '//In SOAQL, all is string or null. Others are shortcuts.',
  concat(
    equal(123'123'),
    equal(true'1'),
    equal(false'0'),
    equal('comment''//comment'),
    '//My string\\' \\...',
  )
)
1110//My string\' \\...1
1
2
3
4
exe(
  '//In SOAQL, all is string or null. Others are shortcuts.',
  equal(123null)
)
0
1
2
3
4
exe(
  '//Addition.',
  ADD(+(123-45.632222), 5)
)
82.36778
1
2
3
4
exe(
  '//True or false.',
  and(or(truefalse), 1)
)
1
1
2
3
4
exe(
  '//Variable.',
  concat('Hello '[USER]'!')
)
Hello soaql!
1
2
3
4
concat(
  '//This is a comment, ',
  'but it is a string ...'
)
//This is a comment, but it is a string ...
1
2
3
4
5
6
7
concat(
  '//As a string',
  equal('[SOAQL_N]'[SOAQL_N]),
  equal('[SOAQL_R]'[SOAQL_R]),
  equal('[SOAQL_RN]'[SOAQL_RN]),
  equal('[SOAQL_T]'[SOAQL_T])
)
//As a string1111
Root   >   Getting Started   >   Example1
      A supplier wants to provide its products (name and number available) to customers in real time

Root   >   Getting Started   >   Example1   >   at supplier: creation of container
The provider offers its stock

Return: A string.

1
2
3
4
CONTAINER.add('system''default.DemoSupplierContainer''[]'true3soaql(exe(
  '//Your SOAQL commands',
  table(1'select id, name, quantity from example_products')
)), 'The supplier container example …')
1

Root   >   Getting Started   >   Example1   >   at supplier: check the container
Check the container

Return: A string.

1
execute('default.DemoSupplierContainer')
[T.COL1] [T.COL2] [T.COL3]
1 Product name 1 5
2 Product name 2 20
3 Product name 3 5000

Root   >   Getting Started   >   Example1   >   at supplier: gives rights
gives rights to a restricted user for remote access

Return: A string.

1
2
3
4
5
6
7
8
exe(
  '//Create the restricted adam',
  USER.add_restricted('adam''pwd''Adam Fabre'),
  '//Gives rights on the container',
  group.grant_container('HelloWorldGroup''default.DemoSupplierContainer'),
  '//Grant to adam the right to execute all containers in the group HelloWorldGroup',
  GROUP.grant_user('adam''HelloWorldGroup')
)
1

Root   >   Getting Started   >   Example1   >   client: call the remote container
Call the remote container

Return: A string.

1
2
3
TUNNEL30.execute_immediate('127.0.0.1'4440'adam''pwd'soaql(
  execute('default.DemoSupplierContainer')
))
[T.COL1] [T.COL2] [T.COL3]
1 Product name 1 5
2 Product name 2 20
3 Product name 3 5000

Root   >   Getting Started   >   Example1   >   at supplier: send the price
Update the container and send the price

Return: A string.

1
2
3
4
CONTAINER.update('system''default.DemoSupplierContainer''[]'true3,  soaql(exe(
  '//Your SOAQL commands',
  table(1'select id, name, quantity, price from example_products')
)), 'The supplier container example …')
1

Root   >   Getting Started   >   Example1   >   client: recall the remote container
Recall the remote container

Return: A string.

1
2
3
TUNNEL30.execute_immediate('127.0.0.1'4440'adam''pwd'soaql(
  execute('default.DemoSupplierContainer')
))
[T.COL1] [T.COL2] [T.COL3] [T.COL4]
1 Product name 1 5 10
2 Product name 2 20 5
3 Product name 3 5000 100
Root   >   Getting Started   >   Example2
      Of all the people who flew last week, how many have already committed a crime and want to work?

Root   >   Getting Started   >   Example2   >   build and save the query
Just for example, but the query is much more complex ...

Return: A string.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
set_var('[VarFlow]',
  select(
    ([Z1.COL1][Z2.COL2]),
    select(
      ([T1.COL1][T2.COL2]),
      TUNNEL30.execute_immediate('civil-aviation1.com'4440'admin''pwd'soaql(
        TUNNEL30.execute_immediate('civil-aviation2.com'4440'admin''pwd'soaql(
          table('OracleConnectionPool',
            'select NATIONAL_ID, FULL_NAME from example_civil_aviation where sysdate()>sysdate()-7'
          )
        ))
      )),
      inner,
      TUNNEL30.execute_immediate('police-force.com'4440'admin''pwd'soaql(
        table('SQLServerConnectionPool',
          'select NATIONAL_ID, FULL_NAME from example_police_force where COMMITTED_A_CRIME=\'Y\''
        )
      )),
      where(equal([T1.COL1][T2.COL1])),
      limit(100),
      offset(0),
      namespace('T')
    ),
    inner,
    TUNNEL30.execute_immediate('agency_for_employment.com'4440'admin''pwd'soaql(
      table('DB2ConnectionPool',
        'select NATIONAL_ID, FULL_NAME from example_agency_for_employment where WORK=\'Y\''
      )
    )),
    where(equal([Z1.COL1][Z2.COL1])),
    groupby([Z1.COL1]),
    orderby(DESC([Z.COL1])),
    limit(100),
    offset(0),
    namespace('Z')
  )
)
[Z.COL1] [Z.COL2]
3 Daniela Payet

Root   >   Getting Started   >   Example2   >   send every night
to secret services ...

Return: A string.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
exe(
  '//Create the SOAQL container',
  CONTAINER.add('system''default.flowSenderContainer''[]'true3soaql(
    TUNNEL30.execute_immediate('secret-services.com'4440'ss''pwd',
      concat(
        'execute(\'default.flowReceiverContainer\', \'[Flow]\', ',
        to_string([VarFlow]),
        ')'
      )
    )
  ), 'Container to send the flow to secret services ...'),
  '//Add and load a new job for the node 1 and all agents',
  scheduler.add_in_db('sendToSecretServices''N1,A*''default.flowSenderContainer''0 0 23 * * ?'),
  scheduler.activate('sendToSecretServices'),
  scheduler.reload()
)
JOBID TARGETLIST USER CONTAINER PATTERN DTCREATE
sendToSecretServices N1,A* soaql default.flowSenderContainer 0 0 23 * * ? 2014-10-09 10:07:58.0

Root   >   Getting Started   >   Example2   >   secret services receive the flow
Secret services receive the flow ...

Return: A string.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
exe(
  '//Create the SOAQL container',
  CONTAINER.add('system''default.flowReceiverContainer''[["[Flow]", "STR"]]'true3soaql(
    for_each(
     [Flow],
      if(starts_with([T.COL1]'Payet'),
        for(set_var('[i]'0), <([i]10), incr_var('[i]'1),
          exe(
            '//Command 1',
            '//Command 2',
            '//Result'
          )
        ),
        CONCAT([T.COL1]':'[T.COL2])
      ), namespace('T')
    )
  ), 'Container to receive the flow ...'),
  '//Create the restricted user adam',
  USER.add_restricted('ss''pwd''Adam Fabre'),
  '//Give right',
  group.grant_container('HelloWorldGroup''default.flowReceiverContainer'),
  '//Grant to adam the right to execute a container in the group HelloWorldGroup',
  GROUP.grant_user('ss''HelloWorldGroup')
)
1

Root   >   Getting Started   >   Example2   >   force the execution
Force the execution ...

Return: A string.

1
execute('default.flowSenderContainer')
[T.COL1]
3:Daniela Payet
Root   >   Server
Root   >   Server   >   Store
      This module contains basic commands for manage additional addons from the store.

Root   >   Server   >   Store   >   example
Store example...

Return: A string.

1
2
3
4
5
6
7
exe(
  '//Install the addons from the store',
  store.list(), '//To see all directories from the store',
  store.list('pop3'), '//To see all addons in the \'pop3\' directory',
  store.download('lv2 pop3 - 1.0.0 p.jar'), '//To download the addons',
  '//Your addons is saved in the \'var/addons/received\' directory,
and unjar in \'addons\' directory'

)
//Your addons is saved in the 'var/addons/received' directory,
and unjar in \'addons\' directory'

Root   >   Server   >   Store   >   ping_store_module
Return ';)'.

Return: A string.

1
ping_store_module()
;)

Root   >   Server   >   Store   >   list
Get all files in the store directory/subdirectory.

Return: A string.

dir - The addons directory - String - Cannot be null - Cannot be empty
1
store.list()
store.list('advantage')
store.list('agent')
store.list('aggreg')
store.list('cert')
store.list('cifs')
store.list('cluster')
store.list('compress')
store.list('container')
store.list('corp')
1
store.list('pop3')
store.install('lv2 pop3 - 1.0.0 p.jar')

Root   >   Server   >   Store   >   get_download_status
Get the download status

Return: A boolean.

1
store.get_download_status()
10

Root   >   Server   >   Store   >   set_download_status
Set the download status

Return: A boolean.

percent - The percent - Number - Cannot be null - Cannot be empty
1
store.set_download_status(10)
1

Root   >   Server   >   Store   >   install
Download and install an addons from the Data-Prisme Store

Return: A string.

addons - The file addons - String - Cannot be null - Cannot be empty
1
store.install('lv2 pop3 - 1.0.0 p.jar')
Download and install with successful. Restart your server ...

Root   >   Server   >   Store   >   download
Download and install an addons from the Data-Prisme Store

Return: A string.

addons - The file addons - String - Cannot be null - Cannot be empty
1
store.download('lv2 pop3 - 1.0.0 p.jar')
Download and install with successful. Restart your server ...

Root   >   Server   >   Store   >   help
Display all store commands.

Return: A string.

1
store.help()
store.list() -> Show all directories in the Data-Prisme Store.
store.list('dir') -> Show all addons in the Data-Prisme Store for a specific directory.
store.install('lv2 pop3 - 1.0.0 p.jar') -> Download and install an addons from the Data-Prisme Store
store.help() -> Show this help.
Root   >   Server   >   Addons
      This module contains basic commands for manage additional addons from the store.

Root   >   Server   >   Addons   >   example
Addons example

Return: A string.

1
2
3
4
exe(
  '//Show the list of all addons already download.',
  addons.list()
)
# ADDONS IS_INSTALLED
1 corp False
2 editor False
3 gettingstarted False
4 javaconnector False
5 mysql False
6 mysqlmxj False
7 terminal False
1
2
3
4
5
6
7
exe(
  '//Install the addons from the store',
  store.list(), '//To see all directories from the store',
  store.list('pop3'), '//To see all addons in the \'pop3\' directory',
  store.download('lv2 pop3 - 1.0.0 p.jar'), '//To download the addons',
  '//Your addons is saved in the \'var/addons/received\' directory,
and unjar in \'addons\' directory'

)
//Your addons is saved in the 'var/addons/received' directory,
and unjar in \'addons\' directory'
1
2
3
4
exe(
  '//Show the list of all addons already download.',
  addons.list()
)
# ADDONS IS_INSTALLED
1 corp False
2 editor False
3 gettingstarted False
4 javaconnector False
5 mysql False
6 mysqlmxj False
7 pop3 False
8 terminal False
1
2
3
4
exe(
  '//Check if an addons is already installed.',
  addons.is_installed('pop3')
)
0
1
2
3
4
exe(
  '//Finish to install the addons.',
  addons.install('pop3')
)
Successfully installed.
1
2
3
4
exe(
  '//Uninstall the addons.',
  addons.uninstall('pop3')
)
Successfully uninstalled.

Root   >   Server   >   Addons   >   ping_addons_module
Return ';)'.

Return: A string.

1
ping_addons_module()
;)

Root   >   Server   >   Addons   >   shortcuts
Return all shortcuts.

Return: A string.

1
addons.shortcuts()
FUNCTION CLASS
STRING HEX_TO_INT
DATE MONTH
STRING TRIM
PARAM PING_PARAM_MODULE
DB FOR_EACH
DATE PING_DATE_MODULE

Root   >   Server   >   Addons   >   list
Get all addons in the addons directory.
SOAQL Server can call function like this: demo.HOME.hello()

Return: A string.

1
addons.list()
# ADDONS
1 corp
2 editor
3 gettingstarted
4 javaconnector
5 mysql
6 mysqlmxj
7 terminal

Root   >   Server   >   Addons   >   uninstall
Uninstall an addons

Return: A boolean.

addonsId - The addons id - String - Cannot be null - Cannot be empty
1
addons.uninstall('pop3')
Successfully uninstalled.

Root   >   Server   >   Addons   >   help
Display all addons commands.

Return: A string.

1
addons.help()
addons.list() -> Show all addons downloaded.
addons.uninstall('addonsId') -> Uninstall an addons.
addons.help() -> Show this help.

Root   >   Server   >   Addons   >   classpath - (CLASS_PATH)
Get the java class path for all addons

Return: A string.

1
addons.classpath()
...

Root   >   Server   >   Addons   >   class_path
Get the java class path for all addons

Return: A string.

1
addons.class_path()
...
Root   >   Server   >   Demo
      This module contains demo ping function for module demonstration.

Root   >   Server   >   Demo   >   ping_demo_module
Return ';)'.

Return: A string.

1
ping_demo_module()
;)

Root   >   Server   >   Demo   >   test
Return ';)'.

Return: A string.

1
demo.test()
;)

Root   >   Server   >   Demo   >   add_page
Add a new source code.

Return: A string.

position - The position of the source code - Number - Cannot be null - Cannot be empty
sourceCode - The source code - String - Cannot be null - Cannot be empty
1
demo.add_page(1soaql(+(456789)))
1

Root   >   Server   >   Demo   >   generate_update
Generate the source code for update a demo page (contains SOAQL script)

Return: A string.

position - The position of the source code - Number - Cannot be null - Cannot be empty
1
demo.generate_update(1)
DEMO.update_page(1, soaql('hohoho'))

Root   >   Server   >   Demo   >   get
Get the expression (SOAQL script) of a demo page.

Return: A string.

position - The position of the source code - Number - Cannot be null - Cannot be empty
1
demo.get(1)
exe(
'//Your SOAQL commands',
concat('Hello ', [Name], ' !')
)

Root   >   Server   >   Demo   >   update_page
Update a source code.

Return: A string.

position - The position of the source code - Number - Cannot be null - Cannot be empty
sourceCode - The source code - String - Cannot be null - Cannot be empty
1
demo.update_page(1soaql(+(456789)))
1

Root   >   Server   >   Demo   >   delete_page
Delete a page into the demo.

Return: A boolean.

position - The position of the source code - Number - Cannot be null - Cannot be empty
1
demo.delete_page(1)
1

Root   >   Server   >   Demo   >   exist_page
Check if a page already exist into the demo.

Return: A boolean.

position - The position of the source code - Number - Cannot be null - Cannot be empty
1
demo.exist_page(1)
1

Root   >   Server   >   Demo   >   exist
Check if a demo already exist.

Return: A boolean.

demoId - The demo id - String - Cannot be null - Cannot be empty
1
demo.exist('demo1')
1

Root   >   Server   >   Demo   >   delete
Delete a demo.

Return: A boolean.

demoId - The demo id - String - Cannot be null - Cannot be empty
1
demo.delete('demo1')
1

Root   >   Server   >   Demo   >   next
Get the next page from the demo and load into the editor.

Return: A string.

1
demo.next()
+(456, 789)

Root   >   Server   >   Demo   >   reload
Get the current page from the demo and load into the editor.

Return: A string.

1
demo.reload()
+(456, 789)

Root   >   Server   >   Demo   >   list
Get the list of all demonstrations.

Return: A string.

1
demo.list()
[T.COL1] [T.COL2]
demo1 24

Root   >   Server   >   Demo   >   ordering
Ordering all demonstrations

Return: A number.

demoId - The demo id - String - Cannot be null - Cannot be empty
1
demo.ordering('demo1')
1

Root   >   Server   >   Demo   >   restart
Restart the current demonstration.

Return: A string.

1
demo.restart()
1

Root   >   Server   >   Demo   >   max_page
Get the max page from the demo.

Return: A string.

1
demo.max_page()
14

Root   >   Server   >   Demo   >   previous
Get the previous page from the demo and load into the editor.

Return: A string.

1
demo.previous()
+(456, 789)

Root   >   Server   >   Demo   >   set_id
Set the current demo id.

Return: A string.

demoId - The demo id - String - Cannot be null - Cannot be empty
1
demo.set_id('demo1')
1

Root   >   Server   >   Demo   >   get_id
Get the current demo id.

Return: A string.

1
demo.get_id()
demo1
Root   >   Server   >   Lang
      This module contains basic commands for manage translations.

Root   >   Server   >   Lang   >   ping_lang_module
Return ';)'.

Return: A string.

1
ping_lang_module()
;)

Root   >   Server   >   Lang   >   add
Add a new translation sentence

Return: A number.

id - The id of the translation - String - Cannot be null - Cannot be empty
lang - The language (2 letters) - String - Cannot be null - Cannot be empty
sentence - The sentence - String - Cannot be null - Cannot be empty
1
lang.add('rtd_title''en''Real time directory')
1
1
lang.add('rtd_title''fr''L\'annuaire en temps réèl')
1

Root   >   Server   >   Lang   >   count
Count all translations in the database

Return: A string.

transId - The translation id - String - Cannot be null - Cannot be empty
sentence - The sentence - String - Cannot be null - Cannot be empty
1
lang.count('''')
107

Root   >   Server   >   Lang   >   current_pool_size
Get the current size of the language pool.

Return: A number.

1
lang.current_pool_size()
45

Root   >   Server   >   Lang   >   default
Get the default language.

Return: A string.

1
lang.default()
en

Root   >   Server   >   Lang   >   delete
Delete all translation sentences

Return: A number.

id - The id of all translations - String - Cannot be null - Cannot be empty
1
lang.delete('rtd_title')
1

Root   >   Server   >   Lang   >   delete
Delete a translation sentence

Return: A number.

id - The id of all translations - String - Cannot be null - Cannot be empty
lang - The language (2 letters) - String - Cannot be null - Cannot be empty
1
lang.delete('rtd_title''en')
1

Root   >   Server   >   Lang   >   exist
Check if a translation id exist or not.

Return: A boolean.

id - The id of the translation - String - Cannot be null - Cannot be empty
1
lang.exist('rtd_title')
1

Root   >   Server   >   Lang   >   exist
Check if a translation exist or not.

Return: A boolean.

id - The id of the translation - String - Cannot be null - Cannot be empty
lang - The language (2 letters) - String - Cannot be null - Cannot be empty
1
lang.exist('rtd_title''en')
1

Root   >   Server   >   Lang   >   get
Get all translation sentences

Return: A string.

id - The id of the translation - String - Cannot be null - Cannot be empty
1
lang.get('rtd_title')
ID LANG SENTENCE
rtd_title en Real time directory
rtd_title fr L'annuaire en temps réèl

Root   >   Server   >   Lang   >   get
Get a translation sentence

Return: A string.

id - The id of the translation - String - Cannot be null - Cannot be empty
lang - The language (2 letters) - String - Cannot be null - Cannot be empty
1
lang.get('rtd_title''en')
Real time directory
1
lang.get('rtd_title''fr')
L'annuaire en temps réèl

Root   >   Server   >   Lang   >   is_loaded
Check if a translation is loaded.

Return: A boolean.

id - The id of the translation - String - Cannot be null - Cannot be empty
lang - The language (2 letters) - String - Cannot be null - Cannot be empty
1
lang.is_loaded('rtd_title''en')
0

Root   >   Server   >   Lang   >   list
Get all translations

Return: A string.

transId - The translation id - String - Cannot be null - Cannot be empty
sentence - The sentence - String - Cannot be null - Cannot be empty
page - The page to start the list (starts with 1) - Number - Can be null - Can be empty
limit - The limit - Number - Cannot be null - Cannot be empty
1
lang.list(''''''100)
ID LANG SENTENCE
ACT_SUCCESSFULLY en Action executed successfully!
ACT_SUCCESSFULLY fr Action exécuté avec succès!
ALL_R_RESERVED en All Rights Reserved

Root   >   Server   >   Lang   >   list_id
Get all id

Return: A string.

1
lang.list_id()
ID
rtd_title

Root   >   Server   >   Lang   >   list_pool
List all translations in the language pool.

Return: A string.

1
lang.list_pool()
ID LANG VALUE
rtd_title en Real time directory

Root   >   Server   >   Lang   >   max_pool_size
Get the max size of the language pool.

Return: A number.

1
lang.max_pool_size()
200

Root   >   Server   >   Lang   >   set_default
Set the default language.

Return: A string.

defaultLang - The default language - String - Cannot be null - Cannot be empty
1
lang.set_default('en')
1

Root   >   Server   >   Lang   >   set_max_pool_size
Set the max size of the language pool.

Return: A boolean.

size - The size - Number - Cannot be null - Cannot be empty
1
lang.set_max_pool_size(400)
1

Root   >   Server   >   Lang   >   unload
Unload a translation from the language pool.
Warning: This function unload from the current pool (the current node), not in all nodes in the cluster.

Return: A boolean.

id - The id of the translation - String - Cannot be null - Cannot be empty
lang - The language (2 letters) - String - Cannot be null - Cannot be empty
1
lang.unload('rtd_title''en')
1

Root   >   Server   >   Lang   >   unload_all
Unload all translations from the language pool.
Warning: This function unload from the current pool (the current node), not in all nodes in the cluster.

Return: A boolean.

1
lang.unload_all()
1

Root   >   Server   >   Lang   >   update
Update a translation sentence

Return: A number.

id - The id of the translation - String - Cannot be null - Cannot be empty
lang - The language (2 letters) - String - Cannot be null - Cannot be empty
sentence - The sentence - String - Cannot be null - Cannot be empty
1
lang.update('rtd_title''en''Real time directory')
1
1
lang.update('rtd_title''fr''L\'annuaire en temps réèl')
1
Root   >   Server   >   Log
      This module contains basic commands for control the logger.

Root   >   Server   >   Log   >   current_id
Get current log file id.

Return: A number.

1
log.current_id()
0

Root   >   Server   >   Log   >   cpu_mem
Get the CPU and MEM

Return: A number.

1
log.cpu_mem()
1

Root   >   Server   >   Log   >   save_cpu_mem
Save the max CPU and MEM into the log system

Return: A number.

1
log.save_cpu_mem()
1

Root   >   Server   >   Log   >   get_cpu_avg
Get the CPU AVG from the log system

Return: A number.

d1 - The first date - String - Cannot be null - Cannot be empty
d2 - The first date - String - Cannot be null - Cannot be empty
1
log.get_cpu_avg('2016-12-21''2016-12-21')
25

Root   >   Server   >   Log   >   get_cpu
Get the CPU from the log system

Return: A number.

d1 - The first date - String - Cannot be null - Cannot be empty
d2 - The first date - String - Cannot be null - Cannot be empty
1
log.get_cpu('2016-12-21''2016-12-21')
[1, 7, 9, 0, 78]

Root   >   Server   >   Log   >   get_mem_avg
Get the MEM AVG from the log system

Return: A number.

d1 - The first date - String - Cannot be null - Cannot be empty
d2 - The first date - String - Cannot be null - Cannot be empty
1
log.get_mem_avg('2016-12-21''2016-12-21')
[1, 7, 9, 0, 78]

Root   >   Server   >   Log   >   get_mem
Get the MEM from the log system

Return: A number.

d1 - The first date - String - Cannot be null - Cannot be empty
d2 - The first date - String - Cannot be null - Cannot be empty
1
log.get_mem('2016-12-21''2016-12-21')
[1, 7, 9, 0, 78]

Root   >   Server   >   Log   >   get_end
Get the end of a log file.

Return: A string.

fileId - The file id - Number - Cannot be null - Cannot be empty
nbLine - The number of line returned - Number - Cannot be null - Cannot be empty
1
log.get_end(log.current_id(), 10)
2015-09-13 14:32:40.236+0400: GENERATE DOC= [STORESERVER,EXIST_META] > Ok.
2015-09-13 14:32:40.236+0400: GENERATE DOC= [STORESERVER,EXIST_MODULE_ID] > Ok.
2015-09-13 14:32:40.236+0400: GENERATE DOC= [STORESERVER,META] > Ok.
2015-09-13 14:32:40.237+0400: GENERATE DOC= [STORESERVER,SET_META] > Ok.
2015-09-13 14:32:40.237+0400: GENERATE DOC= [STORESERVER,DELETE_META] > Ok.
2015-09-13 14:32:40.238+0400: GENERATE DOC= [STORESERVER,EXIST] > Ok.
2015-09-13 14:32:40.238+0400: GENERATE DOC= [STORESERVER,LIST] > Ok.
2015-09-13 14:32:40.239+0400: GENERATE DOC= [STORESERVER,GNR] > Ok.
2015-09-13 14:32:40.239+0400: GENERATE DOC= [STORESERVER,GENERATE] > Ok.

Root   >   Server   >   Log   >   max_size
Get max log size.

Return: A number.

1
log.max_size()
30

Root   >   Server   >   Log   >   ping_log_module
Return ';)'.

Return: A string.

1
ping_log_module()
;)

Root   >   Server   >   Log   >   set_max_log_size
Set the max size of the logger (Mb).

Return: A boolean.

size - The size - Number - Cannot be null - Cannot be empty
1
log.set_max_log_size(30)
1

Root   >   Server   >   Log   >   set_verbose
Set the verbose mode.

Return: A boolean.

logLevel - The log level (INFO or WARNING or ALERT or DEBUG) - String - Cannot be null - Cannot be empty
1
log.set_verbose('INFO|WARNING|ALERT|DEBUG')
1

Root   >   Server   >   Log   >   trace
Write a trace in aoql log files.

Return: A boolean.

message - The message to write - String - Cannot be null - Cannot be empty
1
trace(concat(''))
1
1
trace(concat('My message ...'))
1

Root   >   Server   >   Log   >   show
Show a process id from the cheetah logger system.

Return: A string.

processId - The processId - String - Cannot be null - Cannot be empty
1
log.show(125)
...

Root   >   Server   >   Log   >   write
Write a log into the cheetah logger system.

Return: A boolean.

mode - The mode (ALERT|WARNING|INFO|DEBUG) - String - Cannot be null - Cannot be empty
forceToWrite - A boolean to force to write the message - String - Cannot be null - Cannot be empty
status - The status (OK|KO) - String - Cannot be null - Cannot be empty
message - The message to write - String - Cannot be null - Cannot be empty
client_key - The client key - String - Can be null - Can be empty
client_val - The client value - String - Can be null - Can be empty
1
log.write('DEBUG'false'OK''Hi!'nullnull)
1

Root   >   Server   >   Log   >   trace_function
Write a trace in soaql log file only for error generated by function.

Return: A boolean.

className - The class name (example "FileManager") - String - Cannot be null - Cannot be empty
functionName - The function name where error was generated - String - Cannot be null - Cannot be empty
tag - The tag in function - String - Cannot be null - Cannot be empty
errorMessage - The message to write - String - Cannot be null - Cannot be empty
1
log.trace_function('STRING''concat''1''My message ...')
1

Root   >   Server   >   Log   >   trace_log_std
Trace a message in log files and in the standard output.

Return: A boolean.

msg - The message to trace - String - Cannot be null - Cannot be empty
1
log.trace_log_std('msg ...')
1

Root   >   Server   >   Log   >   verbose
Get the verbose mode of the SOAQL Server.

Return: A string.

1
log.verbose()
ALERT
Root   >   Server   >   Param
      This module contains basic commands for control global parameters.

Root   >   Server   >   Param   >   ping_param_module
Return ';)'.

Return: A string.

1
ping_param_module()
;)

Root   >   Server   >   Param   >   add
Add a global parameter.

Return: A boolean.

param - The parameter name - String - Cannot be null - Cannot be empty
value - The value - String - Can be null - Can be empty
1
param.add('TEST''456')
1

Root   >   Server   >   Param   >   count
Count all parameters in the database

Return: A string.

paramName - The parameter name - String - Cannot be null - Cannot be empty
1
param.count('')
107

Root   >   Server   >   Param   >   current_pool_size
Get the current size of the parameter pool.

Return: A number.

1
param.current_pool_size()
45

Root   >   Server   >   Param   >   delete
Delete a global parameter.

Return: A boolean.

param - The parameter name - String - Cannot be null - Cannot be empty
1
param.delete('TEST')
1
1
param.add('TEST'123)
1

Root   >   Server   >   Param   >   exist
Check if a global parameter exist.

Return: A boolean.

param - The parameter name - String - Cannot be null - Cannot be empty
1
param.exist('TEST')
0
1
param.exist('YEAR')
1

Root   >   Server   >   Param   >   config_file
Get the configuration file

Return: A string.

1
param.config_file()
...

Root   >   Server   >   Param   >   set_config_file
Set the configuration file

Return: A boolean.

configFile - The config file - String - Cannot be null - Cannot be empty
1
param.set_config_file(config_file())
1

Root   >   Server   >   Param   >   get_param
Load from the database a global parameter in the pool and return it.

Return: A value.

param - The parameter name - String - Cannot be null - Cannot be empty
1
get_param('SESSION_TIMEOUT')
600000

Root   >   Server   >   Param   >   is_param
Check if a string is a valid parameter name.

Return: A boolean

paramName - The parameter name - String - Can be null - Can be empty
1
param.is_param('VAR')
1
1
param.is_param(null)
0
1
param.is_param('VAR-JK')
0
1
param.is_param('VAR_JK')
1

Root   >   Server   >   Param   >   list
Display all global parameters

Return: A string.

1
param.list()
PARAMETER VALUE
BACKUP_PATH /home/Data-Prisme/Bureau/SOAQLServer/backups
BACKUP_RETENTION_DAY 5
CPM_DB_ADVANTAGE 7
CPM_DB_DB2 5
CPM_DB_DERBY 11...

Root   >   Server   >   Param   >   list
Display all global parameters

Return: A string.

paramName - The parameter name - String - Cannot be null - Cannot be empty
page - The page to start the list (starts with 1) - Number - Can be null - Can be empty
limit - The limit - Number - Cannot be null - Cannot be empty
1
param.list(''''100)
PARAMETER VALUE
BACKUP_PATH /home/Data-Prisme/Bureau/SOAQLServer/backups
BACKUP_RETENTION_DAY 5
CPM_DB_ADVANTAGE 7
CPM_DB_DB2 5
CPM_DB_DERBY 11

Root   >   Server   >   Param   >   list_pool
List all parameters in the parameter pool.

Return: A string.

1
param.list_pool()
PARAMETER VALUE
VERSION 1.0_u6
SESSION_TIMEOUT 600000
RAM_MAX_PARAM 200

Root   >   Server   >   Param   >   max_pool_size
Get the max size of the parameter pool.

Return: A number.

1
param.max_pool_size()
200

Root   >   Server   >   Param   >   set_max_pool_size
Set the max size of the parameter pool.

Return: A boolean.

size - The size - Number - Cannot be null - Cannot be empty
1
param.set_max_pool_size(400)
1

Root   >   Server   >   Param   >   unload
Unload a parameter from the parameter pool.
Warning: This function unload from the current pool (the current node), not in all nodes in the cluster.

Return: A boolean.

param - The parameter name - String - Cannot be null - Cannot be empty
1
param.unload('YEAR')
1

Root   >   Server   >   Param   >   unload_all
Unload all parameters from the parameter pool.
Warning: This function unload from the current pool (the current node), not in all nodes in the cluster.

Return: A boolean.

1
param.unload_all()
1

Root   >   Server   >   Param   >   update
Update a global parameter.

Return: A boolean.

param - The parameter name - String - Cannot be null - Cannot be empty
value - The value - String - Can be null - Can be empty
1
param.update('TEST''789')
1

Root   >   Server   >   Param   >   get_seq
Increment and get a sequence number.

Return: A boolean.

param - The parameter name - String - Cannot be null - Cannot be empty
increment - The increment - Number - Can be null - Can be empty
1
param.get_seq('TEST'1)
1
Root   >   Server   >   Server
      This module contains basic commands for control the SOAQL Server with the monitor.

Root   >   Server   >   Server   >   ping_server_module
Return ';)'.

Return: A string.

1
ping_server_module()
;)

Root   >   Server   >   Server   >   loaded_modules
List all loaded modules.

Return: A string.

1
server.loaded_modules()
ID
STATEMENT
CPM
EXAMPLE1
AGGREG
HTML
EXAMPLE2
CONTEXT
DATAPRISME
COMPRESS
BACKUP
MAIL

Root   >   Server   >   Server   >   msgbox
Display a message box and wait ...

Return: A string.

title - The title - String - Can be null - Can be empty
msg - The message - String - Can be null - Can be empty
1
msgbox('title''msg')
1

Root   >   Server   >   Server   >   wait
Wait the current thread

Return: A boolean.

time - The time in millisecond - String - Cannot be null - Cannot be empty
1
wait(10000)
1

Root   >   Server   >   Server   >   about
Display 'About' information.

Return: A string.

1
server.about()
SOAQL Server
Version: 2.2_u06
Data-Prisme - Copyright (c) 2004-2015.
http://www.data-prisme.com - contact@data-prisme.com

Root   >   Server   >   Server   >   allow_remote_connect
Return 1 if the server allow remote connection, else 0.

Return: A boolean.

1
server.allow_remote_connect()
1

Root   >   Server   >   Server   >   author
Display the author of the SOAQL Server.

Return: A string.

1
server.author()
Data-Prisme - Copyright (c) 2004-2015.

Root   >   Server   >   Server   >   database
Return MySQL if the database is not embedded, else MXJ.

Return: A boolean.

1
server.database()
MySQL

Root   >   Server   >   Server   >   default_port
Display the default port of the SOAQL Server (this node).

Return: A number.

1
server.default_port()
4444

Root   >   Server   >   Server   >   soaql
Return the string version of the SOAQL command.

Return: A string.

command - The command - String - Can be null - Can be empty
1
soaql(name())
name()

Root   >   Server   >   Server   >   disconnect
Disconnect a user from an SOAQL Server (and close the monitor or editor).

Return: A code for disconnect the user.

1
disconnect()
Disconnected.
1
server.disconnect()
Disconnected.

Root   >   Server   >   Server   >   edition
Get the edition of the server.

Return: A string.

1
server.edition()
Corporate

Root   >   Server   >   Server   >   eval
Eval an soaql expression.

Return: A string.

str - The expression in string - String - Can be null - Can be empty
1
SERVER.eval('concat(123, 456)')
123456
1
set_var('[NAME]''Bob')
Bob
1
set_var('[SOAQLCommand]''concat(\'Hello \', [NAME], \'!\')')
concat('Hello ', [NAME], '!')
1
SERVER.eval([SOAQLCommand])
Hello Bob!
1
2
3
4
5
exe(
  set_var('[NAME]''Bob'),
  set_var('[SOAQLCommand]''concat(\'Hello \', [NAME], \'!\')'),
  SERVER.eval([SOAQLCommand])
)
Hello Bob!
1
SERVER.eval('')
1

Root   >   Server   >   Server   >   exit - (disconnect)
Disconnect a user from an SOAQL Server (and close the monitor or editor).

Return: A code for disconnect the user.

1
exit()
Disconnected.
1
server.exit()
Disconnected.

Root   >   Server   >   Server   >   good_to_know
Good to know.

Return: A string.

1
server.good_to_know()
SOAQL (Oriented Architecture Query Language) = Mixture of SOA and SQL/NoSQL.
Goals in 5 lines :
- Propose an architecture ...
- For connecting ...
- In an easy way ...
- All business data ...
- In the world ...

Root   >   Server   >   Server   >   hello
Display 'Hello world!'.

Return: A string.

1
server.hello()
Hello world!

Root   >   Server   >   Server   >   help
Return the basic help commands.

Return: A string.

1
help()
Contact:
- Data-Prisme - Reunion Island, www.data-prisme.com, contact@data-prisme.com
Documentation in HTML:
- http://localhost:8080/docs (When your server is started ...)
Basic commands:
Editor
- Enter your SOAQL query and clic on Execute button
- [Ctrl]+[E]: Execute the query
- [Ctrl]+[Q]: Move the query focus
- [Ctrl]+[C]: Copy
- [Ctrl]+[X]: Cut
- [Ctrl]+[V]: Paste
- [Ctrl]+[R]: Indent to the right
- [Ctrl]+[L]: Indent to the left
- [Ctrl]+[U]: Move up
- [Ctrl]+[D]: Move down
- [Ctrl]+[Z]: Undo
- [Ctrl]+[Y]: Redo
Main functions
- help(): Display this help
- man() | man('class.function.'): Display the manual
- shutdown(): Shutdown the server (only user with 'System' rights)
- exit(): Disconnect the user
- server.author(): Author information
- about(): Server information

Root   >   Server   >   Server   >   manc
Return the number of created functions.

Return: A number.

1
manc()
500

Root   >   Server   >   Server   >   man
Return the manual.

Return: A string.

pattern - The pattern to find in the manual (example: 'math.abs.txt') - String - Cannot be null - Can be empty
1
man('')
...

Root   >   Server   >   Server   >   search
Search in the manual.

Return: A string.

pattern - The pattern to find in the manual (example: 'math.abs.txt') - String - Cannot be null - Can be empty
1
search('pop')
Nb=47
aggreg. |aggreg_pro. |atom. |backup. |basic_val.
cluster. |compress. |console. |constant.
container. |context. |cpm. |date. |db.
env. |example1. |example2. |exception. |file.
geoloc. |group. |html. |json. |mail.
math. |mongodb. |soaql. |operator. |port.
sage. |scheduler. |sensor. |server. |setup.
stack. |statement. |string. |transaction. |tree.
tunnel30. |type. |user. |vhost. |web.
webserver.

Root   >   Server   >   Server   >   id
Get the id of the server (Examples: 1, 2 ...).

Return: A number.

1
server.id()
1

Root   >   Server   >   Server   >   in_editor
Execute a command and keep the result in the query editor.

Return: A string.

1
in_editor('Hi!')
Hi!

Root   >   Server   >   Server   >   in_container
Execute a command and keep the result in the container editor.

Return: A string.

1
in_container('Hi!')
Hi!

Root   >   Server   >   Server   >   is_embedded
Return 1 if the database is embedded, else 0.

Return: A boolean.

1
server.is_embedded()
1

Root   >   Server   >   Server   >   is_manager
Return 1 if the server is a manager, else 0.

Return: A boolean.

1
server.is_manager()
1

Root   >   Server   >   Server   >   is_secure
Return 1 if the server is securized, else 0.

Return: A boolean.

1
server.is_secure()
1

Root   >   Server   >   Server   >   kill
Kill a session in the SOAQL Server.
Only user in 'System' group can kill a session in the server.

Return: A boolean.

connectionId - The connection id - Number - Cannot be null - Cannot be empty
1
server.kill(3)
1

Root   >   Server   >   Server   >   local_host
Get the local hostname.

Return: A string.

1
local_host()
localhost

Root   >   Server   >   Server   >   local_ip
Get the local IP.

Return: A string.

1
local_ip()
127.0.0.1

Root   >   Server   >   Server   >   local_port
Get the local port.

Return: A string.

1
local_port()
4444

Root   >   Server   >   Server   >   reset
Reset a server.

Return: A string.

generateAll - Generate all - String - Cannot be null - Cannot be empty
1
server.reset(true)
Update password for ...

Root   >   Server   >   Server   >   major_version
Get the major version of the SOAQL Server.

Return: A number.

1
server.major_version()
1

Root   >   Server   >   Server   >   max_session
Get the max SOAQL session number.

Return: A number.

1
server.max_session()
80

Root   >   Server   >   Server   >   minor_version
Get the minor version of the SOAQL Server.

Return: A number.

1
server.minor_version()
3

Root   >   Server   >   Server   >   name
Get the name of the server.

Return: A string.

1
server.name()
titi/node1
1
name()
titi/node1

Root   >   Server   >   Server   >   name1
Get the first name of the server.

Return: A string.

1
server.name1()
titi

Root   >   Server   >   Server   >   name2
Get the second name of the server.

Return: A string.

1
server.name2()
node1

Root   >   Server   >   Server   >   nb_agents
Get the number of open agent (thread killer) on the server.

Return: A number.

1
server.nb_agents()
5

Root   >   Server   >   Server   >   nb_connections
Get the number of connections on the server (count all, since server startup).

Return: A number.

1
server.nb_connections()
326

Root   >   Server   >   Server   >   nb_exceeded_sessions
Return the number of exceeded sessions increment

Return: A number.

1
server.nb_exceeded_sessions()
0

Root   >   Server   >   Server   >   nb_sessions
Get the number of open session on the server.

Return: A number.

1
server.nb_sessions()
5

Root   >   Server   >   Server   >   process_id
Get the java process id.

Return: A number.

1
server.process_id()
32125

Root   >   Server   >   Server   >   pid - (PROCESS_ID)
Get the java process id.

Return: A number.

1
server.pid()
32125

Root   >   Server   >   Server   >   remote_host
Get the local hostname.

Return: A string.

1
remote_host()
localhost

Root   >   Server   >   Server   >   remote_ip
Get the local IP.

Return: A string.

1
remote_ip()
127.0.0.1

Root   >   Server   >   Server   >   remote_port
Get the local port.

Return: A string.

1
remote_port()
39665

Root   >   Server   >   Server   >   reset_nb_exceeded_sessions
Reset the number of exceeded sessions increment

Return: A number.

1
server.reset_nb_exceeded_sessions()
1

Root   >   Server   >   Server   >   restart
Restart the server

Return: A number.

1
server.restart()
1

Root   >   Server   >   Server   >   session_cnt_read_timeout
Get the global session connect read timeout in millisecond.

Return: A number.

1
server.session_cnt_read_timeout()
10000

Root   >   Server   >   Server   >   session_id
Get the connection id of the current user connection.

Return: A number.

1
session_id()
12

Root   >   Server   >   Server   >   session_timeout
Get the global session timeout in millisecond.

Return: A number.

1
server.session_timeout()
600000

Root   >   Server   >   Server   >   sessions
Get session state of the SOAQL Server.

Return: A string.

1
server.sessions()
USER SESSIONID TIMEOUT RESTRICTED
soaql 0 2/600s false

Root   >   Server   >   Server   >   set_max_session
Set the max SOAQL session number.

Return: A boolean.

max - The max SOAQL session number - Number - Cannot be null - Cannot be empty
1
server.set_max_session(100)
1

Root   >   Server   >   Server   >   set_session_cnt_read_timeout
Set the global session connect read timeout.

Return: A boolean.

time - The time in millisecond - Number - Cannot be null - Cannot be empty
1
server.set_session_cnt_read_timeout(20000)
1
1
server.session_cnt_read_timeout()
20000
1
server.set_session_cnt_read_timeout(10000)
1
1
server.session_cnt_read_timeout()
10000

Root   >   Server   >   Server   >   set_session_timeout
Set the global session timeout.

Return: A boolean.

time - The time in millisecond - Number - Cannot be null - Cannot be empty
1
server.set_session_timeout(900000)
1
1
server.session_timeout()
900000
1
server.set_session_timeout(600000)
1
1
server.session_timeout()
600000

Root   >   Server   >   Server   >   set_verbose - (LOG.set_verbose)
Set the verbose mode.

Return: A boolean.

bool - The boolean - Number - Cannot be null - Cannot be empty
1
server.set_verbose('INFO|WARNING|ALERT|DEBUG')
1

Root   >   Server   >   Server   >   uuid
Get the cheetah UUID of the server.

Return: A string.

1
server.uuid()
ce41334d-d477-40ed-819c-5db843089341

Root   >   Server   >   Server   >   sha
Get the cheetah UUID of the server.

Return: A string.

1
server.sha()
ce41334d-d477-40ed-819c-5db843089341

Root   >   Server   >   Server   >   set_version
Set the version of the server.

Return: A boolean.

version - The version - String - Cannot be null - Cannot be empty
1
server.set_version('2.2u09')
1

Root   >   Server   >   Server   >   shutdown
Shutdown the SOAQL Server (and close the monitor or editor).
Only user in 'System' group can shutdown the server.

Return: A code for stop the server and disconnect the user.

1
server.shutdown()
Disconnected.
1
shutdown()
Disconnected.

Root   >   Server   >   Server   >   start_timestamp
Get the timestamp when the server was started.

Return: A string.

1
server.start_timestamp()
2014-02-04 17:20:37

Root   >   Server   >   Server   >   type
Get the type of the server (Examples: node or agent).

Return: A string.

1
server.type()
node

Root   >   Server   >   Server   >   verbose - (LOG.verbose)
Get the verbose mode of the SOAQL Server.

Return: A boolean.

1
server.verbose()
1

Root   >   Server   >   Server   >   version
Get the version of the SOAQL Server.

Return: A string.

1
server.version()
1.0_u4

Root   >   Server   >   Server   >   year
Get the year associate with the version of the SOAQL Server.

Return: A number.

1
server.year()
2014
Root   >   Server   >   Soaql
      This module contains basic commands for SOAQL source code manipulation.

Root   >   Server   >   Soaql   >   count_expr
Return a number of expression in an SOAQL source code

Return: A number.

soaqlCommandsN - A list of SOAQL command - String - Can be null - Can be empty
1
soaql.count_expr(123'jkl'12)
3
1
soaql.count_expr()
1
1
soaql.count_expr(null)
1

Root   >   Server   >   Soaql   >   html
Return a HTML source code for display an SOAQL source code

Return: A string.

mainExpression - SOAQL command - String - Cannot be null - Cannot be empty
connectedUser - The connected user - String - Cannot be null - Cannot be empty
mainExpression - The connected server - String - Cannot be null - Cannot be empty
width - The width - Number - Cannot be null - Cannot be empty
height - The height - Number - Can be null - Cannot be empty
1
soaql.html('name()''soaql''node1''1000''500')
<div style='line-height:18px;font-family:monospaceoverflow-y:auto;height:500px;'><div style='float:left;color:#999;width:30px;background-color:#f0f0f0;border: 1px #e9e9e9 solid;text-align:right;padding:5px 5px 5px 0px;'>1</div><div style='float:left;padding:5px;background-color:#fff;border: 1px #e9e9e9 solid;overflow-x:auto;width:1000px;'><div style='white-space:nowrap;position:relative;'><span style='color:#003dc8'>name</span>()</div></div></div><div style='clear:left;'></div>

Root   >   Server   >   Soaql   >   is_args_string
Return a 1 if all arguments are only strings (not a function), else 0

Return: A number.

soaqlCommandsN - A list of SOAQL command - String - Can be null - Can be empty
1
soaql.is_args_string('123''jkl''12')
0
1
soaql.is_args_string('\'123\'')
1

Root   >   Server   >   Soaql   >   is_valid_connection
Return a 1 if all arguments are only strings (not a function) and size = 3, else 0

Return: A number.

soaqlCommandsN - A list of SOAQL command - String - Can be null - Can be empty
1
soaql.is_valid_connection('123''jkl''12')
1

Root   >   Server   >   Soaql   >   ping_soaql_module
Return ';)'.

Return: A string.

1
ping_soaql_module()
;)
Root   >   Server   >   Tmp
      This module contains basic commands for manage tmp directory.

Root   >   Server   >   Tmp   >   count
Count all files or directories in tmp directory.

Return: A number.

1
tmp.count()
5

Root   >   Server   >   Tmp   >   delete_all
Delete all files or directory in the tmp directory.

Return: A string.

1
tmp.delete_all()
5

Root   >   Server   >   Tmp   >   delete_process
Delete all files with retention day in the tmp directory.

Return: A string.

1
tmp.delete_process()
5

Root   >   Server   >   Tmp   >   list
Get the list of file or directory in the tmp directory.

Return: A string.

1
tmp.list()
FILE_OR_DIR LAST_MODIFIED
jpayet.zip 1409488047000

Root   >   Server   >   Tmp   >   retention_day
Get the delete retention day from the database.

Return: A number.

1
tmp.retention_day()
5

Root   >   Server   >   Tmp   >   set_retention_day
Set the delete retention day.

Return: A number.

retention - The retention day - Number - Cannot be null - Cannot be empty
1
tmp.set_retention_day(5)
1
1
tmp.set_retention_day(null)
SOAQL function: The retention day cannot be null or empty (tmp.set_retention_day).
1
tmp.set_retention_day('')
SOAQL function: The retention day cannot be null or empty (tmp.set_retention_day).
1
tmp.set_retention_day('zer')
SOAQL function: The retention day must be a number (tmp.set_retention_day).
Root   >   Data manipulation
Root   >   Data manipulation   >   Atom
      This module contains basic commands for manage atom in a list.

Root   >   Data manipulation   >   Atom   >   before_exclud
Get the atom list before the first occurrence of an atom in an atom list (excluded atom).

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
index - The index atom - Number - Cannot be null - Cannot be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.before_exclud(' A, B,A ,A ,C, D ''3'',')
A, B
1
atom.before_exclud(' A, B,A ,A ,C, D ''1'',')

1
atom.before_exclud(' A, B,A ,A ,C, D ''0'',')
null
1
atom.before_exclud(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.before_exclud(null'D'',')
null
1
atom.before_exclud(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   before_includ
Get the atom list before the first occurrence of an atom in an atom list (included atom).

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
index - The index atom - Number - Cannot be null - Cannot be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.before_includ(' A, B,A ,A ,C, D ''3'',')
 A, B,A 
1
atom.before_includ(' A, B,A ,A ,C, D ''1'',')
A
1
atom.before_includ(' A, B,A ,A ,C, D ''0'',')
null
1
atom.before_includ(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.before_includ(null'D'',')
null
1
atom.before_includ(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   count
Count the occurrence number of an atom in an atom list.

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
atomToCount - The atom to search - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.count(' A, B,A ,A ,C, D ''A '',')
2
1
atom.count(' A, B,A ,A ,C, D ''Z'',')
0
1
atom.count(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.count(null'D'',')
null
1
atom.count(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   count_distinct
Count the occurrence number of a distinct atom in an atom list.

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
atomToCount - The atom to search - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.count_distinct(' A, B,A ,A ,C, D ''A '',')
1
1
atom.count_distinct(' A, B,A ,A ,C, D ''Z'',')
0
1
atom.count_distinct(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.count_distinct(null'D'',')
null
1
atom.count_distinct(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   count_lrtrim
Count the occurrence number of a lrtrim atom in an atom list.

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
atomToCount - The atom to search - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.count_lrtrim(' A, B,A ,A ,C, D ''A '',')
3
1
atom.count_lrtrim(' A, B,A ,A ,C, D ''Z'',')
0
1
atom.count_lrtrim(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.count_lrtrim(null'D'',')
null
1
atom.count_lrtrim(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   count_lrtrim_distinct
Count the occurrence number of a lrtrim distinct atom in an atom list.

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
atomToCount - The atom to search - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.count_lrtrim_distinct(' A, B,A ,A ,C, D ''A '',')
1
1
atom.count_lrtrim_distinct(' A, B,A ,A ,C, D ''Z'',')
0
1
atom.count_lrtrim_distinct(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.count_lrtrim_distinct(null'D'',')
null
1
atom.count_lrtrim_distinct(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   distinct
Get distinct atom for each atom in a list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.distinct('A,B,A,A ,C,D'',')
A,B,A ,C,D
1
atom.distinct('A,B,A,A ,C,D'null)
null
1
atom.distinct(null',')
null
1
atom.distinct('A,B,A,A ,C,D''az')
null

Root   >   Data manipulation   >   Atom   >   distinct_lrtrim
Get lrtrim distinct atom for each atom in a list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.distinct_lrtrim(' A, B,A ,A ,C, D '',')
A,B,C,D
1
atom.distinct_lrtrim(' A, B,A ,A ,C, D 'null)
null
1
atom.distinct_lrtrim(null',')
null
1
atom.distinct_lrtrim(' A, B,A ,A ,C, D ''az')
null

Root   >   Data manipulation   >   Atom   >   distinct_lrtrim_1sbefore
Get lrtrim distinct atom for each atom in a list. Add one space before all atoms, except the first.

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.distinct_lrtrim_1sbefore(' A, B,A ,A ,C, D '',')
A, B, C, D
1
atom.distinct_lrtrim_1sbefore(' A, B,A ,A ,C, D 'null)
null
1
atom.distinct_lrtrim_1sbefore(null',')
null
1
atom.distinct_lrtrim_1sbefore(' A, B,A ,A ,C, D ''az')
null

Root   >   Data manipulation   >   Atom   >   find
Find the position of atom in an atom list.

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
atomToFind - The atom to search - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.find(' A, B,A ,A ,C, D ''A '',')
3
1
atom.find(' A, B,A ,A ,C, D ''Z'',')
0
1
atom.find(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.find(null'D'',')
null
1
atom.find(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   find_lrtrim
Find the position of atom in an atom list. lrtrim on each atom before.

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
atomToFind - The atom to search - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.find_lrtrim(' A, B,A ,A ,C, D ''A '',')
1
1
atom.find_lrtrim(' A, B,A ,A ,C, D ''Z'',')
0
1
atom.find_lrtrim(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.find_lrtrim(null'D'',')
null
1
atom.find_lrtrim(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   get
Get atom at the specific index in an atom list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
index - Position of the atom (start to 1) - Number - Cannot be null - Cannot be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.get('A,B,C,D'2',')
B
1
atom.get('A,B,C,D'1',')
A
1
atom.get('A,B,C,D'4',')
D
1
atom.get('A,B,C,D'5',')
null
1
atom.get('A,B,C,D'0',')
null
1
atom.get('A,B,C,D''r'',')
null
1
atom.get('A,B,C,D'null',')
null
1
atom.get('A,B,C,D'2'az')
null

Root   >   Data manipulation   >   Atom   >   get_first
Get the first atom in an atom list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.get_first('A, B ,C,D'',')
A
1
atom.get_first('A,B,C,D'null)
null
1
atom.get_first('A,B,C,D''az')
null

Root   >   Data manipulation   >   Atom   >   get_first_lrtrim
Get the first lrtrim atom in an atom list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.get_first_lrtrim(' A, B ,C,D'',')
A
1
atom.get_first_lrtrim('A,B,C,D'null)
null
1
atom.get_first_lrtrim('A,B,C,D''az')
null

Root   >   Data manipulation   >   Atom   >   get_last
Get the last atom in an atom list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.get_last('A, B ,C,D'',')
D
1
atom.get_last('A,B,C,D'null)
null
1
atom.get_last('A,B,C,D''az')
null

Root   >   Data manipulation   >   Atom   >   get_last_lrtrim
Get the last lrtrim atom in an atom list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.get_last_lrtrim(' A, B ,C, D'',')
D
1
atom.get_last_lrtrim('A,B,C,D'null)
null
1
atom.get_last_lrtrim('A,B,C,D''az')
null

Root   >   Data manipulation   >   Atom   >   get_lrtrim
Get lrtrim atom at the specific index in an atom list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
index - Position of the atom (start to 1) - Number - Cannot be null - Cannot be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.get_lrtrim('A, B ,C,D'2',')
B
1
atom.get_lrtrim(' A,B,C,D'1',')
A
1
atom.get_lrtrim('A,B,C, D'4',')
D
1
atom.get_lrtrim('A,B,C,D'5',')
null
1
atom.get_lrtrim('A,B,C,D'0',')
null
1
atom.get_lrtrim('A,B,C,D''r'',')
null
1
atom.get_lrtrim('A,B,C,D'null',')
null
1
atom.get_lrtrim('A,B,C,D'2'az')
null

Root   >   Data manipulation   >   Atom   >   lrtrim
Get lrtrim atom for each atom in a list

Return: A string

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.lrtrim(' A, B,A ,A ,C, D '',')
A,B,A,A,C,D
1
atom.lrtrim(' A, B,A ,A ,C, D 'null)
null
1
atom.lrtrim(null',')
null
1
atom.lrtrim(' A, B,A ,A ,C, D ''az')
null

Root   >   Data manipulation   >   Atom   >   ping_atom_module
Return ';)'.

Return: A string.

1
ping_atom_module()
;)

Root   >   Data manipulation   >   Atom   >   position - (FIND)
Find the position of atom in an atom list.

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
atomToFind - The atom to search - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.position(' A, B,A ,A ,C, D ''A '',')
3
1
atom.position(' A, B,A ,A ,C, D ''Z'',')
0
1
atom.position(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.position(null'D'',')
null
1
atom.position(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   position_lrtrim - (FIND_LRTRIM)
Find the position of atom in an atom list. lrtrim on each atom before.

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
atomToFind - The atom to search - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.position_lrtrim(' A, B,A ,A ,C, D ''A '',')
1
1
atom.position_lrtrim(' A, B,A ,A ,C, D ''Z'',')
0
1
atom.position_lrtrim(' A, B,A ,A ,C, D ''A 'null)
null
1
atom.position_lrtrim(null'D'',')
null
1
atom.position_lrtrim(' A, B,A ,A ,C, D ''D''az')
null

Root   >   Data manipulation   >   Atom   >   size
Get size atom of an atom list (size >=1)

Return: A number

atomList - Atom list (example A,B,C) - String - Cannot be null - Can be empty
separator - List Separator (in this example ','), 1 CHAR MAX - Number - Cannot be null - Cannot be empty
1
atom.size('A,B,C,D'',')
4
1
atom.size('A,B,C,D''=')
1
1
atom.size('A''=')
1
1
atom.size('''=')
1
1
atom.size(null'=')
null
1
atom.size('k'null)
null
1
atom.size('k''az')
null
Root   >   Data manipulation   >   Constant
      This module contains basic commands for constant functions.

Root   >   Data manipulation   >   Constant   >   math_four_pi
Holds 4*pi.

Return: A string.

1
constant.math_four_pi()
(12.5663706143591725 ± 8.9E-16) 

Root   >   Data manipulation   >   Constant   >   math_half_pi
Holds pi/2.

Return: A string.

1
constant.math_half_pi()
(1.5707963267948966 ± 1.1E-16) 

Root   >   Data manipulation   >   Constant   >   math_pi
Holds the ratio of the circumference of a circle to its diameter.

Return: A string.

1
constant.math_pi()
(3.1415926535897931 ± 2.2E-16) 

Root   >   Data manipulation   >   Constant   >   math_pi_square
Holds pi^2.

Return: A string.

1
constant.math_pi_square()
(9.869604401089358 ± 8.9E-16) 

Root   >   Data manipulation   >   Constant   >   math_two_pi
Holds 2*pi.

Return: A string.

1
constant.math_two_pi()
(6.2831853071795862 ± 4.4E-16) 

Root   >   Data manipulation   >   Constant   >   physics_a0
Holds the Bohr radius (α/(4π·Rinf))

Return: A string.

1
constant.physics_a0()
(5.291772E-11 ± 1.8E-17) m

Root   >   Data manipulation   >   Constant   >   physics_amu
Holds the unified atomic mass unit (0.001 kg/mol)/N

Return: A string.

1
constant.physics_amu()
(1.6605389E-27 ± 2.8E-34) kg

Root   >   Data manipulation   >   Constant   >   physics_bohr_magneton
Holds the Bohr magneton (ℏ·e/2me)

Return: A string.

1
constant.physics_bohr_magneton()
(9.274009E-24 ± 4.0E-30) C·J·s/kg

Root   >   Data manipulation   >   Constant   >   physics_c
Holds the speed of light in vacuum (exact).

Return: A string.

1
constant.physics_c()
299792458 m/s

Root   >   Data manipulation   >   Constant   >   physics_c_square
Holds c^2.

Return: A string.

1
constant.physics_c_square()
89875517873681764 m²/s²

Root   >   Data manipulation   >   Constant   >   physics_e
Holds the elementary charge (positron charge).

Return: A string.

1
constant.physics_e()
(1.6021765E-19 ± 1.4E-26) C

Root   >   Data manipulation   >   Constant   >   physics_eh
Holds the Hartree energy (2Rinf·h·c)

Return: A string.

1
constant.physics_eh()
(4.3597442E-18 ± 7.2E-25) J

Root   >   Data manipulation   >   Constant   >   physics_f
Holds the Faraday constant (N·e)

Return: A string.

1
constant.physics_f()
(96485.34 ± 0.024) C/mol

Root   >   Data manipulation   >   Constant   >   physics_fine_structure
Holds the fine structure constant (e²/(2·ε0·c·h))

Return: A string.

1
constant.physics_fine_structure()
(0.007297353 ± 2.5E-9) 

Root   >   Data manipulation   >   Constant   >   physics_g
Holds the standard acceleration due to gravity (approximately equal to the acceleration due to gravity on the Earth's surface).

Return: A string.

1
constant.physics_g()
(9.8066499999999976 ± 8.9E-16) m/s²

Root   >   Data manipulation   >   Constant   >   physics_g0
Holds the conductance quantum (2e²/h)

Return: A string.

1
constant.physics_g0()
(0.00007748092 ± 2.6E-11) S

Root   >   Data manipulation   >   Constant   >   physics_k
Holds the Boltzmann constant.

Return: A string.

1
constant.physics_k()
(1.380651E-23 ± 2.4E-29) J/K

Root   >   Data manipulation   >   Constant   >   physics_lp
Holds the Planck length (ℏ/(mP·c))

Return: A string.

1
constant.physics_lp()
(1.6162E-35 ± 1.2E-39) m

Root   >   Data manipulation   >   Constant   >   physics_m_deuteron
Holds the deuteron rest mass.

Return: A string.

1
constant.physics_m_deuteron()
(3.3435833E-27 ± 5.7E-34) kg

Root   >   Data manipulation   >   Constant   >   physics_m_electron
Holds the electron rest mass.

Return: A string.

1
constant.physics_m_electron()
(9.109383E-31 ± 1.6E-37) kg

Root   >   Data manipulation   >   Constant   >   physics_m_muon
Holds the muon rest mass.

Return: A string.

1
constant.physics_m_muon()
(1.8835314E-28 ± 3.3E-35) kg

Root   >   Data manipulation   >   Constant   >   physics_m_neutron
Holds the neutron rest mass.

Return: A string.

1
constant.physics_m_neutron()
(1.6749273E-27 ± 2.9E-34) kg

Root   >   Data manipulation   >   Constant   >   physics_m_proton
Holds the proton rest mass.

Return: A string.

1
constant.physics_m_proton()
(1.6726217E-27 ± 2.9E-34) kg

Root   >   Data manipulation   >   Constant   >   physics_magn_flux_quantum
Holds the magnetic flux quantum (h/2e)

Return: A string.

1
constant.physics_magn_flux_quantum()
(2.0678337E-15 ± 5.2E-22) Wb

Root   >   Data manipulation   >   Constant   >   physics_mp
Holds the Planck mass (ℏ·c/G)1/2

Return: A string.

1
constant.physics_mp()
(2.1765E-8 ± 1.6E-12) kg

Root   >   Data manipulation   >   Constant   >   physics_n
Holds the Avogadro constant.

Return: A string.

1
constant.physics_n()
(6.022142E23 ± 1.0E17) 1/mol

Root   >   Data manipulation   >   Constant   >   physics_newtonian_g
Holds the Newtonian constant of gravitation.

Return: A string.

1
constant.physics_newtonian_g()
(6.674E-11 ± 1.0E-14) m³/(kg·s²)

Root   >   Data manipulation   >   Constant   >   physics_nuclear_magneton
Holds the nuclear magneton (ℏ·e/2mp)

Return: A string.

1
constant.physics_nuclear_magneton()
(5.050783E-27 ± 2.2E-33) C·J·s/kg

Root   >   Data manipulation   >   Constant   >   physics_perm_vac_electric
Holds the permeability of vacuum or electric constant.

Return: A string.

1
constant.physics_perm_vac_electric()
(8.854187817620389E-12 ± 2.4E-27) A²·s²/(N·m²)

Root   >   Data manipulation   >   Constant   >   physics_perm_vac_magnetic
Holds the permeability of vacuum or magnetic constant.

Return: A string.

1
constant.physics_perm_vac_magnetic()
(0.0000012566370614359171 ± 1.1E-22) N/A²

Root   >   Data manipulation   >   Constant   >   physics_planck
Holds the Planck constant.

Return: A string.

1
constant.physics_planck()
(6.626069E-34 ± 1.1E-40) J·s

Root   >   Data manipulation   >   Constant   >   physics_planck_over_two_pi
Holds the Planck constant over 2*pi.

Return: A string.

1
constant.physics_planck_over_two_pi()
(1.0545717E-34 ± 1.8E-41) J·s

Root   >   Data manipulation   >   Constant   >   physics_r
Holds the molar gas constant (N·k)

Return: A string.

1
constant.physics_r()
(8.31447 ± 0.000016) J/(mol·K)

Root   >   Data manipulation   >   Constant   >   physics_rinf
Holds the Rydberg constant (α²·me·c/2h).

Return: A string.

1
constant.physics_rinf()
(1.097373156852E7 ± 0.000073) 1/m

Root   >   Data manipulation   >   Constant   >   physics_stefan_boltzmann
Holds the Stefan-Boltzmann constant ((π²/60)·k4/(ℏ³·c²))

Return: A string.

1
constant.physics_stefan_boltzmann()
(5.6704E-8 ± 4.2E-13) J/(K^4·s·m²)

Root   >   Data manipulation   >   Constant   >   physics_tp
Holds the Planck time (lP/c)

Return: A string.

1
constant.physics_tp()
(5.3912E-44 ± 4.1E-48) s

Root   >   Data manipulation   >   Constant   >   physics_z0
Holds the characteristic impedance of vacuum (µ0·c).

Return: A string.

1
constant.physics_z0()
(376.73031346177061 ± 2.8E-14) Ω

Root   >   Data manipulation   >   Constant   >   ping_constant_module
Return ';)'.

Return: A string.

1
ping_constant_module()
;)
Root   >   Data manipulation   >   Date
      This module contains string basic commands for date management.

Root   >   Data manipulation   >   Date   >   add
Add a number to a date.

Return: A string.

date - The date - String - Cannot be null - Cannot be empty
field - The field to add (DAY|MONTH|YEAR) - String - Cannot be null - Cannot be empty
number - The number to add - Number - Cannot be null - Cannot be empty
1
date.add('1980-06-18''DAY'1)
1980-06-19
1
date.add('1980-06-18''MONTH'1)
1980-07-18
1
date.add('1980-06-18''YEAR'1)
1981-06-18

Root   >   Data manipulation   >   Date   >   addt
Add a number to a time stamp.

Return: A string.

timestamp - The timestamp - String - Cannot be null - Cannot be empty
field - The field to add (SEC|MIN|HOUR|DAY|MONTH|YEAR) - String - Cannot be null - Cannot be empty
number - The number to add - Number - Cannot be null - Cannot be empty
1
date.addt('1980-06-18 00:00:00''DAY'1)
1980-06-19 00:00:00
1
date.addt('1980-06-18 00:00:00''MONTH'1)
1980-07-18 00:00:00
1
date.addt('1980-06-18 00:00:00''YEAR'1)
1981-06-18 00:00:00
1
date.addt('1980-06-18 00:00:00''SEC'1)
1980-06-18 00:00:01
1
date.addt('1980-06-18 00:00:00''MIN'1)
1980-06-18 00:01:00
1
date.addt('1980-06-18 00:00:00''HOUR'1)
1980-06-18 01:00:00

Root   >   Data manipulation   >   Date   >   curdate - (SYSDATE)
Returns the current date.

Return: A string.

1
curdate()
2015-09-13

Root   >   Data manipulation   >   Date   >   current_date - (SYSDATE)
Returns the current date.

Return: A string.

1
current_date()
2015-09-13

Root   >   Data manipulation   >   Date   >   current_time - (SYSTIME)
Returns the current time.

Return: A string.

1
current_time()
14:01:22

Root   >   Data manipulation   >   Date   >   current_timestamp - (SYSTIMESTAMP)
Returns the current timestamp.

Return: A string.

1
current_timestamp()
2015-09-13 14:01:42

Root   >   Data manipulation   >   Date   >   curtime - (SYSTIME)
Returns the current time.

Return: A string.

1
curtime()
14:01:57

Root   >   Data manipulation   >   Date   >   curtimestamp - (SYSTIMESTAMP)
Returns the current timestamp.

Return: A string.

1
curtimestamp()
2015-09-13 14:02:13

Root   >   Data manipulation   >   Date   >   dateadd - (ADD)
Add a number to a date.

Return: A string.

date - The date - String - Cannot be null - Cannot be empty
field - The field to add (DAY|MONTH|YEAR) - String - Cannot be null - Cannot be empty
number - The number to add - Number - Cannot be null - Cannot be empty
1
dateadd('1980-06-18''DAY'1)
1980-06-19
1
dateadd('1980-06-18''MONTH'1)
1980-07-18
1
dateadd('1980-06-18''YEAR'1)
1981-06-18

Root   >   Data manipulation   >   Date   >   dateaddt - (ADDT)
Add a number to a timestamp.

Return: A string.

timestamp - The timestamp - String - Cannot be null - Cannot be empty
field - The field to add (SEC|MIN|HOUR|DAY|MONTH|YEAR) - String - Cannot be null - Cannot be empty
number - The number to add - Number - Cannot be null - Cannot be empty
1
dateaddt('1980-06-18 00:00:00''DAY'1)
1980-06-19 00:00:00
1
dateaddt('1980-06-18 00:00:00''MONTH'1)
1980-07-18 00:00:00
1
dateaddt('1980-06-18 00:00:00''YEAR'1)
1981-06-18 00:00:00
1
dateaddt('1980-06-18 00:00:00''SEC'1)
1980-06-18 00:00:01
1
dateaddt('1980-06-18 00:00:00''MIN'1)
1980-06-18 00:01:00
1
dateaddt('1980-06-18 00:00:00''HOUR'1)
1980-06-18 01:00:00

Root   >   Data manipulation   >   Date   >   datediff
Sub a number to a date.

Return: A string.

date - The date - String - Cannot be null - Cannot be empty
field - The field to add (DAY|MONTH|YEAR) - String - Cannot be null - Cannot be empty
number - The number to add - Number - Cannot be null - Cannot be empty
1
datediff('1980-06-18''DAY'1)
1980-06-17
1
datediff('1980-06-18''MONTH'1)
1980-05-18
1
datediff('1980-06-18''YEAR'1)
1979-06-18

Root   >   Data manipulation   >   Date   >   datedifft
Sub a number to a date.

Return: A string.

timestamp - The timestamp - String - Cannot be null - Cannot be empty
field - The field to add (SEC|MIN|HOUR|DAY|MONTH|YEAR) - String - Cannot be null - Cannot be empty
number - The number to add - Number - Cannot be null - Cannot be empty
1
datedifft('1980-06-18 00:00:00''DAY'1)
1980-06-17 00:00:00
1
datedifft('1980-06-18 00:00:00''MONTH'1)
1980-05-18 00:00:00
1
datedifft('1980-06-18 00:00:00''YEAR'1)
1979-06-18 00:00:00
1
datedifft('1980-06-18 00:00:00''SEC'1)
1980-06-17 23:59:59
1
datedifft('1980-06-18 00:00:00''MIN'1)
1980-06-17 23:59:00
1
datedifft('1980-06-18 00:00:00''HOUR'1)
1980-06-17 23:00:00

Root   >   Data manipulation   >   Date   >   ts_to_long
Timestamp to long.

Return: A string.

timestamp - The timestamp - String - Cannot be null - Cannot be empty
1
ts_to_long('1980-06-18 00:00:00')
330120000000

Root   >   Data manipulation   >   Date   >   dt_to_long
Date to long.

Return: A string.

date - The date - String - Cannot be null - Cannot be empty
1
dt_to_long('1980-06-18')
330120000000

Root   >   Data manipulation   >   Date   >   day_of_month
Get the day of month of a date.

Return: A number.

date - The date - String - Cannot be null - Cannot be empty
1
day_of_month('1980-06-18')
18

Root   >   Data manipulation   >   Date   >   day_of_week
Get the day of week of a date.

Return: A number.

date - The date - String - Cannot be null - Cannot be empty
1
day_of_week('1980-06-18')
3

Root   >   Data manipulation   >   Date   >   day_of_year
Get the day of year of a date.

Return: A number.

date - The date - String - Cannot be null - Cannot be empty
1
day_of_year('1980-06-18')
170

Root   >   Data manipulation   >   Date   >   dayname
Get the day name of a date.

Return: A string.

date - The date - String - Cannot be null - Cannot be empty
1
dayname('1980-06-18')
mercredi

Root   >   Data manipulation   >   Date   >   diff
Sub a number to a date.

Return: A string.

date - The date - String - Cannot be null - Cannot be empty
field - The field to add (DAY|MONTH|YEAR) - String - Cannot be null - Cannot be empty
number - The number to add - Number - Cannot be null - Cannot be empty
1
date.diff('1980-06-18''DAY'1)
1980-06-17
1
date.diff('1980-06-18''MONTH'1)
1980-05-18
1
date.diff('1980-06-18''YEAR'1)
1979-06-18

Root   >   Data manipulation   >   Date   >   difft
Sub a number to a time stamp.

Return: A string.

timestamp - The timestamp - String - Cannot be null - Cannot be empty
field - The field to add (SEC|MIN|HOUR|DAY|MONTH|YEAR) - String - Cannot be null - Cannot be empty
number - The number to add - Number - Cannot be null - Cannot be empty
1
date.difft('1980-06-18 00:00:00''DAY'1)
1980-06-17 00:00:00
1
date.difft('1980-06-18 00:00:00''MONTH'1)
1980-05-18 00:00:00
1
date.difft('1980-06-18 00:00:00''YEAR'1)
1979-06-18 00:00:00
1
date.difft('1980-06-18 00:00:00''SEC'1)
1980-06-17 23:59:59
1
date.difft('1980-06-18 00:00:00''MIN'1)
1980-06-17 23:59:00
1
date.difft('1980-06-18 00:00:00''HOUR'1)
1980-06-17 23:00:00

Root   >   Data manipulation   >   Date   >   full_systimestamp
Returns the current full timestamp.

Return: A string.

1
full_systimestamp()
2015-09-13 14:03:20.395+0400

Root   >   Data manipulation   >   Date   >   hour
Get the hour of a time.

Return: A number.

time - The time - String - Cannot be null - Cannot be empty
1
hour('12:15:56')
12

Root   >   Data manipulation   >   Date   >   is_valid_date
Check if a date is valid.

Return: A number.

dateToValidate - The date - String - Cannot be null - Cannot be empty
1
is_valid_date('1980-06-18')
1
1
is_valid_date('1980-06-32')
0
1
is_valid_date(null)
0
1
is_valid_date('')
0

Root   >   Data manipulation   >   Date   >   is_valid_date
Check if a date is valid.

Return: A number.

dateToValidate - The date - String - Cannot be null - Cannot be empty
format - The date format - String - Cannot be null - Cannot be empty
1
is_valid_date('1980-06-18''yyyy-MM-dd')
1
1
is_valid_date('1980-06-32''yyyy-MM-dd')
0
1
is_valid_date(null'yyyy-MM-dd')
0
1
is_valid_date('''yyyy-MM-dd')
0

Root   >   Data manipulation   >   Date   >   is_valid_time
Check if a time is valid.

Return: A number.

timeToValidate - The time (12:00:01) - String - Cannot be null - Cannot be empty
1
is_valid_time('12:00:01')
1
1
is_valid_time('45:00:01')
0
1
is_valid_time(null)
0
1
is_valid_time('')
0

Root   >   Data manipulation   >   Date   >   is_valid_timestamp
Check if a timestamp is valid.

Return: A number.

timestampToValidate - The timestamp - String - Cannot be null - Cannot be empty
1
is_valid_timestamp('1980-06-18 12:00:01')
1
1
is_valid_timestamp('1980-06-18 45:00:01')
0
1
is_valid_timestamp('1980-06-32')
0
1
is_valid_timestamp(null)
0
1
is_valid_timestamp('')
0

Root   >   Data manipulation   >   Date   >   is_valid_timestamp
Check if a timestamp is valid.

Return: A number.

timestampToValidate - The timestamp - String - Cannot be null - Cannot be empty
format - The format (ex: yyyy MM dd HH:mm:ss) - String - Cannot be null - Cannot be empty
1
is_valid_timestamp('1980-06-18 12:00:01''yyyy-MM-dd HH:mm:ss')
1

Root   >   Data manipulation   >   Date   >   format
Format a timestamp to another format.

Return: A string.

timestampToFormat - The timestamp - String - Cannot be null - Cannot be empty
formatIn - The in format (ex: yyyyMMdd HH:mm) - String - Cannot be null - Cannot be empty
formatOut - The out format (ex: yyyy MM dd HH:mm:ss) - String - Cannot be null - Cannot be empty
1
date.format('19800618 12:00''yyyyMMdd HH:mm''yyyy-MM-dd HH:mm:ss')
1980-06-18 12:00:01

Root   >   Data manipulation   >   Date   >   minute
Get the minute of a time.

Return: A number.

time - The time - String - Cannot be null - Cannot be empty
1
minute('12:15:56')
15

Root   >   Data manipulation   >   Date   >   month
Get the month of a date.

Return: A number.

date - The date - String - Cannot be null - Cannot be empty
1
month('1980-06-18')
6

Root   >   Data manipulation   >   Date   >   monthname
Get the month name of a date.

Return: A string.

date - The date - String - Cannot be null - Cannot be empty
1
monthname('1980-06-18')
juin

Root   >   Data manipulation   >   Date   >   ping_date_module
Return ';)'.

Return: A string.

1
ping_date_module()
;)

Root   >   Data manipulation   >   Date   >   seconde
Get the seconde of a time.

Return: A number.

time - The time - String - Cannot be null - Cannot be empty
1
seconde('12:15:56')
56

Root   >   Data manipulation   >   Date   >   sysdate
Returns the current date.

Return: A string.

1
sysdate()
2015-09-13

Root   >   Data manipulation   >   Date   >   systime
Returns the current time.

Return: A string.

1
systime()
14:04:18

Root   >   Data manipulation   >   Date   >   systimestamp
Returns the current timestamp.

Return: A string.

1
systimestamp()
2015-09-13 14:04:32

Root   >   Data manipulation   >   Date   >   systimestamp_min
Returns the current timestamp in minimum format.

Return: A string.

1
systimestamp_min()
20150913140446

Root   >   Data manipulation   >   Date   >   time
Get the time of a timestamp.

Return: A string.

timestamp - The timestamp - String - Cannot be null - Cannot be empty
1
time('1980-06-18 12:25:56')
12:25:56

Root   >   Data manipulation   >   Date   >   year
Get the year of a date.

Return: A number.

date - The date - String - Cannot be null - Cannot be empty
1
year('1980-06-18')
1980
Root   >   Data manipulation   >   Math
      This module contains math basic commands.

Root   >   Data manipulation   >   Math   >   abs
Get the absolute value of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
abs(-56)
56
1
abs('-789')
789
1
abs(null)
null
1
abs('a')
null
1
abs('')
null

Root   >   Data manipulation   >   Math   >   acos
Get the arc cosine of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
acos(42)
NaN
1
acos(0.5)
1.0471975511965979
1
acos(1)
0
1
acos(null)
null

Root   >   Data manipulation   >   Math   >   asin
Get the arc sine of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
asin(0.5)
0.5235987755982989
1
asin(42)
NaN
1
asin(1)
1.5707963267948966
1
asin(null)
null

Root   >   Data manipulation   >   Math   >   atan
Get the arc tangent of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
atan(42)
1.5469913006098266
1
atan(0.5)
0.4636476090008061
1
atan(1)
0.7853981633974483
1
atan(null)
null

Root   >   Data manipulation   >   Math   >   atan2
Get the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta)

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
atan2(42)
1.1071487177940904
1
atan2(0.57)
0.07130746478529032
1
atan2(10)
1.5707963267948966
1
atan2(01)
0
1
atan2(null1)
null

Root   >   Data manipulation   >   Math   >   bit_and
The bitwise AND operation

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
bit_and(4456234)
104
1
bit_and(10)
0
1
bit_and(11)
1
1
bit_and(0.57)
null
1
bit_and(null1)
null

Root   >   Data manipulation   >   Math   >   bit_or
The bitwise OR operation

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
bit_or(4456234)
4586
1
bit_or(10)
1
1
bit_or(11)
1
1
bit_or(0.57)
null
1
bit_or(null1)
null

Root   >   Data manipulation   >   Math   >   bit_xor
The bitwise XOR operation

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
bit_xor(4456234)
4482
1
bit_xor(10)
1
1
bit_xor(11)
0
1
bit_xor(0.57)
null
1
bit_xor(null1)
null

Root   >   Data manipulation   >   Math   >   cbrt
Returns the cube root of a double value

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
cbrt(42)
3.4760266448864496
1
cbrt(0.5)
0.7937005259840998
1
cbrt(1)
1
1
cbrt(0)
0
1
cbrt(-10)
-2.154434690031884
1
cbrt(null)
null

Root   >   Data manipulation   >   Math   >   ceil
Get the smallest integer value not less than the number specified as an argument

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
ceil(1.2)
2
1
ceil(1.5)
2
1
ceil(1.9)
2
1
ceil(2)
2
1
ceil(null)
null

Root   >   Data manipulation   >   Math   >   ceiling - (ceil)
Get the smallest integer value not less than the number specified as an argument

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
ceiling(1.2)
2
1
ceiling(1.5)
2
1
ceiling(1.9)
2
1
ceiling(2)
2
1
ceiling(null)
null

Root   >   Data manipulation   >   Math   >   cos
Get the cosine of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
cos(42)
-0.39998531498835127
1
cos(0.5)
0.8775825618903728
1
cos(1)
0.5403023058681398
1
cos(0)
1
1
cos(null)
null

Root   >   Data manipulation   >   Math   >   cosh
Get the hyperbolic cosine of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
cosh(42)
8.696374707602505E17
1
cosh(0.5)
1.1276259652063807
1
cosh(1)
1.543080634815244
1
cosh(0)
1
1
cosh(null)
null

Root   >   Data manipulation   >   Math   >   cot
Get the cotangent of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
cot(42)
0.4364167060752729
1
cot(0.5)
1.830487721712452
1
cot(1)
0.6420926159343306
1
cot(0)
Infinity
1
cot(null)
null

Root   >   Data manipulation   >   Math   >   decimal_format
Convert a number to another formated decimal number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
pattern - The pattern - String - Cannot be null - Cannot be empty
decimalSeparator - The decimal separator - String - Cannot be null - Cannot be empty
groupingSeparator - The grouping separator - String - Cannot be null - Cannot be empty
1
decimal_format(42.456'##.##''.'' ')
42.46
1
decimal_format(123.78'000000.000''.'' ')
000123.780

Root   >   Data manipulation   >   Math   >   deg_to_rad
Converts an angle measured in degrees to an approximately equivalent angle measured in radians

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
deg_to_rad(42)
0.7330382858376184
1
deg_to_rad(0.5)
0.008726646259971648
1
deg_to_rad(1)
0.017453292519943295
1
deg_to_rad(0)
0
1
deg_to_rad(-10)
-0.17453292519943295
1
deg_to_rad(null)
null

Root   >   Data manipulation   >   Math   >   e
Get e value

Return: A number

1
e()
2.718281828459045

Root   >   Data manipulation   >   Math   >   exp
Returns Euler's number e raised to the power of a double value

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
exp(42)
1.73927494152050099E18
1
exp(0.5)
1.6487212707001282
1
exp(1)
2.718281828459045
1
exp(0)
1
1
exp(-10)
4.5399929762484854E-5
1
exp(null)
null

Root   >   Data manipulation   >   Math   >   expm1
Returns e^x -1

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
expm1(42)
1.73927494152050099E18
1
expm1(0.5)
0.6487212707001282
1
expm1(1)
1.718281828459045
1
expm1(0)
0
1
expm1(-10)
-0.9999546000702375
1
expm1(-10.6)
-0.9999750839902685
1
expm1(null)
null

Root   >   Data manipulation   >   Math   >   floor
Get the largest integer value not greater than a number specified as argument

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
floor(1.2)
1
1
floor(1.5)
1
1
floor(1.9)
1
1
floor(2)
2
1
floor(null)
null
1
floor(null)
null

Root   >   Data manipulation   >   Math   >   hypot
Returns sqrt(x^2 +y^2) without intermediate overflow or underflow

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
hypot(4456234)
4462.139845410496
1
hypot(0.57)
7.0178344238090995
1
hypot(10)
1
1
hypot(11)
1.4142135623730951
1
hypot(null1)
null

Root   >   Data manipulation   >   Math   >   log
Get the natural logarithm of the argument

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
log(42)
3.7376696182833684
1
log(0.5)
-0.6931471805599453
1
log(1)
0
1
log(0)
-Infinity
1
log(-10)
NaN
1
log(null)
null

Root   >   Data manipulation   >   Math   >   log10
Get the base 10 logarithm of the argument

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
log10(42)
1.6232492903979006
1
log10(0.5)
-0.3010299956639812
1
log10(1)
0
1
log10(0)
-Infinity
1
log10(-10)
NaN
1
log10(null)
null

Root   >   Data manipulation   >   Math   >   log1p
Returns the natural logarithm of the sum of the argument and 1

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
log1p(42)
3.7612001156935624
1
log1p(0.5)
0.4054651081081644
1
log1p(1)
0.6931471805599453
1
log1p(0)
0
1
log1p(-10)
NaN
1
log1p(-10.6)
NaN
1
log1p(null)
null

Root   >   Data manipulation   >   Math   >   max
Returns the greater

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
max(4456234)
4456
1
max(0.57)
7
1
max(10)
1
1
max(11)
1
1
max(null1)
null

Root   >   Data manipulation   >   Math   >   min
Returns the smaller of two int values

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
min(4456234)
234
1
min(0.57)
0.5
1
min(10)
0
1
min(11)
1
1
min(null1)
null

Root   >   Data manipulation   >   Math   >   mod
The modulo operation

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
mod(4456234)
10
1
mod(11)
0
1
mod(0.57)
null
1
mod(null1)
null
1
mod(10)
null

Root   >   Data manipulation   >   Math   >   pi
Get pi value

Return: A number

1
pi()
3.141592653589793

Root   >   Data manipulation   >   Math   >   ping_math_module
Return ';)'.

Return: A string.

1
ping_math_module()
;)

Root   >   Data manipulation   >   Math   >   pow - (POWER)
Get the value of a number raised to the power of another number

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
pow(0.57)
0.0078125
1
pow(4456234)
Infinity
1
pow(10)
1
1
pow(11)
1
1
pow(null1)
null

Root   >   Data manipulation   >   Math   >   power
Get the value of a number raised to the power of another number

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
power(0.57)
0.0078125
1
power(4456234)
Infinity
1
power(10)
1
1
power(11)
1
1
power(null1)
null

Root   >   Data manipulation   >   Math   >   rad_to_deg
Converts an angle measured in radians to an approximately equivalent angle measured in degrees

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
rad_to_deg(42)
2406.4227395494577
1
rad_to_deg(0.5)
28.64788975654116
1
rad_to_deg(1)
57.29577951308232
1
rad_to_deg(0)
0
1
rad_to_deg(-10)
-572.9577951308232
1
rad_to_deg(null)
null

Root   >   Data manipulation   >   Math   >   random
Get the random number between 0 and the argument

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
random(42)
1
1
random(null)
null

Root   >   Data manipulation   >   Math   >   rint
Returns the double value that is closest in value to the argument and is equal to a mathematical integer

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
rint(42)
42
1
rint(0.5)
0
1
rint(1)
1
1
rint(0)
0
1
rint(-10)
-10
1
rint(-10.6)
-11
1
rint(null)
null

Root   >   Data manipulation   >   Math   >   round
Rounds a number specified as an argument up to a number specified as another argument

Return: A number

number1 - A number - Number - Cannot be null - Cannot be empty
number2 - A number - Number - Cannot be null - Cannot be empty
1
round(1.236542)
1.24
1
round(1.236540)
1
1
round(0.57)
0.5
1
round(10)
1
1
round(11)
1
1
round(null1)
null

Root   >   Data manipulation   >   Math   >   sign
Get the sign of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
sign(42)
1
1
sign(-42)
-1
1
sign(0)
0
1
sign(null)
null

Root   >   Data manipulation   >   Math   >   signum - (SIGN)
Get the sign of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
signum(42)
1
1
signum(-42)
-1
1
signum(0)
0
1
signum(null)
null

Root   >   Data manipulation   >   Math   >   sin
Get the sine of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
sin(42)
-0.9165215479156338
1
sin(0.5)
0.479425538604203
1
sin(1)
0.8414709848078965
1
sin(0)
0
1
sin(null)
null

Root   >   Data manipulation   >   Math   >   sinh
Get the hyperbolic sine of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
sinh(42)
8.696374707602505E17
1
sinh(0.5)
0.5210953054937474
1
sinh(1)
1.1752011936438014
1
sinh(0)
0
1
sinh(null)
null

Root   >   Data manipulation   >   Math   >   sqrt
Get the square root of a non-negative number of the argument

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
sqrt(42)
6.48074069840786
1
sqrt(0.5)
0.7071067811865476
1
sqrt(1)
1
1
sqrt(0)
0
1
sqrt(-10)
NaN
1
sqrt(null)
null

Root   >   Data manipulation   >   Math   >   tan
Get the tangent of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
tan(42)
2.2913879924374863
1
tan(0.5)
0.5463024898437905
1
tan(1)
1.5574077246549023
1
tan(0)
0
1
tan(null)
null

Root   >   Data manipulation   >   Math   >   tanh
Get the hyperbolic tangent of a number

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
tanh(42)
1
1
tanh(0.5)
0.46211715726000974
1
tanh(1)
0.7615941559557649
1
tanh(0)
0
1
tanh(null)
null

Root   >   Data manipulation   >   Math   >   ulp
Returns the size of an ulp of the argument. An ulp of a double value is the positive distance between this floating-point value and the double value next larger in magnitude

Return: A number

number - A number - Number - Cannot be null - Cannot be empty
1
ulp(42)
7.105427357601002E-15
1
ulp(0.5)
1.1102230246251565E-16
1
ulp(1)
2.220446049250313E-16
1
ulp(0)
4.9E-324
1
ulp(-10)
1.7763568394002505E-15
1
ulp(-10.6)
1.7763568394002505E-15
1
ulp(null)
null
Root   >   Data manipulation   >   Operator
      This module contains basic operators.

Root   >   Data manipulation   >   Operator   >   add
Addition

Return: A number

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
+(127)
19
1
add(452)
47
1
operator.add(72)
9
1
+(-56)
1
1
+(-5null)
null
1
+(null5)
null
1
+('a'6)
null

Root   >   Data manipulation   >   Operator   >   and
And operation

Return: A boolean

boolValue1 - The boolean 1 - Number - Can be null - Can be empty
boolValue2 - The boolean 2 - Number - Can be null - Can be empty
1
and(truefalse)
0
1
operator.and(truetrue)
1
1
and(11)
1
1
and(null1)
0
1
and('a'1)
0
1
and(''1)
0

Root   >   Data manipulation   >   Operator   >   and_force
And operation (force the execution of the two operations)

Return: A boolean

boolValue1 - The boolean 1 - Number - Can be null - Can be empty
boolValue2 - The boolean 2 - Number - Can be null - Can be empty
1
and_force(truefalse)
0
1
operator.and_force(truetrue)
1
1
and_force(11)
1
1
and_force(null1)
0
1
and_force('a'1)
0
1
and_force(''1)
0

Root   >   Data manipulation   >   Operator   >   div
Division (Division by zero produces a 'Infinity' result.)

Return: A number

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
/(127)
1.7142857
1
div(452)
22.5
1
operator.div(72)
3.5
1
/(-56)
-0.8333333
1
/(1250)
Infinity
1
/(-5null)
null
1
/(null5)
null
1
/('a'6)
null

Root   >   Data manipulation   >   Operator   >   equal
Check if 2 string values are equal

Return: A boolean

value1 - The value 1 - String - Can be null - Can be empty
value2 - The value 2 - String - Can be null - Can be empty
1
equal('123'123.0)
0
1
equal(123123.0)
0
1
operator.equal('123'123)
1
1
equal('str'null)
0
1
equal(nullnull)
1

Root   >   Data manipulation   >   Operator   >   greater
Check if the first value is greater than the second

Return: A boolean

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
>(55.0)
0
1
>(5125.0)
0
1
greater(129125.0)
1
1
>(55)
0
1
operator.greater(null125.0)
null
1
>(129null)
null
1
>(129'')
null

Root   >   Data manipulation   >   Operator   >   greater_or_equal
Check if the first value is greater or equal than the second

Return: A boolean

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
>=(55.0)
1
1
greater_or_equal(129125.0)
1
1
>=(5125.0)
0
1
>=(55)
1
1
operator.greater_or_equal(null125.0)
null
1
>=(129null)
null
1
>=(129'')
null

Root   >   Data manipulation   >   Operator   >   is_empty
Check if a string is empty

Return: A boolean

value - The value - String - Can be null - Can be empty
1
is_empty('')
1
1
is_null('null')
0

Root   >   Data manipulation   >   Operator   >   is_not_empty
Check if a string is not empty

Return: A boolean

value - The value - String - Can be null - Can be empty
1
is_not_empty('')
0
1
is_not_empty(null)
1
1
is_not_empty('null')
1

Root   >   Data manipulation   >   Operator   >   is_not_null
Check if a value is not null

Return: A boolean

value - The value - String - Can be null - Can be empty
1
is_not_null(null)
0
1
operator.is_not_null(123)
1
1
is_not_null('null')
1

Root   >   Data manipulation   >   Operator   >   is_null
Check if a value is null

Return: A boolean

value - The value - String - Can be null - Can be empty
1
is_null(null)
1
1
operator.is_null(123)
0
1
is_null('null')
0

Root   >   Data manipulation   >   Operator   >   is_null_or_empty
Check if a value is null or empty

Return: A boolean

value - The value - String - Can be null - Can be empty
1
is_null_or_empty(null)
1

Root   >   Data manipulation   >   Operator   >   less
Check if the first value is less than the second

Return: A boolean

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
<(125.0129)
1
1
<(125.05)
0
1
<(5.05)
0
1
<(55)
0
1
operator.less(125.0null)
null
1
<(null129)
null
1
<(''129)
null

Root   >   Data manipulation   >   Operator   >   less_or_equal
Check if the first value is less or equal than the second

Return: A boolean

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
<=(125.0129)
1
1
<=(125.05)
0
1
<=(5.05)
1
1
<=(55)
1
1
operator.less_or_equal(125.0null)
null
1
<=(null129)
null
1
<=(''129)
null

Root   >   Data manipulation   >   Operator   >   mul
Multiplication

Return: A number

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
*(127)
84
1
mul(452)
90
1
operator.mul(72)
14
1
*(-56)
-30
1
*(-5null)
null
1
*(null5)
null
1
*('a'6)
null

Root   >   Data manipulation   >   Operator   >   not
Invert a boolean

Return: A boolean

bool - The boolean - Number - Can be null - Can be empty
1
not(true)
0
1
operator.not(false)
1
1
not(1)
0
1
not(null)
null
1
not('jkl')
0

Root   >   Data manipulation   >   Operator   >   not_equal
Check if 2 string values are not equal

Return: A boolean

value1 - The value 1 - String - Can be null - Can be empty
value2 - The value 2 - String - Can be null - Can be empty
1
not_equal(123123.0)
1
1
not_equal('123'123)
0
1
not_equal('123'123.0)
1
1
not_equal('str'null)
1
1
not_equal(nullnull)
0

Root   >   Data manipulation   >   Operator   >   not_numequal
Check if 2 numeric values are not equal

Return: A boolean

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
!=(123123.0)
0
1
!=('123'123)
0
1
!=('123'123.0)
0
1
!=('12'null)
1
1
!=(nullnull)
1
1
!=('123''m')
1

Root   >   Data manipulation   >   Operator   >   numequal
Check if 2 numeric values are equal

Return: A boolean

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
=(123123.0)
1
1
=('123'123)
1
1
=('123'123.0)
1
1
numequal('12'null)
0
1
numequal(nullnull)
0
1
numequal('123''m')
0

Root   >   Data manipulation   >   Operator   >   or
Or operation

Return: A boolean

boolValue1 - The boolean 1 - Number - Can be null - Can be empty
boolValue2 - The boolean 2 - Number - Can be null - Can be empty
1
or(truefalse)
1
1
operator.or(truetrue)
1
1
or(11)
1
1
or(null1)
0
1
or('a'1)
1
1
or(''1)
1

Root   >   Data manipulation   >   Operator   >   or_force
Or operation (force the excution of the two operations)

Return: A boolean

boolValue1 - The boolean 1 - Number - Can be null - Can be empty
boolValue2 - The boolean 2 - Number - Can be null - Can be empty
1
or_force(truefalse)
1
1
operator.or_force(truetrue)
1
1
or_force(11)
1
1
or_force(null1)
0
1
or_force('a'1)
1
1
or_force(''1)
1

Root   >   Data manipulation   >   Operator   >   ping_operator_module
Return ';)'.

Return: A string.

1
ping_operator_module()
;)

Root   >   Data manipulation   >   Operator   >   sub
Subtraction

Return: A number

number1 - The number 1 - Number - Can be null - Can be empty
number2 - The number 2 - Number - Can be null - Can be empty
1
-(127)
5
1
sub(452)
43
1
operator.sub(72)
5
1
-(-56)
-11
1
-(-5null)
null
1
-(null5)
null
1
-('a'6)
null

Root   >   Data manipulation   >   Operator   >   xor
Xor operation

Return: A boolean

boolValue1 - The boolean 1 - Number - Can be null - Can be empty
boolValue2 - The boolean 2 - Number - Can be null - Can be empty
1
xor(truefalse)
1
1
operator.xor(falsetrue)
1
1
xor(falsefalse)
0
1
xor(truetrue)
0
1
xor(10)
1
Root   >   Data manipulation   >   String
      This module contains string basic commands.

Root   >   Data manipulation   >   String   >   ascii - (CHAR_TO_INT)
Convert a character to integer

Return: A number

chr - The string - String - Cannot be null - Can be empty
1
ascii('a')
97
1
string.ascii('a')
97
1
ascii(4)
52
1
ascii('')
0
1
ascii(null)
null

Root   >   Data manipulation   >   String   >   bin
Returns a string representation of the binary value of N, where N is a long (BIGINT) number

Return: A string

num - The number - Number - Cannot be null - Cannot be empty
1
bin(97)
1100001
1
bin(0)
0
1
bin('a')
null
1
bin('')
null
1
bin(null)
null

Root   >   Data manipulation   >   String   >   bit_length
Returns the length of the string str in bits

Return: A string

str - The string - String - Cannot be null - Cannot be empty
1
bit_length(61)
16
1
bit_length('')
0
1
bit_length(0)
8
1
bit_length(null)
null

Root   >   Data manipulation   >   String   >   char - (INT_TO_CHAR)
Convert an integer to character

Return: A string

num - The number - Number - Cannot be null - Cannot be empty
1
char(97)
a
1
char('a')
null
1
char('')
null
1
char(null)
null

Root   >   Data manipulation   >   String   >   char_length - (LENGTH)
Returns the length of the string. The length is equal to the number of Unicode code units in the string.

Return: A number

str - The string - String - Cannot be null - Can be empty
1
char_length('azerty')
6
1
char_length('')
0
1
char_length(123)
3
1
char_length(null)
null

Root   >   Data manipulation   >   String   >   char_to_int
Convert a character to integer

Return: A number

chr - The string - String - Cannot be null - Can be empty
1
char_to_int('a')
97
1
char_to_int('az')
97
1
char_to_int(4)
52
1
char_to_int('')
0
1
char_to_int(null)
null

Root   >   Data manipulation   >   String   >   concat
Concat all parameters (do not use this function with STRING. before)

Return: A string

str1 - The string - String - Cannot be null - Can be empty
strN - The string - String - Cannot be null - Can be empty
1
concat(97'a''r')
97ar
1
concat('a')
a
1
concat('klmlk'[SOAQL_N]'456')
klmlk
456
1
concat('')

1
concat(04556)
04556
1
concat(null2345)
2345

Root   >   Data manipulation   >   String   >   count
Count the occurrence number of a string in another string

Return: A boolean

string - The string - String - Cannot be null - Can be empty
find - The string - String - Cannot be null - Can be empty
1
count('azertyaze''a')
2
1
count('456 '5)
1
1
count('''')
null
1
count(null'5')
null
1
count('456'null)
null

Root   >   Data manipulation   >   String   >   sha1
Encode a string into SHA1

Return: A string

string - The string - String - Cannot be null - Can be empty
1
sha1('azerty')
9cf95dacd226dcf43da376cdb6cbba7035218921

Root   >   Data manipulation   >   String   >   encode_b64
Encode a string into b64

Return: A string

string - The string - String - Cannot be null - Can be empty
1
encode_b64('azerty')
YXplcnR5

Root   >   Data manipulation   >   String   >   decode_b64
Decode a string from b64

Return: A string

string - The string - String - Cannot be null - Can be empty
1
decode_b64('YXplcnR5')
azerty

Root   >   Data manipulation   >   String   >   del_char_before_each_line
Delete a number of char on each lines

Return: A string

data - The data - String - Cannot be null - Cannot be empty
nbChar - The number of chars - Number - Cannot be null - Cannot be empty
1
del_char_before_each_line('sdlfkjdf[SOAQL_N]dfgdfgdfgdfgd'4)
kjdf
fgdfgdfgd


Root   >   Data manipulation   >   String   >   ends_with
Check if a value ends with another string

Return: A boolean

stringValue - The string - String - Cannot be null - Can be empty
stringToEnd - The end string - String - Cannot be null - Cannot be empty
1
ends_with('azertyaze'3)
0
1
ends_with('azerty''ty')
1
1
ends_with('465'5)
1
1
ends_with('azerty'null)
null
1
ends_with(nullnull)
null

Root   >   Data manipulation   >   String   >   first_letter_upper
Returns the string in lower case. The first letter in upper case.

Return: A boolean

str - The string - String - Cannot be null - Can be empty
1
first_letter_upper('azerty')
Azerty
1
first_letter_upper('456')
456
1
first_letter_upper('')
null
1
first_letter_upper(null)
null

Root   >   Data manipulation   >   String   >   generate_random_str
Generate a random string

Return: A boolean.

size - The size of the string - String - Cannot be null - Can be empty
1
generate_random_str(1)
D

Root   >   Data manipulation   >   String   >   hex
Returns a string representation of the hexadecimal value of N, where N is a long (BIGINT) number

Return: A string

num - The number - Number - Cannot be null - Cannot be empty
1
hex(97)
61
1
hex(0)
0
1
hex('a')
null
1
hex('')
null
1
hex(null)
null

Root   >   Data manipulation   >   String   >   hex_to_int
Convert a hexadecimal number to (BIGINT) number

Return: A number

hex - The hex number - String - Cannot be null - Cannot be empty
1
hex_to_int(97)
151
1
hex_to_int('a')
10
1
hex_to_int(0)
0
1
hex_to_int('')
null
1
hex_to_int(null)
null

Root   >   Data manipulation   >   String   >   hex_to_str
Get a string from a hexadecimal representation (ASCII).

Return: A string

hex - The hexadecimal number - String - Cannot be null - Cannot be empty
1
hex_to_str(61)
a
1
hex_to_str('')

1
hex_to_str(0)

1
hex_to_str(null)
null

Root   >   Data manipulation   >   String   >   indent
Returns the indented string

Return: A string

str - The string - String - Cannot be null - Can be empty
nbSpaceBefore - The string - String - Cannot be null - Can be empty
1
indent('azerty[SOAQL_N]a[SOAQL_N]b[SOAQL_N]c'3)
3

Root   >   Data manipulation   >   String   >   instr
Returns the index within this string of the first occurrence of the specified substring

Return: A number

str1 - The string - String - Cannot be null - Can be empty
str2 - The string - String - Cannot be null - Can be empty
1
instr('azerty''r')
3
1
instr('azerty''rty')
3
1
instr('azerty''u')
-1
1
instr('azerty''')
0
1
instr('azerty'null)
null

Root   >   Data manipulation   >   String   >   instr
Returns the index within this string of the first occurrence of the specified substring, starting at the specified index

Return: A number

str1 - The string - String - Cannot be null - Can be empty
str2 - The string - String - Cannot be null - Can be empty
fromIndex - starting to index - Number - Cannot be null - Cannot be empty
1
instr('azerty''r'4)
-1
1
instr('azerty''rty'2)
3
1
instr('azerty''u'50)
-1
1
instr('azerty'''null)
null
1
instr('azerty'null2)
null

Root   >   Data manipulation   >   String   >   int_to_char
Convert an integer to character

Return: A string

num - The number - Number - Cannot be null - Cannot be empty
1
int_to_char(97)
a
1
int_to_char('a')
null
1
int_to_char('')
null
1
int_to_char(null)
null

Root   >   Data manipulation   >   String   >   int_to_hex - (HEX)
Returns a string representation of the hexadecimal value of N, where N is a long (BIGINT) number

Return: A string

num - The number - Number - Cannot be null - Cannot be empty
1
int_to_hex(97)
61
1
int_to_hex(0)
0
1
int_to_hex('a')
null
1
int_to_hex('')
null
1
int_to_hex(null)
null

Root   >   Data manipulation   >   String   >   int_to_oct - (OCT)
Returns a string representation of the octal value of N, where N is a long (BIGINT) number

Return: A string

num - The number - Number - Cannot be null - Cannot be empty
1
int_to_oct(97)
141
1
int_to_oct(0)
0
1
int_to_oct('a')
null
1
int_to_oct('')
null
1
int_to_oct(null)
null

Root   >   Data manipulation   >   String   >   is_empty - (OPERATOR.IS_EMPTY)
Check if a string is empty

Return: A boolean

value - The value - String - Can be null - Can be empty
1
is_empty('')
1
1
is_empty(null)
0
1
is_null('null')
0

Root   >   Data manipulation   >   String   >   is_letter
Check if a value contains only letters

Return: A boolean

value - The value - String - Cannot be null - Can be empty
1
is_letter('abcd')
1
1
is_letter('abc0d')
0
1
is_letter('')
0
1
is_letter(null)
null

Root   >   Data manipulation   >   String   >   is_alpha_num_uds
Check if a value contains only letters, underscore char or numbers

Return: A boolean

value - The value - String - Cannot be null - Can be empty
1
is_alpha_num_uds('abc_12d')
1
1
is_alpha_num_uds('abc0-d')
0
1
is_alpha_num_uds('')
0
1
is_alpha_num_uds(null)
null

Root   >   Data manipulation   >   String   >   is_alpha_num
Check if a value contains only letters or numbers

Return: A boolean

value - The value - String - Cannot be null - Can be empty
1
is_alpha_num('abc12d')
1
1
is_alpha_num('abc0-d')
0
1
is_alpha_num('')
0
1
is_alpha_num(null)
null

Root   >   Data manipulation   >   String   >   is_not_empty - (OPERATOR.IS_NOT_EMPTY)
Check if a string is not empty

Return: A boolean

value - The value - String - Can be null - Can be empty
1
is_not_empty('')
0
1
is_not_empty(null)
1
1
is_not_empty('null')
1

Root   >   Data manipulation   >   String   >   is_number_char
Check if a value contains only number char

Return: A boolean

value - The value - String - Cannot be null - Can be empty
1
is_number_char('-456.45')
0
1
is_number_char('456')
1
1
is_number_char('')
0
1
is_number_char(null)
null

Root   >   Data manipulation   >   String   >   is_soaql_string
Check if a string is a valid SOAQL string

Return: A boolean

str - The string - String - Cannot be null - Can be empty
1
is_soaql_string('\'azertyaze\'')
1
1
is_soaql_string('azerty')
0
1
is_soaql_string('')
0
1
is_soaql_string(null)
0

Root   >   Data manipulation   >   String   >   itrim
Returns the string with one space character between other chars

Return: A string

str - The string - String - Cannot be null - Can be empty
1
itrim('aze rty')
aze rty
1
itrim('456')
456
1
itrim('')

1
itrim(null)
null

Root   >   Data manipulation   >   String   >   lcase - (LOWER)
Converts all of the characters in this String to lower case using the rules of the default locale

Return: A string

str - The string - String - Cannot be null - Can be empty
1
lcase('AZERTY')
azerty
1
lcase('')

1
lcase(123)
123
1
lcase(null)
null

Root   >   Data manipulation   >   String   >   left
Get the leftmost len characters from the string str.

Return: A string

str - The string - String - Cannot be null - Can be empty
len - The length - Number - Cannot be null - Cannot be empty
1
left('AZERTY'3)
AZE
1
left(1232)
12
1
left(null5)
null
1
left(''5)
null

Root   >   Data manipulation   >   String   >   length
Returns the length of this string. The length is equal to the number of Unicode code units in the string.

Return: A number

str - The string - String - Cannot be null - Can be empty
1
length('azerty')
6
1
length('')
0
1
length(123)
3
1
length(null)
null

Root   >   Data manipulation   >   String   >   like - (REGEXP)
Performs a pattern match of a string expression expr against a pattern pat

Return: A boolean

str - the string - String - Cannot be null - Can be empty
pat - the paterne - String - Cannot be null - Cannot be empty
1
like('azerty''.*ze.*')
1
1
like('azerty''.*at.*')
0
1
like('azerty''')
0
1
like('azerty'null)
null
1
like(null'.*at.*')
null

Root   >   Data manipulation   >   String   >   like_builder1
Returns a string which contains a SQL like condition for search (with \'\')

Return: A string

data - The data - String - Cannot be null - Can be empty
1
like_builder1('aze\'rty')
'%aze\'rty%'
1
like_builder1('')
'%%'
1
like_builder1(123)
'%123%'
1
like_builder1(null)
null

Root   >   Data manipulation   >   String   >   like_builder2
Returns a string which contains a SQL like condition for search (with '' '')

Return: A string

data - The data - String - Cannot be null - Can be empty
1
like_builder2('azer\'ty')
'%azer''ty%'
1
like_builder2('')
'%%'
1
like_builder2(123)
'%123%'
1
like_builder2(null)
null

Root   >   Data manipulation   >   String   >   locate - (INSTR)
Returns the index within this string of the first occurrence of the specified substring

Return: A number

str1 - The string - String - Cannot be null - Can be empty
str2 - The string - String - Cannot be null - Can be empty
1
locate('azerty''r')
3
1
locate('azerty''rty')
3
1
locate('azerty''u')
-1
1
locate('azerty''')
0
1
locate('azerty'null)
null

Root   >   Data manipulation   >   String   >   locate - (INSTR)
Returns the index within this string of the first occurrence of the specified substring, starting at the specified index

Return: A number

str1 - The string - String - Cannot be null - Can be empty
str2 - The string - String - Cannot be null - Can be empty
fromIndex - starting to index - Number - Cannot be null - Cannot be empty
1
locate('azerty''r'4)
-1
1
locate('azerty''rty'2)
3
1
locate('azerty''u'50)
-1
1
locate('azerty'''null)
null
1
locate('azerty'null2)
null

Root   >   Data manipulation   >   String   >   lower
Converts all of the characters in this String to lower case using the rules of the default locale

Return: A string

str - The string - String - Cannot be null - Can be empty
1
lower('AZERTY')
azerty
1
lower('')

1
lower(123)
123
1
lower(null)
null

Root   >   Data manipulation   >   String   >   lpad
Pads the left-side of a string with a specific set of characters

Return: A string

str - The string - String - Cannot be null - Can be empty
padString - The pad string - String - Cannot be null - Cannot be empty
paddedLength - The end of the sub string - Number - Cannot be null - Cannot be empty
1
lpad('azertyaze''#'10)
#azertyaze
1
lpad('azerty'012)
000000azerty
1
lpad(''52)
55
1
lpad('azerty''r''')
null
1
lpad(nullnullnull)
null

Root   >   Data manipulation   >   String   >   lrtrim
Returns the string without space character on the left and on the right

Return: A boolean

str - The string - String - Cannot be null - Can be empty
1
lrtrim(' azerty ')
azerty
1
lrtrim('456 ')
456
1
lrtrim('')

1
lrtrim(null)
null

Root   >   Data manipulation   >   String   >   lrtrim0
Returns the string without 0 character on the left and on the right

Return: A string

str - The string - String - Cannot be null - Can be empty
1
lrtrim0(' 123 ')
123

Root   >   Data manipulation   >   String   >   ltrim
Returns the string without space character on the left

Return: A boolean

str - The string - String - Cannot be null - Can be empty
1
ltrim(' azerty ')
azerty   
1
ltrim('456 ')
456 
1
ltrim('')

1
ltrim(null)
null

Root   >   Data manipulation   >   String   >   matches - (REGEXP)
Performs a pattern match of a string expression expr against a pattern pat

Return: A boolean

str - the string - String - Cannot be null - Can be empty
pat - the paterne - String - Cannot be null - Cannot be empty
1
matches('azerty''.*ze.*')
1
1
matches('azerty''.*at.*')
0
1
matches('azerty''')
0
1
matches('azerty'null)
null
1
matches(null'.*at.*')
null

Root   >   Data manipulation   >   String   >   mid - (SUBSTR)
Returns a new string that is a substring of this string. The substring begins with the character at the specified index and extends to the end of this string.

Return: A boolean

str - The string - String - Cannot be null - Can be empty
index - The begin of the sub string - Number - Cannot be null - Cannot be empty
1
mid('azertyaze'3)
rtyaze
1
mid('azerty'0)
azerty
1
mid(''5)

1
mid('azerty''r')
null
1
mid(nullnull)
null

Root   >   Data manipulation   >   String   >   mid - (SUBSTR)
Returns a new string that is a substring of this string. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1. Thus the length of the substring is endIndex-beginIndex

Return: A boolean

str - The string - String - Cannot be null - Can be empty
beginIndex - The begin of the sub string - Number - Cannot be null - Cannot be empty
endIndex - The end of the sub string - Number - Cannot be null - Cannot be empty
1
mid('azertyaze'35)
rt
1
mid('azerty'05)
azert
1
mid(''52)

1
mid('azerty''r''')
null
1
mid(nullnullnull)
null

Root   >   Data manipulation   >   String   >   not_like - (NOT_REGEXP)
Not performs a pattern match of a string expression expr against a pattern pat

Return: A boolean

str - the string - String - Cannot be null - Can be empty
pat - the paterne - String - Cannot be null - Cannot be empty
1
not_like('azerty''.*ze.*')
0
1
not_like('azerty''.*at.*')
1
1
not_like('azerty''')
1
1
not_like('azerty'null)
null
1
not_like(null'.*at.*')
null

Root   >   Data manipulation   >   String   >   not_regexp
Not performs a pattern match of a string expression expr against a pattern pat

Return: A boolean

str - the string - String - Cannot be null - Can be empty
pat - the paterne - String - Cannot be null - Cannot be empty
1
not_regexp('azerty''.*ze.*')
0
1
not_regexp('azerty''.*at.*')
1
1
not_regexp('azerty''')
1
1
not_regexp('azerty'null)
null
1
not_regexp(null'.*at.*')
null

Root   >   Data manipulation   >   String   >   oct
Returns a string representation of the octal value of N, where N is a long (BIGINT) number

Return: A string

num - The number - Number - Cannot be null - Cannot be empty
1
oct(97)
141
1
oct(0)
0
1
oct(null)
null
1
oct('a')
null
1
oct('')
null

Root   >   Data manipulation   >   String   >   oct_to_int
Convert a octal number to (BIGINT) number

Return: A number

oct - The octal number - String - Cannot be null - Cannot be empty
1
oct_to_int('15')
13
1
oct_to_int(0)
0
1
oct_to_int('')
null
1
oct_to_int(null)
null
1
string.oct_to_int(97)
null

Root   >   Data manipulation   >   String   >   ping_string_module
Return ';)'.

Return: A string.

1
ping_string_module()
;)

Root   >   Data manipulation   >   String   >   position - (INSTR)
Returns the index within this string of the first occurrence of the specified substring

Return: A number

str1 - The string - String - Cannot be null - Can be empty
str2 - The string - String - Cannot be null - Can be empty
1
position('azerty''r')
3
1
position('azerty''rty')
3
1
position('azerty''u')
-1
1
position('azerty''')
0
1
position('azerty'null)
null

Root   >   Data manipulation   >   String   >   position - (INSTR)
Returns the index within this string of the first occurrence of the specified substring, starting at the specified index

Return: A number

str1 - The string - String - Cannot be null - Can be empty
str2 - The string - String - Cannot be null - Can be empty
fromIndex - starting to index - Number - Cannot be null - Cannot be empty
1
position('azerty''r'4)
-1
1
position('azerty''rty'2)
3
1
position('azerty''u'50)
-1
1
position('azerty'''null)
null
1
position('azerty'null2)
null

Root   >   Data manipulation   >   String   >   regexp
Performs a pattern match of a string expression expr against a pattern pat

Return: A boolean

str - the string - String - Cannot be null - Can be empty
pat - the paterne - String - Cannot be null - Cannot be empty
1
regexp('azerty''.*ze.*')
1
1
regexp('azerty''.*at.*')
0
1
regexp('azerty''')
0