Skip to content

Property (Cluster)

Separate from Property, this page lists the properties available only in Cluster Edition.

Index

CLUSTER_LINK_ACCEPT_TIMEOUT

Timeout until a Handshake message is received after Accept when connecting to a specific Node.

If the message is not received within the timeout, the connection fails.

The default value is 5 seconds.

(usec)Value
Minimum0
Maximum2^64 - 1
Default5000000

CLUSTER_LINK_BUFFER_SIZE

The size of the send/receive buffer.

If this size is insufficient, sending is retried until the buffer is emptied.

(byte)Value
Minimum1024768
Maximum2^32 - 1
Default33554432 (32M)

CLUSTER_LINK_CHECK_INTERVAL

Check interval of the Timeout Thread that checks the Sockets connected to a specific Node.

A Timeout Thread checks RECEIVE_TIMEOUT and SESSION_TIMEOUT.

The shorter the interval, the more often the check runs, but timeouts are still determined by the respective timeout values.

The default value is 1 second.

(usec)Value
Minimum0
Maximum2^64 - 1
Default1000000

CLUSTER_LINK_CONNECT_RETRY_TIMEOUT

Timeout during which reconnection attempts are repeated after a connection to a specific Node fails.

If the connection is not restored within the timeout, the Node is considered completely disconnected.

The default value is 1 minute.

(usec)Value
Minimum0
Maximum2^64 - 1
Default60000000

CLUSTER_LINK_CONNECT_TIMEOUT

Time to wait when trying to connect to a specific Node.

If the connection is not made within the timeout, reconnection is attempted until CLUSTER_LINK_CONNECT_RETRY_TIMEOUT has passed.

The default value is 5 seconds.

(usec)Value
Minimum0
Maximum2^64 - 1
Default5000000

CLUSTER_LINK_ERROR_ADD_ORIGIN_HOST

Selects whether to add the name of the host where the error occurred to error messages raised during communication within the Cluster.

To display detailed error messages, set this property to 1.

The default value is 1, which means the host name is displayed.

(boolean)Value
Minimum0
Maximum1
Default1

CLUSTER_LINK_HANDSHAKE_TIMEOUT

Timeout until a Handshake message is received while connected to a specific Node through a Cluster Socket.

Two Nodes that have just connected exchange small Handshake messages to check the connection status.

The accepting Node sends the Handshake message first, and this property sets how long to wait for the response.

The default value is 5 seconds.

(usec)Value
Minimum0
Maximum2^64 - 1
Default5000000

CLUSTER_LINK_HOST

Host name of the current Node used to connect to a specific Node through a Cluster Socket.

(string)Value
Defaultlocalhost

CLUSTER_LINK_LONG_TERM_CALLBACK_INTERVAL

If the Receive Callback that processes a message received on a Cluster Socket runs longer than this value, it is recognized as a Long-Term Callback.

Since the number of receive Threads is limited, a Receive Callback should not process messages for a long time.

If a Receive Callback is still processing a message after this time, it is recognized as a Long-Term Callback and recorded in the Trace Log.

The default value is 1 second.

(usec)Value
Minimum0
Maximum2^64 - 1
Default1000000

CLUSTER_LINK_LONG_WAIT_INTERVAL

If the time until a message arrives on a Cluster Socket exceeds this value, it is recognized as a Long-Wait Message.

A long time from the start to the end of receiving can indicate a problem in the network environment.

If the message has not arrived after this time, it is recognized as a Long-Wait Message and recorded in the Trace Log.

The default value is 1 second.

(usec)Value
Minimum0
Maximum2^64 - 1
Default1000000

CLUSTER_LINK_MAX_LISTEN

The maximum size of the Socket Accept Queue when connecting to a specific Node.

(count)Value
Minimum1
Maximum2^31 - 1
Default512

CLUSTER_LINK_MAX_POLL

The maximum number of Events that can be retrieved at a time by Poll when communicating with a specific Node.

(count)Value
Minimum1
Maximum2^31 - 1
Default4096

CLUSTER_LINK_PORT_NO

Port number of the current Node used to connect to a specific Node through a Cluster Socket.

(port)Value
Minimum1024
Maximum65535
Default3868

CLUSTER_LINK_RECEIVE_TIMEOUT

Timeout until the Timeout Thread determines that a connection has been lost since the last receive.

Because a connection between Cluster Nodes is closed when receiving is complete, connections in the ‘Linked List’ must keep receiving.

If the last receive time is not updated within this time, the Timeout Thread records it in the Trace Log and closes the Socket.

(usec)Value
Minimum0
Maximum2^64 - 1
Default30000000

CLUSTER_LINK_REQUEST_TIMEOUT

Timeout from sending a request message on a Cluster Socket until the response to the request is received.

For specific messages, this sets how long to wait after the request until the answer is sent.

If the response message does not arrive within this time, it is recorded in the Trace Log and the Socket is closed.

