ILXTable

new ILXTable(flow)

Since:
  • BIP-IP TMOS 13.0

The ILXTable class provides access to the session DB in the TMM. The session DB provides storage for key/value pairs that can be shared across connection context and across multiple plugin processes. The interface is very similar to the irule table commands, providing operations to create and query for key/value pairs. When a table operation completes the ‘complete’ event will be emitted. The ‘complete’ event will contain result and status.

A single ILXTable object may be used to generate multiple requests, however the response for a request must be received before the next request is sent. A response is not required if the noReply option was specified.

Note: All methods emit a

complete

event. However, for the purposes of avioding name collisions in the API documentation, events are named as

complete_<methodname>

(e.g.

complete

for

ILXTable.add

is named as

complete_add

). See the table command for iRules TCL for more information about session tables.

Parameters:

Name Type Description
flow
ILXFlow ILXFlow object that will be used to set the HA unit for the session DB entry.

Example:

 // Block client that makes more than 100 connections in 5 seconds
var f5 = require('f5-nodejs');
var plugin = new f5.ILXPlugin();

plugin.on('connect', function(flow) {
  var table = new f5.ILXTable(flow);

  // Add new connection to client subtable
  var opts = {
    subtable: flow.client.remoteAddress,
    lifetime: 5,
    noReply: true
  };
  table.add(Date.now(), flow.client.remotePort, opts);

  // Check the client's subtable for number of records
  table.keys(flow.client.remoteAddress, {count: true});
  table.on('complete', function (value, status) {
    if (value < 100) {
      flow.client.allow();
    } else {
      flow.end();
      console.log('Blocked client "' + flow.client.remoteAddress +'."');
    }
  });
});

var options = new f5.ILXPluginOptions();
options.handleServerData = false;
options.handleClientData = false;
options.handleClientOpen = true;
plugin.start(options);

Members

(constant)EXISTS:number

Default Value:
  • -1
An attempt was made to create a key that already exists.

Type:

  • number

(constant)INDEFINITE:number

Default Value:
  • 0xFFFFFFFF
Used to specify a key’s timeout or lifetime such that it will not expire.

Type:

  • number

(constant)NOT_FOUND:number

Default Value:
  • -2
A key or subtable was not found.

Type:

  • number

(constant)OK:number

Default Value:
  • 0
The action was successful.

Type:

  • number

Methods

add(key, value, [options])

Add a session DB key/value pair. This method is the same as ILXTable.set with the excl option set to true. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name
value
string   Key value
options
object <optional>

Pro

perties
name:prope

rties

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | n | < | I

N |
: | u | o | N | u |
| m | p | D | m |
| b | t | E | b |
| e | i | F | e |
| r | o | I | r |
l | | n | N | o |
i | | a | I | f |
f | | l | T | s |
e | | > | E | e |
t | | | | c |
i | | | | o |
m | | | | n |
e | | | | d |
| | | | s |
| | | | . |
| | | | L |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | i |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | t |
| | | | o |
| | | | t |
| | | | a |
| | | | l |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | a |
| | | | r |
| | | | e |
| | | | c |
| | | | o |
| | | | r |
| | | | d |
| | | | i |
| | | | s |
| | | | v |
| | | | a |
| | | | l |
| | | | i |
| | | | d |
| | | | f |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | g |
| | | | a |
| | | | r |
| | | | d |
| | | | l |
| | | | e |
| | | | s |
| | | | s |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | p |
| | | | e |
| | | | r |
| | | | f |
| | | | o |
| | | | r |
| | | | m |
| | | | e |
| | | | d |
| | | | ( |
| | | | e |
| | | | x |
| | | | c |
| | | | l |
| | | | . |
| | | | s |
| | | | e |
| | | | t |
| | | | L |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | r |
| | | | a |
| | | | n |
| | | | y |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | p |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | . |
| | | | l |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | e |
| | | | t |
| | | | ) |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

