This document describes the configurations for ScalarDB Cluster. ScalarDB Cluster consists of multiple cluster nodes, and you need to configure each cluster node.

In addition to the configurations described in Transaction manager configurations and Other configurations, you can configure the following configurations for each cluster node.

Basic configurations

The basic configurations for a cluster node are as follows:

Name Description Default
scalar.db.cluster.membership.type Membership type. Currently, only KUBERNETES can be specified. KUBERNETES
scalar.db.cluster.membership.kubernetes.endpoint.namespace_name This configuration is for the KUBERNETES membership type. Namespace name for the endpoint resource. default
scalar.db.cluster.membership.kubernetes.endpoint.name This configuration is for the KUBERNETES membership type. Name of the endpoint resource to get the membership info.  
scalar.db.cluster.node.decommissioning_duration_secs Decommissioning duration in seconds. 30
scalar.db.cluster.node.grpc.max_inbound_message_size Maximum message size allowed to be received. The gRPC default value
scalar.db.cluster.node.grpc.max_inbound_metadata_size Maximum size of metadata allowed to be received. The gRPC default value
scalar.db.cluster.node.port Port number of the ScalarDB Cluster node. 60053
scalar.db.cluster.node.prometheus_exporter_port Port number of the Prometheus exporter. 9080
scalar.db.cluster.grpc.deadline_duration_millis Deadline duration for gRPC in milliseconds. 60000 (60 seconds)
scalar.db.cluster.node.standalone_mode.enabled Whether standalone mode is enabled. Note that if standalone mode is enabled, the membership configurations (scalar.db.cluster.membership.*) will be ignored. false

ScalarDB Cluster GraphQL Configurations

The configurations for ScalarDB Cluster GraphQL are as follows:

Name Description Default
scalar.db.graphql.enabled Whether ScalarDB Cluster GraphQL is enabled. false
scalar.db.graphql.port Port number of the GraphQL server. 8080
scalar.db.graphql.path Path component of the URL of the GraphQL endpoint. /graphql
scalar.db.graphql.namespaces Comma-separated list of namespaces of tables for which the GraphQL server generates a schema. Note that at least one namespace is required.  
scalar.db.graphql.graphiql Whether the GraphQL server serves GraphiQL IDE. true
scalar.db.graphql.schema_checking_interval_millis Interval in milliseconds at which GraphQL server will rebuild the GraphQL schema if any change is detected in the ScalarDB schema. 30000 (30 seconds)

ScalarDB Cluster SQL Configurations

The configurations for ScalarDB Cluster SQL are as follows:

Name Description Default
scalar.db.sql.enabled Whether ScalarDB Cluster SQL is enabled. false
scalar.db.sql.statement_cache.enabled Enable the statement cache. false
scalar.db.sql.statement_cache.size Maximum number of cached statements. 100