NoSQL

NoSQL Storage is a global server configuration property that defines how Iotellect Server stores its data in the NoSQL database. Its fields are mapped to the server configuration file.

Use Embedded Service

Key name in the configuration file: databaseCassandraUseEmbeddedService

Value type: Boolean

Possible values: true or false

Default value: true

If this option is enabled, Iotellect Server runs an embedded Cassandra service and uses it as the main database. If the Server IP Address parameter is set, it will be used as a listen address for the embedded Cassandra service. Otherwise, listen address will be determined automatically.

If this option is disabled, specify the Database Host option to connect to a remote Cassandra database host.

Use External YAML Configuration File

Key name in the configuration file: databaseCassandraUseYamlConfiguration

Value type: Boolean

Possible values:true or false

Default value: false

When this option is enabled, the embedded Cassandra service will load its configuration parameters not from Iotellect Server configuration (server.xml file by default) but from dedicated cassandra.yaml file in the server's installation directory. This may be needed for fine-tuning of embedded Cassandra service when the parameters from server configuration are not enough.

Database Host

Key name in the configuration file: databaseCassandraHost

Value type: String

Possible values: any valid IP address

Default value: "" (empty)

Cassandra server IP address.

Database Port

Key name in the configuration file: databaseCassandraNativePort

Value type: Integer

Possible values: 0 or more

Default value: 9042

Port used by Cassandra server for communicating with a client.

Storage Directory

Key name in the configuration file: databaseCassandraStorageDirectory

Value type: String

Possible values: any valid path

Default value: "" (empty)

Directory where primary keyspace data is stored. When left blank the directory will be placed in Iotellect installation folder.

Commitlog Directory

Key name in the configuration file: databaseCassandraCommitlogDirectory

Value type: String

Possible values: any valid path

Default value: "" (empty)

Directory where commitlogs are stored. When left blank the directory will be placed in Iotellect installation folder.

Caches Directory

Key name in the configuration file: databaseCassandraCachesDirectory

Value type: String

Possible values: any valid path

Default value: "" (empty)

Directory where cache data is stored. When left blank the directory will be placed in Iotellect installation folder.

Configuration Storage Keyspace

Key name in the configuration file: databaseCassandraConfigurationKeyspace

Value type: String

Possible values: Any valid keyspace name.

Default value: aggregate

Keyspace used by Cassandra to store configuration. Used to ensure correct single Cassandra DB instance operability with several Iotellect servers.

Event Storage Keyspace

Key name in the configuration file: databaseCassandraEventHistoryKeyspace

Value type: String

Possible values: Any valid keyspace name.

Default value: aggregate

Keyspace used by Cassandra to store event history. Used to ensure correct single Cassandra DB instance operability with several Iotellect servers.

Binary Data Storage Keyspace

Key name in the configuration file: databaseCassandraBinaryDataKeyspace

Value type: String

Possible values: Any valid keyspace name.

Default value: aggregate

Keyspace used by Cassandra to store binary data. Used to ensure correct single Cassandra DB instance operability with several Iotellect servers.

Statistics Storage Keyspace

Key name in the configuration file: databaseCassandraStatisticsKeyspace

Value type: String

Possible values: Any valid keyspace name.

Default value: aggregate

Keyspace used by Cassandra to store statistics. Used to ensure correct single Cassandra DB instance operability with several Iotellect servers.

Internal Keyspace

Key name in the configuration file: databaseCassandraInternalKeyspace

Value type: String

Possible values: Any valid keyspace name.

Default value: aggregate

Keyspace used by Cassandra to store Iotellect Server system data. Used to ensure correct single Cassandra DB instance operability with several Iotellect servers.

Replication Factor

Key name in the configuration file: databaseReplicationFactor

Value type: Integer

Possible values: 1 or more

Default value: 1

Replication factor describes how many copies of your data exist. Set this value to higher than one if you want to share your data between nodes of your NoSQL cluster.

NoSQL Cluster Seeds

Key name in the configuration file: databaseSeeds

Value type: String

Possible values: A list of IP addresses separated by commas

Default value: "" (empty)