D |
: | o | o | a | o |
| o | p | l | n |
| l | t | s | ‘ |
| e | i | e | t |
| a | o | | u |
n | n | n | | p |
o | | a | | d |
T | | l | | a |
o | | > | | t |
u | | | | e |
c | | | | t |
h | | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 1

N |
: | u | o | 8 | u |
| m | p | 0 | m |
| b | t | | b |
| e | i | | e |
| r | o | | r |
t | | n | | o |
i | | a | | f |
m | | l | | s |
e | | > | | e |
o | | | | c |
u | | | | o |
t | | | | n |
| | | | d |
| | | | s |
| | | | . |
| | | | K |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | i |
| | | | s |
| | | | r |
| | | | e |
| | | | s |
| | | | e |
| | | | t |
| | | | o |
| | | | n |
| | | | e |
| | | | v |
| | | | e |
| | | | r |
| | | | y |
| | | | r |
| | | | e |
| | | | a |
| | | | d |
| | | | / |
| | | | w |
| | | | r |
| | | | i |
| | | | t |
| | | | e |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | u |
| | | | n |
| | | | l |
| | | | e |
| | | | s |
| | | | s |
| | | | o |
| | | | p |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | . |
| | | | n |
| | | | o |
| | | | T |
| | | | o |
| | | | u |
| | | | c |
| | | | h |
| | | | i |
| | | | s |
| | | | s |
| | | | e |
| | | | t |
| | | | t |
| | | | o |
| | | | |
| | | | : |
| | | | : |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | t |
| | | | r |
| | | | u |
| | | | e |
| | | | |
| | | | . |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

append(key, value, [options])

Append a string to a session DB key value. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name.
value
string   Key value.
options
object <optional>

Pro

perties
name:prope

rties-1

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

I |
: | o | o | a | f |
| o | p | l | m |
| l | t | s | u |
| e | i | e | s |
| a | o | | t |
m | n | n | | E |
u | | a | | x |
s | | l | | i |
t | | > | | s |
E | | | | t |
x | | | | i |
i | | | | s |
s | | | | f |
t | | | | a |
| | | | l |
| | | | s |
| | | | e |
| | | | t |
| | | | h |
| | | | e |
| | | | n |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | c |
| | | | r |
| | | | e |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | i |
| | | | f |
| | | | i |
| | | | t |
| | | | d |
| | | | o |
| | | | e |
| | | | s |
| | | | n |
| | | | o |
| | | | t |
| | | | e |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | . |
| | | | I |
| | | | f |
| | | | m |
| | | | u |
| | | | s |
| | | | t |
| | | | E |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | i |
| | | | s |
| | | | t |
| | | | r |
| | | | u |
| | | | e |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | d |
| | | | o |
| | | | e |
| | | | s |
| | | | n |
| | | | o |
| | | | t |
| | | | e |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | t |
| | | | h |
| | | | e |
| | | | n |
| | | | n |
| | | | o |
| | | | c |
| | | | h |
| | | | a |
| | | | n |
| | | | g |
| | | | e |
| | | | i |
| | | | s |
| | | | m |
| | | | a |
| | | | d |
| | | | e |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | / |
| | | | v |
| | | | a |
| | | | l |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | o |
| | | | r |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

D |
: | o | o | a | o |
| o | p | l | n |
| l | t | s | ‘ |
| e | i | e | t |
| a | o | | u |
n | n | n | | p |
o | | a | | d |
T | | l | | a |
o | | > | | t |
u | | | | e |
c | | | | t |
h | | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 1