The default value is 60 seconds. The timeout is long because the kind of message and how it will be processed on the receiving side are not known in advance.

(usec)Value
Minimum0
Maximum2^64 - 1
Default60000000

CLUSTER_LINK_SEND_RETRY_COUNT

  • Available from 5.6.

Number of times to retry sending until the send buffer is emptied.

Each retry pauses for 1 ms. If retries exceed this number, the connection is closed.

The default value is 5000 retries (about 5000 msec in total from the 1 ms pauses alone).

(count)Value
Minimum0
Maximum2^32 - 1
Default5000

CLUSTER_LINK_SEND_TIMEOUT

Timeout set when sending messages through a Cluster Socket.

This timeout is applied when sending.

If sending is not completed within the timeout, it is recorded in the Trace Log.

(usec)Value
Minimum0
Maximum2^64 - 1
Default30000000

CLUSTER_LINK_SESSION_TIMEOUT

Timeout until the Timeout Thread determines that a connection has been lost since the last receive in a specific session.

A Cluster connection manages the sessions of all messages internally. This property is needed when sessions suddenly cannot be cleaned up.

If the last receive time for the session is not updated within this time, the Timeout Thread records it in the Trace Log and closes the session.

The default value is 1 hour.

(usec)Value
Minimum0
Maximum2^64 - 1
Default3600000000

CLUSTER_LINK_THREAD_COUNT

The number of Threads that process received messages when communicating with a specific Node.

If the Cluster grows or the number of operations to process increases so that no receive Thread is free, you can increase this value.

(count)Value
Minimum1
Maximum4096
Default16

CLUSTER_QUERY_STAT_LOG_ENABLE

Outputs statistics about executed queries to the trace log.

(boolean)Value
Minimum0
Maximum1
Default0

CLUSTER_REPLICATION_BLOCK_SIZE

The size of data sent at once when Replication runs for a Node being added in Cluster Edition.

The property must be applied directly to the Warehouse that becomes Replication Active (the sending Warehouse).

The default value is 640KB.

(size)Value
Minimum64 * 1024
Maximum100 * 1024 * 1024
Default640 * 1024 (655360)

CLUSTER_WAREHOUSE_DIRECT_DML_ENABLE

Allows DML to be executed by connecting directly to a Warehouse in Cluster Edition.

  • 1: Executable.
  • 0: Not executable. An error is returned.

Executing DML directly on a Warehouse has performance advantages over going through a Broker, but the DML is not propagated to the rest of the same Group. Therefore, use it only for emergency recovery from data discrepancies, or when data discrepancies within the Group are acceptable.

You must apply the property directly to each Warehouse you want.

The default value is 0.

Even if data differs between Warehouses in the Group while this property is on, the Coordinator does not check for data discrepancies.
(boolean)Value
Minimum0
Maximum1
Default0

COORDINATOR_DBS_PATH

Specifies the directory where the Coordinator data files are created.

The default value is ?/dbs, and ? is replaced with the $MACHBASE_COORDINATOR_HOME environment variable. That is, it means the $MACHBASE_COORDINATOR_HOME/dbs directory.

It must be applied to the Coordinator, and it has no effect on other Nodes.

(path)Value
Default?/dbs

COORDINATOR_DDL_REQUEST_TIMEOUT

Timeout the Coordinator waits after requesting a Node to execute DDL.

This value is the time the Coordinator waits after requesting each Node to execute DDL.

(usec)Value
Minimum0
Maximum2^64 - 1
Default300000000

COORDINATOR_DDL_TIMEOUT

Timeout the Broker waits after requesting the Coordinator to execute DDL.

This value is the time the Broker waits after requesting the Coordinator to execute DDL for the entire Cluster.

(usec)Value
Minimum0
Maximum2^64 - 1
Default300000000

COORDINATOR_DECISION_DELAY

Timeout from when the Coordinator requests a status change until the change actually takes effect.

If the status does not actually change within this time, the Cluster status is deactivated.

If the status of the Warehouse Active has not changed but a connected Standby exists, the Fail-Over operation starts.

(usec)Value
Minimum0
Maximum2^64 - 1
Default1000000

COORDINATOR_DECISION_INTERVAL

Time that determines how often the Coordinator decides on status changes.

(usec)Value
Minimum0
Maximum2^64 - 1
Default1000000

COORDINATOR_HOST_RESOURCE_ENABLE

Whether the Coordinator collects Host Resources of the Cluster Nodes.

(boolean)Value
Minimum0 (false)
Maximum1 (true)
Default0 (false)

COORDINATOR_HOST_RESOURCE_COLLECT_INTERVAL

Interval at which Cluster Nodes collect Host Resources.

(usec)Value
Minimum0
Maximum2^64 - 1
Default1000000

COORDINATOR_HOST_RESOURCE_INTERVAL

Interval at which the Coordinator exchanges Host Resources with Nodes.

