Class: OpenICE

Members

maxSamples

Properties:

Name	Type	Description
maxSamples	int	Max samples preserved for each row.

Source:

• openice.js, line 310

tables

Properties:

Name	Type	Description
tables	object	Tables hashed by table key string.

Source:

• openice.js, line 307

url

Properties:

Name	Type	Description
url	string	The URL of the remote OpenICE server.

Source:

• openice.js, line 302

Methods

createTable(args) → {Table}

Creates a table with identifying information (or returns existing table if already created) and requests table information from the server.

Parameters:

Name	Type	Description
args	object	Contains attributes domain, partition, and topic identifying the table.

Source:

• openice.js, line 416

Returns:

Type

Table

destroyTable(args)

Destroys a table with identifying information (or no op if it does not exist) and requests that the server stop sending information about the table.

Parameters:

Name	Type	Description
args	object	Contains attributes domain, partition, and topic identifying the table.

Source:

• openice.js, line 547

getTable(args)

Retrieves a table by identifying information. If the table does not exist it is NOT created.

Parameters:

Name	Type	Description
args	object	Contains attributes domain, partition, and topic identifying the table.

Source:

• openice.js, line 404

Events

OpenICE:addtable

A table has been added

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
table	Table	The added table

Source:

• openice.js, line 490

OpenICE:afterremove

A row has been removed from a table

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
table	Table	The table
Row	Row	The removed row

Source:

• openice.js, line 457

OpenICE:beforeadd

A row will be added to a table

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
table	Table	The table
Row	Row	The row to be added

Source:

• openice.js, line 468

OpenICE:beforeadd

A row has been added to a table

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
table	Table	The table
Row	Row	The added row

Source:

• openice.js, line 479

OpenICE:beforeremove

A row will be removed from a table

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
table	Table	The table
Row	Row	The row to be removed

Source:

• openice.js, line 446

OpenICE:close

The connection has been closed

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE

Source:

• openice.js, line 382

OpenICE:error

An error has occurred

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
err	object	Further information about the error

Source:

• openice.js, line 370

OpenICE:open

The connection has been (re)opened

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE

Source:

• openice.js, line 344

OpenICE:removetable

A table has been removed

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
table	Table	The removed table

Source:

• openice.js, line 556

OpenICE:sample

A new sample has been added to a row of a table

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
table	Table	The table
row	Row	The row
sample	Sample	The new sample

Source:

• openice.js, line 423

OpenICE:schema

A schema has been (re)assigned to a table

Type:

• object

Properties:

Name	Type	Description
openICE	OpenICE	The OpenICE object
table	Table	The table
schema	object	The new schema

Source:

• openice.js, line 435