N |
: | u | o | 8 | u |
| m | p | 0 | m |
| b | t | | b |
| e | i | | e |
| r | o | | r |
t | | n | | o |
i | | a | | f |
m | | l | | s |
e | | > | | e |
o | | | | c |
u | | | | o |
t | | | | n |
| | | | d |
| | | | s |
| | | | . |
| | | | K |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | i |
| | | | s |
| | | | r |
| | | | e |
| | | | s |
| | | | e |
| | | | t |
| | | | o |
| | | | n |
| | | | e |
| | | | v |
| | | | e |
| | | | r |
| | | | y |
| | | | r |
| | | | e |
| | | | a |
| | | | d |
| | | | / |
| | | | w |
| | | | r |
| | | | i |
| | | | t |
| | | | e |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | u |
| | | | n |
| | | | l |
| | | | e |
| | | | s |
| | | | s |
| | | | o |
| | | | p |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | . |
| | | | n |
| | | | o |
| | | | T |
| | | | o |
| | | | u |
| | | | c |
| | | | h |
| | | | i |
| | | | s |
| | | | s |
| | | | e |
| | | | t |
| | | | t |
| | | | o |
| | | | |
| | | | : |
| | | | : |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | t |
| | | | r |
| | | | u |
| | | | e |
| | | | |
| | | | . |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

delete(key, [options])

Delete a session DB key and the associated value. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name
options
object <optional>

Pro

perties
name:prope

rties-2

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

deleteAll(subtable, [options])

Delete all key/value pairs in a session DB subtable. Fires complete event when finished.

Parameters:

Name Type Attributes Description
subtable
string   Subtable name.
options
object <optional>

Pro

perties
name:prope

rties-3

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

getLifetime(key, [options])

Get a session DB key lifetime value. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name.
options
object <optional>

Pro

perties
name:prope

rties-4

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

R |
: | o | o | a | e |
| o | p | l | t |
| l | t | s | u |
| e | i | e | r |
| a | o | | n |
r | n | n | | t |
e | | a | | h |
m | | l | | e |
a | | > | | t |
i | | | | i |
n | | | | m |
i | | | | e |
n | | | | r |
g | | | | e |
| | | | m |
| | | | a |
| | | | i |
| | | | n |
| | | | i |
| | | | n |
| | | | g |
| | | | i |
| | | | n |
| | | | s |
| | | | t |
| | | | e |
| | | | a |
| | | | d |
| | | | o |
| | | | f |
| | | | t |
| | | | h |
| | | | e |
| | | | l |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

getTimeout(key, [options])

Get a session DB key timeout value. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name.
options
object <optional>

Pro

perties
name:prope

rties-5

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

R |
: | o | o | a | e |
| o | p | l | t |
| l | t | s | u |
| e | i | e | r |
| a | o | | n |
r | n | n | | t |
e | | a | | h |
m | | l | | e |
a | | > | | t |
i | | | | i |
n | | | | m |
i | | | | e |
n | | | | r |
g | | | | e |
| | | | m |
| | | | a |
| | | | i |
| | | | n |
| | | | i |
| | | | n |
| | | | g |
| | | | i |
| | | | n |
| | | | s |
| | | | t |
| | | | e |
| | | | a |
| | | | d |
| | | | o |
| | | | f |
| | | | t |
| | | | h |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

incr(key, [options])

Increment a session DB key value. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name.
options
object <optional>

Pro

perties
name:prope

rties-6

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | n | < | 1

I |
: | u | o | | n |
| m | p | | c |
| b | t | | r |
| e | i | | e |
| r | o | | m |
d | | n | | e |
e | | a | | n |
l | | l | | t |
t | | > | | t |
a | | | | h |
| | | | e |
| | | | v |
| | | | a |
| | | | l |
| | | | u |
| | | | e |
| | | | b |
| | | | y |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | m |
| | | | o |
| | | | u |
| | | | n |
| | | | t |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

