Cluster

Creates a new XNET cluster.

1378

Inputs/Outputs

datatype_icon

database in

The parent database object.

database in can be an existing file. You can create a new database in memory by specifying :memory: for database in and create an entire hierarchy of objects in memory, without using a file on the disk.
datatype_icon

cluster name

The name of the cluster to create.

The name must be unique for all clusters in a database.

Lowercase letters, uppercase letters, numbers, and the underscore (_) are valid characters for the name. The space ( ), period (.), and other special characters are not supported within the name. The name must begin with a letter (uppercase or lowercase) or underscore, and not a number. The name is limited to 128 characters.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Default value: No error

datatype_icon

database out

A copy of the database in parameter. You can use this output to wire the node to subsequent nodes.

datatype_icon

cluster out

The I/O name of the newly created cluster object.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Description

This node creates an XNET cluster object. It is an instance of XNET Database Create Object.

The cluster name input becomes the Name (Short) property of the created object. This is distinct from the string contained within cluster out, which uses the syntax described in XNET Cluster I/O Name.

The cluster object is created and remains in memory until the database is closed. This node does not change the open database file on disk. To save the newly created object to the file, use XNET Database Save.