Open topic with navigation

TIBCO ActiveSpaces® - Enterprise Edition 5.0.0

# Grid Create Configuration Options

The following configuration options can be used with the tibdg grid create command.

Warning: Properties that affect only a specific process type might only require restarting of that process type, but in general TIBCO recommends that you restart a grid whenever you update a property. For example, updating a proxy property does not require restarting a grid. In this case, it would suffice to restart only the proxy.

Option | Description | Default Value | Valid Values
--- | --- | --- | ---
`checkpoint_interval` | The interval, in seconds, between periodic checkpoints. The default value of 0.0 seconds disables periodic checkpoints. Warning: Checkpoints require additional space on disk, so care must be taken to avoid taking checkpoints frequently, as this can lead to a rapid increase in disk usage. | `0.0` |
`checkpoint_list_compression` | Enabling this option causes a reduction in the size of the list of checkpoint-related metadata written to disk by the state keepers and nodes. By default, this option is enabled for new grids and requires no change in checkpoint recovery procedures. For existing grids that are upgrading to this version, this feature is not enabled by default. To use this feature on existing grids, an administrator must first make sure that all the grid processes have been upgraded. After all the grid processes are upgraded, run the following command:
    tibdg grid modify checkpoint_list_compression=enabled
You do not need to restart the grid processes to see this change. Only checkpoints taken after this property is modified apply compression to the metadata. | `enabled` | `enabled` `disabled`
`checkpoint_retention_limit` | The number of checkpoints (manual and periodic) to keep at a time. When the total number of checkpoints (manual and periodic) on disk exceeds the value of `checkpoint_retention_limit`, the oldest checkpoint is deleted. The default value of `0` indicates that all checkpoints must be kept. To determine the proper setting for this option, multiply the `checkpoint_retention_limit` by the `checkpoint_interval`. This value indicates the duration (in seconds) for a checkpoint is retained. This option must typically be set to a small number to avoid excessive disk usage. | `0` | Minimum: `0`
`client_req_timeout` | The time (in seconds) the client API synchronously waits for completion of a request (such as GET or PUT operation), before timing out. | `5.0` | Minimum:`0.0`
`compaction` | A value less than six indicates more emphasis on performance and less on the compaction of the disk space. Conversely, a higher value indicates more emphasis on the compaction of the disk space than performance. | `7` | Minimum: `1` Maximum: `10`
`consistent_query_limit` | The maximum number of iterators and statements (queries) that a node can handle concurrently. | `64` | Minimum: `1`
`copyset_size` | The number of nodes in a copyset. | `2` | Minimum: `1`
`encrypted_connections` | Specifies which connections in the data grid get encrypted. | `none` | `all` or `none`
`expiration_scanner_max_rows` | Determines the maximum number of rows that are expired each time a table is scanned for expired rows. | `1000000` | Minimum: `1`
`expiration_scanner_wakeup` | Determines how frequently the leader of each copyset scans a table for rows to expire. The unit of measurement is in seconds. | `5` | Minimum: `1`
`full_table_delete` | Defines the behavior when a SQL DELETE statement is created which does not contain a WHERE clause. Execution of a SQL DELETE statement without a WHERE clause deletes all rows of a table. This option takes one of the following values: `warn` (default): A warning is logged by the proxy when a SQL DELETE statement without a WHERE clause is created. All rows of any user tables in the grid can be deleted. `enabled`: A debug message is logged by the proxy when a SQL DELETE statement without a WHERE clause is created. All rows of any user tables in the grid can be deleted. `disabled`: Prevents creation of any SQL DELETE statement that does not contain a WHERE clause. Note: The `full_table_scans=disabled` setting prevents running of a SQL DELETE statement without a WHERE clause, regardless of the setting for `full_table_delete`. The setting also prevents the execution of a SQL DELETE statement with a WHERE clause when an index cannot be found for the columns in the WHERE clause. | `warn` | `warn` `enabled` `disabled`
`full_table_scans` | Defines the behavior when processing a query that requires a full table scan. This option takes one of the following values: `warn` (default): A warning is logged when a query performs a full table scan. `enabled`: Logs a debug message when a query performs a full table scan. The behavior of this option is similar to that in the previous versions of ActiveSpaces. `disabled`: Prevents a query from running a full table scan. An exception is generated if queries try to perform a full table scan. Note: The `full_table_scans=disabled` setting prevents the execution of SQL DELETE and UPDATE statements without a WHERE clause. The setting also prevents the execution of SQL DELETE and UPDATE statements with a WHERE clause when an index cannot be found for the columns in the WHERE clause. | `warn` | `warn` `enabled` `disabled`
`grid_internal_subnet_mask` | See Configure Internal Subnet Masks. | `none` | See Configure Internal Subnet Masks.
`iter_inactivity_timeout` | The time, in seconds, taken by the proxy to wait for the next client request on a table iterator or statement query before automatically closing the table iterator or statement query. | `600.0` | Minimum: `0.0`
`minimum_replication_factor` | The minimum number of nodes (including the primary and any secondary nodes) in a copyset that must be in the `Alive` state before `WRITE` operations are allowed. | `1` | Minimum: `1`
`mirroring_max_batch_size_rows` | The maximum rows in a batch that is mirrored collectively to the mirror grid. This size must be an integer >=1. It can typically be left at the default value unless transport loss is seen during mirroring operations. If transport loss is experienced during mirroring, this value must be reduced. | `256` |
`mirroring_interval` | The default mirroring interval (in seconds). This option determines how frequently a mirror grid checks for new checkpoints to be mirrored. Setting this option to 0 disables mirroring. | `30.0` |
`node_detailed_stats_collection` | Retrieves detailed statistics of a node configuration. The option can take one of the following values: `enabled` or `disabled`. When this option is enabled, the nodes enable extra statistics collection around all disk operations. The statistics can be retrieved by using the tibdg node status command. Additionally, these statistics are logged to the node log at the `status:verbose` level once every 60 seconds. Enabling `node_detailed_stats_collection` results in a 5-10% performance penalty. `node_detailed_stats_collection` is disabled by default. | `disabled` | `enabled` `disabled`
`node_read_cache_size` | Every node stores a read cache that holds uncompressed blocks of data in memory. The size of a read cache is specified in bytes. There are some memory usage considerations to be made when using this option. For details, see Memory Usage Considerations with the node_read_cache_size Option. | `1073741824 (1 gigabyte)` | Minimum: `0` Maximum: `92233720368547 75806` (`LLONG_MAX - 1`)
`node_storage_timeout` | The time (in seconds) a node waits for a successful response from a READ or WRITE operation to complete before timing it out. | `60` | Minimum: `0`
`permissions` | You can enable or disable permissions on tables in a data grid to control who has access to the data in the tables. For details, see Grid and Table Permissions. | `disabled` | `enabled` `disabled`
`proxy_checkpoint_cache_size` | See Caching Proxy Rows by Using Checkpoints. | `0` | Minimum: `0`
`proxy_client_listen_external_host` | The host name or the IP address that external clients connect to when attempting to reach a proxy. See Configuration Options when the Proxy and Client are on Different Subnets. | `none` |
`proxy_client_listen_external_port` | This is the default port that external clients connect to when attempting to reach a proxy. See Configuration Options when the Proxy and Client are on Different Subnets. | `none` |
`proxy_client_listen_subnet_mask` | See Configure Network Interfaces | `none` | See Configure Network Interfaces.
`proxy_client_listen_port` | See Configure Ports. | `none` | See Configure Ports.
`statekeeper_count` | The number of state keeper processes that are expected to be run. Due to the requirement that state keepers must be run in a quorum, the supported values are 1, 3, 5, 7, and 9. | `3` | Minimum: `1`

Subtopics

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO ActiveSpaces® - Enterprise Edition

Copyright © 2009-2025. Cloud Software Group, Inc. All Rights Reserved.