I |
: | o | o | a | f |
| o | p | l | m |
| l | t | s | u |
| e | i | e | s |
| a | o | | t |
m | n | n | | E |
u | | a | | x |
s | | l | | i |
t | | > | | s |
E | | | | t |
x | | | | i |
i | | | | s |
s | | | | f |
t | | | | a |
| | | | l |
| | | | s |
| | | | e |
| | | | t |
| | | | h |
| | | | e |
| | | | n |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | c |
| | | | r |
| | | | e |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | i |
| | | | f |
| | | | i |
| | | | t |
| | | | d |
| | | | o |
| | | | e |
| | | | s |
| | | | n |
| | | | o |
| | | | t |
| | | | e |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | . |
| | | | I |
| | | | f |
| | | | m |
| | | | u |
| | | | s |
| | | | t |
| | | | E |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | i |
| | | | s |
| | | | t |
| | | | r |
| | | | u |
| | | | e |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | d |
| | | | o |
| | | | e |
| | | | s |
| | | | n |
| | | | o |
| | | | t |
| | | | e |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | t |
| | | | h |
| | | | e |
| | | | n |
| | | | n |
| | | | o |
| | | | c |
| | | | h |
| | | | a |
| | | | n |
| | | | g |
| | | | e |
| | | | i |
| | | | s |
| | | | m |
| | | | a |
| | | | d |
| | | | e |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | / |
| | | | v |
| | | | a |
| | | | l |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | o |
| | | | r |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

D |
: | o | o | a | o |
| o | p | l | n |
| l | t | s | ‘ |
| e | i | e | t |
| a | o | | u |
n | n | n | | p |
o | | a | | d |
T | | l | | a |
o | | > | | t |
u | | | | e |
c | | | | t |
h | | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 1

N |
: | u | o | 8 | u |
| m | p | 0 | m |
| b | t | | b |
| e | i | | e |
| r | o | | r |
t | | n | | o |
i | | a | | f |
m | | l | | s |
e | | > | | e |
o | | | | c |
u | | | | o |
t | | | | n |
| | | | d |
| | | | s |
| | | | . |
| | | | K |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | i |
| | | | s |
| | | | r |
| | | | e |
| | | | s |
| | | | e |
| | | | t |
| | | | o |
| | | | n |
| | | | e |
| | | | v |
| | | | e |
| | | | r |
| | | | y |
| | | | r |
| | | | e |
| | | | a |
| | | | d |
| | | | / |
| | | | w |
| | | | r |
| | | | i |
| | | | t |
| | | | e |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | u |
| | | | n |
| | | | l |
| | | | e |
| | | | s |
| | | | s |
| | | | o |
| | | | p |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | . |
| | | | n |
| | | | o |
| | | | T |
| | | | o |
| | | | u |
| | | | c |
| | | | h |
| | | | i |
| | | | s |
| | | | s |
| | | | e |
| | | | t |
| | | | t |
| | | | o |
| | | | |
| | | | : |
| | | | : |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | t |
| | | | r |
| | | | u |
| | | | e |
| | | | |
| | | | . |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

keys(subtable, [options])

Query for the keys in session DB subtable. Fires complete event when finished.

Parameters:

Name Type Attributes Description
subtable
string   Subtable name.
options
object <optional>

Pro

perties
name:prope

rties-7

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

R |
: | o | o | a | e |
| o | p | l | t |
| l | t | s | u |
| e | i | e | r |
| a | o | | n |
c | n | n | | t |
o | | a | | h |
u | | l | | e |
n | | > | | n |
t | | | | u |
| | | | m |
| | | | b |
| | | | e |
| | | | r |
| | | | o |
| | | | f |
| | | | k |
| | | | e |
| | | | y |
| | | | s |
| | | | i |
| | | | n |
| | | | s |
| | | | t |
| | | | e |
| | | | a |
| | | | d |
| | | | o |
| | | | f |
| | | | a |
| | | | l |
| | | | l |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | s |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

D |
: | o | o | a | o |
| o | p | l | n |
| l | t | s | ‘ |
| e | i | e | t |
| a | o | | u |
n | n | n | | p |
o | | a | | d |
T | | l | | a |
o | | > | | t |
u | | | | e |
c | | | | t |
h | | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | . |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

lookup(key, [options])

Get a session DB key value. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name.
options
object <optional>

Pro

perties
name:prope

rties-8

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

D |
: | o | o | a | o |
| o | p | l | n |
| l | t | s | ‘ |
| e | i | e | t |
| a | o | | u |
n | n | n | | p |
o | | a | | d |
T | | l | | a |
o | | > | | t |
u | | | | e |
c | | | | t |
h | | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