List of nodes responsible for storing and processing of NoSQL database cluster configuration.

Batch Size

Key name in the configuration file: databaseCassandraBatchSize

Value type: Integer

Possible values: 0 or more

Default value: 0

Maximum number of changes in a batch update. Zero value disables batch updates. When enabled (value set to 1 or more), events are batched and saved to the database. Batches are saved either when they reach this size or after ten seconds of inactivity.

Batch Memory Limit

Key name in the configuration file: databaseCassandraBatchSizeThreshold

Value type: Integer

Possible values: 0 or more

Default value: 100000

Maximum size of a batch update in bytes.

Use Authentication

Key name in the configuration file: databaseCassandraUseAuthentication

Value type: Boolean

Possible values: true or false

Default value: false

Controls whether authentication is used for connections to Cassandra cluster.

Login

Key name in the configuration file: databaseCassandraLogin

Value type: String

Possible values: Any username suitable for the cassandra database

Default value: "" (empty)

The user name to use to login to Cassandra hosts.

Password

Key name in the configuration file: databaseCassandraPassword

Value type: String

Possible values: Any password suitable for the Cassandra database

Default value: "" (empty)

The password to use to login to Cassandra hosts.

Commitlog Size

Key name in the configuration file: databaseCassandraCommitlogSize

Value type: Integer

Possible values: 8,16,32

Default value: 32

Total space used for commitlogs. Smaller commitlog size tends to cause more flush activity on less-active tables.

Consistency Level

Key name in the configuration file: databaseCassandraConsistencyLevel

Value type: String

Possible values: ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE

Default value: LOCAL_ONE

Cassandra consistency level.

Contact Points

Key name in the configuration file: databaseCassandraContactPoints

Value type: String

Possible values: Comma-separated list of IP addresses or host names

Default value: ""

Cassandra contact points, i.e. cluster coordinator addresses.

Load Balancing Policy

Key name in the configuration file: databaseCassandraLoadBalancing

Value type: Data Table

Possible values: Round Robin, Latency Aware, DC Aware Round Robin

Default value: Round Robin

Cassandra load balancing policy to apply when distributing database operations:

  • Round Robin. Each new request is assigned to the next available node in the sequence.

  • Latency Aware. Route operations according to a modified round robin which prioritizes nodes with lower latencies. This policy has the following additional parameters:

    • Exclusion Threshold. When the latency or performance of a node exceeds the exclusion threshold, it may be temporarily excluded from the pool of available hosts.

    • Scale. Scalability of the primary nodes in terms of handling an increasing number of devices and resources in the cluster.

    • Period. Scaling interval.

    • Update Rate. Indicates how frequently updates or changes are made to the configuration settings of the primary nodes.

  • DC Aware Round Robin. Aims to distribute client requests among nodes in a round-robin fashion while being aware of the data center's topology. It ensures that requests are distributed across nodes within the same data center (local DC) before routing to nodes in remote data centers. This policy has the following additional parameters:

    • Local DC. Indicate the data center that is closest to the client in terms of network proximity.

    • Host Per Remote DC. Specifies the number of hosts (nodes) to be used per remote data center when setting up data replication.

    • Allow Remote DC For Local Consistency Level. Determines whether a client request can be served by nodes in remote data centers if the required data cannot be served from the local data center while still maintaining the desired consistency level.

Reconnection Policy

Key name in the configuration file: databaseCassandraReconnectionPolicy

Value type: Data Table

Possible values: Exponential or Constant for Reconnection Policy, 1 or more milliseconds for Base Delay, 1 or more milliseconds for Maximum Delay, 1 or more milliseconds for Delay

Default value: Exponential

Cassandra reconnection policy.

Read Request Timeout

Key name in the configuration file: databaseCassandraReadRequestTimeout

Value type: Integer

Possible values:

Default value: 30000

Cassandra per-host read timeout in milliseconds.

When setting this value, keep in mind the following:

  • It should be higher than the timeout settings used on the Cassandra side

  • The read timeout is only approximate and only control the timeout to one Cassandra host, not the full query

Was this page helpful?