(usec)Value
Minimum0
Maximum2^64 - 1
Default1000000

COORDINATOR_HOST_RESOURCE_REQUEST_TIMEOUT

Time the Coordinator waits after requesting Host Resource information from Nodes.

(usec)Value
Minimum0
Maximum2^64 - 1
Default10000000

COORDINATOR_NODE_REQUEST_TIMEOUT

Timeout the Coordinator waits after requesting a Node to execute a command.

Because this includes Node commands such as Add/Remove-node and Add/Remove-Package, setting it too short can prevent those commands from completing.

(usec)Value
Minimum0
Maximum2^64 - 1
Default600000000

COORDINATOR_NODE_TIMEOUT

Time the Coordinator waits before determining that a Node has failed.

(usec)Value
Minimum0
Maximum2^64 - 1
Default30000000

COORDINATOR_STARTUP_DELAY

Grace time from Coordinator startup until the Decision Thread is activated.

If starting the entire Cluster takes a long time, set a larger value so that the Coordinator starts controlling Nodes later.

If the Decision Thread runs before the entire Cluster is up, the Coordinator is more likely to make wrong decisions.

(usec)Value
Minimum0
Maximum2^64 - 1
Default3000000

COORDINATOR_STATUS_NODE_INTERVAL

Interval at which the Coordinator exchanges status inquiry messages with Nodes.

(usec)Value
Minimum0
Maximum2^64 - 1
Default1000000

COORDINATOR_STATUS_NODE_REQUEST_TIMEOUT

Time the Coordinator waits after sending status inquiries to Nodes.

If there is no response within this time, the Coordinator continues without updating the status of that Node.

If the network is in poor condition and the status must be updated, consider increasing this value.

However, when there is no response, the Coordinator always waits for the full, increased time.

(usec)Value
Minimum0
Maximum2^64 - 1
Default15000000

COORDINATOR_DISK_FULL_UPPER_BOUND_RATIO

If the disk usage of any server in the Cluster exceeds this value, the Warehouse group to which that host belongs enters the DISKFULL state.

Input is restricted for a group in the DISKFULL state; only queries and deletions are allowed.

If the value is 0, this feature is disabled.

(percent)Value
Minimum0
Maximum99
Default0

COORDINATOR_DISK_FULL_LOWER_BOUND_RATIO

If the disk usage of a server operating in the DISKFULL state falls below this value, the group returns to the normal state.

If the value is 0, this feature is disabled.

(percent)Value
Minimum0
Maximum99
Default0

DEPLOYER_DBS_PATH

Specifies the directory where the Deployer data files are created.

The default value is ?/dbs, and ? is replaced with the $MACHBASE_DEPLOYER_HOME environment variable. That is, it means the $MACHBASE_DEPLOYER_HOME/dbs directory.

It must be applied to the Deployer, and it has no effect on other Nodes.

(path)Value
Default?/dbs

EXECUTION_STAGE_MEMORY_MAX

The maximum amount of Memory used by a Stage Thread that executes SELECT queries in Cluster Edition.

Because this is the maximum for each Stage, complex SELECT queries with more Stages can require more memory. If a Stage exceeds the maximum size, the Stage is canceled and the Query is also canceled with an error.

You must apply the property directly to each Warehouse you want.

The default value is 1GB.

(size)Value
Minimum0
Maximum2^64 - 1
Default1024 * 1024 * 1024

HTTP_ADMIN_PORT

Port number that receives requests from MWA or machcoordinatoradmin.

(port)Value
Minimum1024
Maximum65535
Default5779

HTTP_CONNECT_TIMEOUT

Timeout used when connecting to machcoordinatoradmin.

(usec)Value
Minimum0
Maximum2^64 - 1
Default30000000

HTTP_RECEIVE_TIMEOUT

Timeout used for receiving when communicating with machcoordinatoradmin.

(usec)Value
Minimum0
Maximum2^64 - 1
Default3600000000

HTTP_SEND_TIMEOUT

Timeout used for sending when communicating with machcoordinatoradmin.

(usec)Value
Minimum0
Maximum2^64 - 1
Default60000000

INSERT_BULK_DATA_MAX_SIZE

Maximum size of an input data block when executing Append or INSERT-SELECT.

(size)Value
Minimum1024
Maximum10 * 1024 * 1024
Default1024 * 1024

INSERT_RECORD_COUNT_PER_NODE

Number of input records after which input switches to another Warehouse group.

(count)Value
Minimum1
Maximum2^32 - 1
Default1000

LOOKUPNODE_COMMAND_RETRY_MAX_COUNT

Number of retries when a command to, or a connection to, a Lookup node fails.

(count)Value
Minimum1
Maximum3600
Default30

STAGE_RESULT_BLOCK_SIZE

Maximum size of a block created in one Stage.

(size)Value
Minimum1024
Maximum2^32 - 1
Default1024 * 1024
Last updated on