replace(key, value, [options])

Update a session DB key/value pair. This is the same as ` <#set>`__

ILXTable#set

with mustExist enabled. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name.
value
string   Key value.
options
object <optional>

Pro

perties
name:prope

rties-9

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | n | < | I

N |
: | u | o | N | u |
| m | p | D | m |
| b | t | E | b |
| e | i | F | e |
| r | o | I | r |
l | | n | N | o |
i | | a | I | f |
f | | l | T | s |
e | | > | E | e |
t | | | | c |
i | | | | o |
m | | | | n |
e | | | | d |
| | | | s |
| | | | . |
| | | | L |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | i |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | t |
| | | | o |
| | | | t |
| | | | a |
| | | | l |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | a |
| | | | r |
| | | | e |
| | | | c |
| | | | o |
| | | | r |
| | | | d |
| | | | i |
| | | | s |
| | | | v |
| | | | a |
| | | | l |
| | | | i |
| | | | d |
| | | | f |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | g |
| | | | a |
| | | | r |
| | | | d |
| | | | l |
| | | | e |
| | | | s |
| | | | s |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | p |
| | | | e |
| | | | r |
| | | | f |
| | | | o |
| | | | r |
| | | | m |
| | | | e |
| | | | d |
| | | | ( |
| | | | e |
| | | | x |
| | | | c |
| | | | l |
| | | | . |
| | | | s |
| | | | e |
| | | | t |
| | | | L |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | r |
| | | | a |
| | | | n |
| | | | y |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | p |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | . |
| | | | l |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | e |
| | | | t |
| | | | ) |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

D |
: | o | o | a | o |
| o | p | l | n |
| l | t | s | ‘ |
| e | i | e | t |
| a | o | | u |
n | n | n | | p |
o | | a | | d |
T | | l | | a |
o | | > | | t |
u | | | | e |
c | | | | t |
h | | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 1

N |
: | u | o | 8 | u |
| m | p | 0 | m |
| b | t | | b |
| e | i | | e |
| r | o | | r |
t | | n | | o |
i | | a | | f |
m | | l | | s |
e | | > | | e |
o | | | | c |
u | | | | o |
t | | | | n |
| | | | d |
| | | | s |
| | | | . |
| | | | K |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | i |
| | | | s |
| | | | r |
| | | | e |
| | | | s |
| | | | e |
| | | | t |
| | | | o |
| | | | n |
| | | | e |
| | | | v |
| | | | e |
| | | | r |
| | | | y |
| | | | r |
| | | | e |
| | | | a |
| | | | d |
| | | | / |
| | | | w |
| | | | r |
| | | | i |
| | | | t |
| | | | e |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | u |
| | | | n |
| | | | l |
| | | | e |
| | | | s |
| | | | s |
| | | | o |
| | | | p |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | . |
| | | | n |
| | | | o |
| | | | T |
| | | | o |
| | | | u |
| | | | c |
| | | | h |
| | | | i |
| | | | s |
| | | | s |
| | | | e |
| | | | t |
| | | | t |
| | | | o |
| | | | |
| | | | : |
| | | | : |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | t |
| | | | r |
| | | | u |
| | | | e |
| | | | |
| | | | . |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

set(key, value, [options])

Set a session DB key/value pair. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name
value
string   Key value
options
object <optional>

Pro

perties
name:prope

rties-10

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

I |
: | o | o | a | f |
| o | p | l | e |
| l | t | s | x |
| e | i | e | c |
| a | o | | l |
e | n | n | | i |
x | | a | | s |
c | | l | | t |
l | | > | | r |
| | | | u |
| | | | e |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | a |
| | | | l |
| | | | r |
| | | | e |
| | | | a |
| | | | d |
| | | | y |
| | | | e |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | u |
| | | | p |
| | | | d |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | e |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | v |
| | | | a |
| | | | l |
| | | | u |
| | | | e |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | b |
| | | | e |
| | | | r |
| | | | e |
| | | | t |
| | | | u |
| | | | r |
| | | | n |
| | | | e |
| | | | d |
| | | | . |

+—+—+—+– -+—+ | : | n | < | I

N |
: | u | o | N | u |
| m | p | D | m |
| b | t | E | b |
| e | i | F | e |
| r | o | I | r |
l | | n | N | o |
i | | a | I | f |
f | | l | T | s |
e | | > | E | e |
t | | | | c |
i | | | | o |
m | | | | n |
e | | | | d |
| | | | s |
| | | | . |
| | | | L |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | i |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | t |
| | | | o |
| | | | t |
| | | | a |
| | | | l |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | a |
| | | | r |
| | | | e |
| | | | c |
| | | | o |
| | | | r |
| | | | d |
| | | | i |
| | | | s |
| | | | v |
| | | | a |
| | | | l |
| | | | i |
| | | | d |
| | | | f |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | g |
| | | | a |
| | | | r |
| | | | d |
| | | | l |
| | | | e |
| | | | s |
| | | | s |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | p |
| | | | e |
| | | | r |
| | | | f |
| | | | o |
| | | | r |
| | | | m |
| | | | e |
| | | | d |
| | | | ( |
| | | | e |
| | | | x |
| | | | c |
| | | | l |
| | | | . |
| | | | s |
| | | | e |
| | | | t |
| | | | L |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | r |
| | | | a |
| | | | n |
| | | | y |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | p |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | . |
| | | | l |
| | | | i |
| | | | f |
| | | | e |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | e |
| | | | t |
| | | | ) |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

I |
: | o | o | a | f |
| o | p | l | m |
| l | t | s | u |
| e | i | e | s |
| a | o | | t |
m | n | n | | E |
u | | a | | x |
s | | l | | i |
t | | > | | s |
E | | | | t |
x | | | | i |
i | | | | s |
s | | | | f |
t | | | | a |
| | | | l |
| | | | s |
| | | | e |
| | | | t |
| | | | h |
| | | | e |
| | | | n |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | c |
| | | | r |
| | | | e |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | i |
| | | | f |
| | | | i |
| | | | t |
| | | | d |
| | | | o |
| | | | e |
| | | | s |
| | | | n |
| | | | o |
| | | | t |
| | | | e |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | . |
| | | | I |
| | | | f |
| | | | m |
| | | | u |
| | | | s |
| | | | t |
| | | | E |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | i |
| | | | s |
| | | | t |
| | | | r |
| | | | u |
| | | | e |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | d |
| | | | o |
| | | | e |
| | | | s |
| | | | n |
| | | | o |
| | | | t |
| | | | e |
| | | | x |
| | | | i |
| | | | s |
| | | | t |
| | | | t |
| | | | h |
| | | | e |
| | | | n |
| | | | n |
| | | | o |
| | | | c |
| | | | h |
| | | | a |
| | | | n |
| | | | g |
| | | | e |
| | | | i |
| | | | s |
| | | | m |
| | | | a |
| | | | d |
| | | | e |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | / |
| | | | v |
| | | | a |
| | | | l |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | o |
| | | | r |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | b | < | f

D |
: | o | o | a | o |
| o | p | l | n |
| l | t | s | ‘ |
| e | i | e | t |
| a | o | | u |
n | n | n | | p |
o | | a | | d |
T | | l | | a |
o | | > | | t |
u | | | | e |
c | | | | t |
h | | | | h |
| | | | e |
| | | | k |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 1

N |
: | u | o | 8 | u |
| m | p | 0 | m |
| b | t | | b |
| e | i | | e |
| r | o | | r |
t | | n | | o |
i | | a | | f |
m | | l | | s |
e | | > | | e |
o | | | | c |
u | | | | o |
t | | | | n |
| | | | d |
| | | | s |
| | | | . |
| | | | K |
| | | | e |
| | | | y |
| | | | ‘ |
| | | | s |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | o |
| | | | u |
| | | | t |
| | | | t |
| | | | i |
| | | | m |
| | | | e |
| | | | s |
| | | | t |
| | | | a |
| | | | m |
| | | | p |
| | | | i |
| | | | s |
| | | | r |
| | | | e |
| | | | s |
| | | | e |
| | | | t |
| | | | o |
| | | | n |
| | | | e |
| | | | v |
| | | | e |
| | | | r |
| | | | y |
| | | | r |
| | | | e |
| | | | a |
| | | | d |
| | | | / |
| | | | w |
| | | | r |
| | | | i |
| | | | t |
| | | | e |
| | | | a |
| | | | c |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | u |
| | | | n |
| | | | l |
| | | | e |
| | | | s |
| | | | s |
| | | | o |
| | | | p |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | s |
| | | | . |
| | | | n |
| | | | o |
| | | | T |
| | | | o |
| | | | u |
| | | | c |
| | | | h |
| | | | i |
| | | | s |
| | | | s |
| | | | e |
| | | | t |
| | | | t |
| | | | o |
| | | | |
| | | | : |
| | | | : |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | t |
| | | | r |
| | | | u |
| | | | e |
| | | | |
| | | | . |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

setLifetime(key, value, [options])

Set a session DB key lifetime value. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name.
value
number   Lifetime value in seconds, or ILXTable.INDEFI NITE.
options
object <optional>

Pro

perties
name:prope

rties-11

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

setTimeout(key, value, [options])

Set a session DB key timeout value. Fires complete event when finished.

Parameters:

Name Type Attributes Description
key
string   Key name.
value
number   Timeout value in seconds, or ILXTable.INDEFI NITE.
options
object <optional>

Pro

perties
name:prope

rties-12

+—+—+—+– -+—+ | N | T | A | D

D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+===+== =+===+ | : | b | < | f

T |
: | o | o | a | h |
| o | p | l | e |
| l | t | s | T |
| e | i | e | M |
| a | o | | M |
n | n | n | | w |
o | | a | | i |
R | | l | | l |
e | | > | | l |
p | | | | n |
l | | | | o |
y | | | | t |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | r |
| | | | e |
| | | | p |
| | | | l |
| | | | y |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | l |
| | | | u |
| | | | g |
| | | | i |
| | | | n |
| | | | a |
| | | | n |
| | | | d |
| | | | t |
| | | | h |
| | | | e |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | e |
| | | | v |
| | | | e |
| | | | n |
| | | | t |
| | | | w |
| | | | i |
| | | | l |
| | | | l |
| | | | n |
| | | | o |
| | | | t |
| | | | b |
| | | | e |
| | | | g |
| | | | e |
| | | | n |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | e |
| | | | d |
| | | | . |
| | | | T |
| | | | h |
| | | | i |
| | | | s |
| | | | a |
| | | | l |
| | | | s |
| | | | o |
| | | | a |
| | | | l |
| | | | l |
| | | | o |
| | | | w |
| | | | s |
| | | | t |
| | | | h |
| | | | e |
| | | | I |
| | | | L |
| | | | X |
| | | | T |
| | | | a |
| | | | b |
| | | | l |
| | | | e |
| | | | o |
| | | | b |
| | | | j |
| | | | e |
| | | | c |
| | | | t |
| | | | t |
| | | | o |
| | | | b |
| | | | e |
| | | | u |
| | | | s |
| | | | e |
| | | | d |
| | | | t |
| | | | o |
| | | | i |
| | | | m |
| | | | m |
| | | | e |
| | | | d |
| | | | i |
| | | | a |
| | | | t |
| | | | e |
| | | | l |
| | | | y |
| | | | s |
| | | | e |
| | | | n |
| | | | d |
| | | | a |
| | | | n |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | t |
| | | | h |
| | | | e |
| | | | T |
| | | | M |
| | | | M |
| | | | w |
| | | | i |
| | | | t |
| | | | h |
| | | | o |
| | | | u |
| | | | t |
| | | | w |
| | | | a |
| | | | i |
| | | | t |
| | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | e |
| | | | p |
| | | | r |
| | | | i |
| | | | o |
| | | | r |
| | | | r |
| | | | e |
| | | | q |
| | | | u |
| | | | e |
| | | | s |
| | | | t |
| | | | t |
| | | | o |
| | | | c |
| | | | o |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | t |
| | | | e |
| | | | . |

+—+—+—+– -+—+ | : | s | < | n

S |
: | t | o | o | u |
| r | p | n | b |
| i | t | e | t |
| n | i | | a |
| g | o | | b |
s | | n | | l |
u | | a | | e |
b | | l | | n |
t | | > | | a |
a | | | | m |
b | | | | e |
l | | | | |
e | | | | |

+—+—+—+– -+—+ | : | n | < | 0

E |
: | u | o | | n |
| m | p | | a |
| b | t | | b |
| e | i | | l |
| r | o | | e |
t | | n | | d |
r | | a | | e |
a | | l | | b |
c | | > | | u |
e | | | | g |
L | | | | t |
e | | | | r |
v | | | | a |
e | | | | c |
l | | | | i |
| | | | n |
| | | | g |
| | | | f |
| | | | o |
| | | | r |
| | | | t |
| | | | h |
| | | | i |
| | | | s |
| | | | o |
| | | | p |
| | | | e |
| | | | r |
| | | | a |
| | | | t |
| | | | i |
| | | | o |
| | | | n |
| | | | . |

+—+—+—+– -+—+

Events

complete_add

Event “complete” emitted when ILXTable.add completes.

Parameters:

Name Type Description
value
string The resulting key value.
status
number ILXTable.OK, ILXTable.EXISTS or a system error.

Example:

 var table = new f5.ILXTable(flow);
table.add('key', 'value');
table.on('complete', function (value, status) {
  if (status !== 0)
    console.error('Failed to add key:', status);
  else
    console.log(value);
});

complete_append

Event “complete” emitted when ILXTable.append completes.

Parameters:

Name Type Description
value
string The resulting key value.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

Example:

 var table = new f5.ILXTable(flow);
table.append('key', 'value');
table.on('complete', function (value, status) {
  if (status !== 0)
    console.error('Failed to append key:', status);
  else
    console.log(value);
});

complete_delete

Event “complete” emitted when ILXTable.delete completes.

Parameters:

Name Type Description
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_deleteAll

Event “complete” emitted when ILXTable.deleteAll completes.

Parameters:

Name Type Description
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_getLifetime

Event “complete” emitted when ILXTable.getLifetime completes.

Parameters:

Name Type Description
value
string Lifetime or lifetime remaining.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_getTimeout

Event “complete” emitted when ILXTable.getTimeout completes.

Parameters:

Name Type Description
value
string Timeout or time remaining.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_incr

Event “complete” emitted when ILXTable.incr completes.

Parameters:

Name Type Description
value
string The resulting key value.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_keys

Event “complete” emitted when ILXTable.keys completes.

Parameters:

Name Type Description
value
object If the count option was specified the number of keys is returned. If the count option was not specified an array of keys is returned.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_lookup

Event “complete” emitted when ILXTable.lookup completes.

Parameters:

Name Type Description
value
string The value associated with the specified key.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_replace

Event “complete” emitted when ILXTable.replace completes.

Parameters:

Name Type Description
value
string The resulting key value.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_set

Event “complete” emitted when ILXTable.set completes.

Parameters:

Name Type Description
value
string The resulting key value.
status
number ILXTable.OK, ILXTable.NOT_FOUND, ILXTable.EXISTS or a system error.

complete_setLifetime

Event “complete” emitted when ILXTable.setLifetime completes.

Parameters:

Name Type Description
value
string The new lifetime value.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.

complete_setTimeout

Event “complete” emitted when ILXTable.setTimeout completes.

Parameters:

Name Type Description
value
string The new timeout value.
status
number ILXTable.OK, ILXTable.NOT_FOUND or a system error.