バージョン: 3.18

ScalarDB Cluster の設定

注記

このページは英語版のページが機械翻訳されたものです。英語版との間に矛盾または不一致がある場合は、英語版を正としてください。

このドキュメントでは、ScalarDB Cluster の設定について説明します。ScalarDB Cluster は複数のクラスターノードで構成されており、各クラスターノードを設定する必要があります。設定はプロパティファイルで指定する必要があります。

クラスター設定

このセクションでは、ScalarDB Cluster の設定について説明します。

一般的な設定

ScalarDB Cluster では、次の一般的な設定が利用可能です。

トランザクション管理設定

`transaction_manager`

フィールド: scalar.db.transaction_manager
説明: ScalarDB のトランザクションマネージャー。Consensus Commit を使用するには consensus-commit を指定し、非トランザクションストレージ操作を実行するには single-crud-operation を指定します。single-crud-operation を使用する場合、scalar.db.consensus_commit プレフィックスの下の設定は無視されることに注意してください。
デフォルト値: consensus-commit

`isolation_level`

フィールド: scalar.db.consensus_commit.isolation_level
説明: Consensus Commit に使用される分離レベル。SNAPSHOT、SERIALIZABLE または READ_COMMITTED のいずれかを指定できます。
デフォルト値: SNAPSHOT

`coordinator.namespace`

フィールド: scalar.db.consensus_commit.coordinator.namespace
説明: Consensus Commit に使用される Coordinator テーブルの名前空間名。
デフォルト値: coordinator

ノード設定

`cluster.membership.type`

フィールド: scalar.db.cluster.membership.type
説明: メンバーシップの種類。現在、KUBERNETES のみ指定できます。
デフォルト値: KUBERNETES

`cluster.membership.kubernetes.endpoint.namespace_name`

フィールド: scalar.db.cluster.membership.kubernetes.endpoint.namespace_name
説明: この設定は、KUBERNETES メンバーシップタイプ用です。endpoint resource の名前空間名。
デフォルト値: default

`cluster.membership.kubernetes.endpoint.name`

フィールド: scalar.db.cluster.membership.kubernetes.endpoint.name
説明: この設定は、KUBERNETES メンバーシップタイプ用です。メンバーシップ情報を取得するための endpoint resource の名前。
デフォルト値: empty

`cluster.node.decommissioning_duration_secs`

フィールド: scalar.db.cluster.node.decommissioning_duration_secs
説明: ScalarDB Cluster ノード終了時に実際に廃止されるまでの期間 (秒単位)。
デフォルト値: 30

`cluster.node.grpc.max_inbound_message_size`

フィールド: scalar.db.cluster.node.grpc.max_inbound_message_size
説明: 受信可能な最大メッセージサイズ。
デフォルト値: gRPCのデフォルト値

`cluster.node.grpc.max_inbound_metadata_size`

フィールド: scalar.db.cluster.node.grpc.max_inbound_metadata_size
説明: 受信できるメタデータの最大サイズ。
デフォルト値: gRPCのデフォルト値

`cluster.node.port`

フィールド: scalar.db.cluster.node.port
説明: ScalarDB Cluster ノードのポート番号。
デフォルト値: 60053

`cluster.internal.node.port`

フィールド: scalar.db.cluster.internal.node.port
説明: ScalarDB Cluster ノード間の内部通信に使用される gRPC サーバーのポート番号。
デフォルト値: 60054

`cluster.node.admin.port`

フィールド: scalar.db.cluster.node.admin.port
説明: ScalarDB Cluster ノードの管理 gRPC サーバーのポート番号。このプロパティが設定されている場合、管理者サービス (pause、unpause、checkPaused) は、管理操作を他の gRPC トラフィックから分離するのに役立つ、このポートの専用 gRPC サーバーで実行されます。このプロパティが設定されていない場合、管理者サービスは他の gRPC サービス (scalar.db.cluster.node.port) と同じポートで実行されます。
デフォルト値: empty (scalar.db.cluster.node.port を使用)

`cluster.node.prometheus_exporter_port`

フィールド: scalar.db.cluster.node.prometheus_exporter_port
説明: Prometheus エクスポーターのポート番号。
デフォルト値: 9080

`cluster.grpc.deadline_duration_millis`

フィールド: scalar.db.cluster.grpc.deadline_duration_millis
説明: gRPC の期限期間 (ミリ秒単位)。
デフォルト値: 60000 (60秒)

`cluster.node.standalone_mode.enabled`

フィールド: scalar.db.cluster.node.standalone_mode.enabled
説明: スタンドアロンモードが有効かどうか。スタンドアロンモードが有効になっている場合、メンバーシップ設定 (scalar.db.cluster.membership.*) は無視されることに注意してください。
デフォルト値: false

`transaction.enabled`

フィールド: scalar.db.transaction.enabled
説明: トランザクション機能が有効かどうか。たとえば、埋め込み機能のみを使用する場合は、このプロパティを false に設定できます。
デフォルト値: true

`cluster.node.scanner_management.expiration_time_millis`

フィールド: scalar.db.cluster.node.scanner_management.expiration_time_millis
説明: ScalarDB Cluster ノードは進行中のスキャナーを管理しています。このプロセスは、リソースリークを防ぐために、長時間アイドル状態のスキャナーを期限切れにします。この設定では、このスキャナー管理機能の有効期限をミリ秒単位で指定します。
デフォルト値: 60000 (60秒)

`cluster.node.grpc.max_connection_age_millis`

フィールド: scalar.db.cluster.node.grpc.max_connection_age_millis
説明: チャネルが存在できる最大時間。古いコネクションをプロアクティブに閉じて更新し、サーバー間の不均衡を防ぐのに役立ちます。
デフォルト値: Integer.MAX_VALUE (無制限)

`cluster.node.grpc.max_connection_age_grace_millis`

フィールド: scalar.db.cluster.node.grpc.max_connection_age_grace_millis
説明: チャネルが最大期間に到達した後の猶予期間。コネクションが閉じられる前に、進行中の RPC が完了するための猶予期間を提供します。
デフォルト値: Integer.MAX_VALUE (無制限)

パフォーマンス関連の設定

Consensus Commit トランザクションマネージャーでは、次のパフォーマンス関連の設定が利用できます。

`parallel_executor_count`

フィールド: scalar.db.consensus_commit.parallel_executor_count
説明: 並列実行のためのエグゼキュータ (スレッド) の数。この数値は、ScalarDB Cluster ノード内または ScalarDB Core プロセス内のトランザクション全体のスレッド数の合計を示します。
デフォルト値: 128

`parallel_preparation.enabled`

フィールド: scalar.db.consensus_commit.parallel_preparation.enabled
説明: 準備フェーズが並行して実行されるかどうか。
デフォルト値: true

`parallel_validation.enabled`

フィールド: scalar.db.consensus_commit.parallel_validation.enabled
説明: 検証フェーズ (EXTRA_READ 内) が並列で実行されるかどうか。
デフォルト値: scalar.db.consensus_commit.parallel_commit.enabled の値

`parallel_commit.enabled`

フィールド: scalar.db.consensus_commit.parallel_commit.enabled
説明: コミットフェーズが並列で実行されるかどうか。
デフォルト値: true

`parallel_rollback.enabled`

フィールド: scalar.db.consensus_commit.parallel_rollback.enabled
説明: ロールバックフェーズが並列で実行されるかどうか。
デフォルト値: scalar.db.consensus_commit.parallel_commit.enabled の値

`async_commit.enabled`

フィールド: scalar.db.consensus_commit.async_commit.enabled
説明: コミットフェーズが非同期で実行されるかどうか。
デフォルト値: false

`async_rollback.enabled`

フィールド: scalar.db.consensus_commit.async_rollback.enabled
説明: ロールバックフェーズが非同期に実行されるかどうか。
デフォルト値: scalar.db.consensus_commit.async_commit.enabled の値

`parallel_implicit_pre_read.enabled`

フィールド: scalar.db.consensus_commit.parallel_implicit_pre_read.enabled
説明: 暗黙的な事前読み取りが並列で実行されるかどうか。
デフォルト値: true

`one_phase_commit.enabled`

フィールド: scalar.db.consensus_commit.one_phase_commit.enabled
説明: 1フェーズコミット最適化が有効かどうか。
デフォルト値: false

`coordinator.write_omission_on_read_only.enabled`

フィールド: scalar.db.consensus_commit.coordinator.write_omission_on_read_only.enabled
説明: 読み取り専用トランザクションに対して Coordinator テーブルへの書き込み省略最適化を有効にするかどうか。この最適化は、データを変更しない読み取り専用トランザクションに有効であり、Coordinator テーブルへの不要な書き込みを回避します。
デフォルト値: true

`coordinator.group_commit.enabled`

フィールド: scalar.db.consensus_commit.coordinator.group_commit.enabled
説明: トランザクション状態のコミットがバッチモードで実行されるかどうか。この機能は、2フェーズコミットインターフェースでは使用できません。
デフォルト値: false

`coordinator.group_commit.slot_capacity`

フィールド: scalar.db.consensus_commit.coordinator.group_commit.slot_capacity
説明: グループコミット機能のグループ内のスロットの最大数。値が大きいとグループコミットの効率は向上しますが、待ち時間が増加し、トランザクションの競合が発生する可能性も高くなります。¹
デフォルト値: 20

`coordinator.group_commit.group_size_fix_timeout_millis`

フィールド: scalar.db.consensus_commit.coordinator.group_commit.group_size_fix_timeout_millis
説明: グループ内のスロットのサイズを固定するためのタイムアウト。値が大きいとグループコミットの効率が向上しますが、待ち時間が増加し、トランザクションの競合が発生する可能性も高くなります。¹
デフォルト値: 40

`coordinator.group_commit.delayed_slot_move_timeout_millis`

フィールド: scalar.db.consensus_commit.coordinator.group_commit.delayed_slot_move_timeout_millis
説明: 遅延スロットをグループから別の分離グループに移動して、元のグループが遅延トランザクションの影響を受けないようにするためのタイムアウト。値が大きいとグループコミットの効率が向上しますが、待ち時間が増加し、トランザクションの競合が発生する可能性も高くなります。¹
デフォルト値: 1200

`coordinator.group_commit.old_group_abort_timeout_millis`

フィールド: scalar.db.consensus_commit.coordinator.group_commit.old_group_abort_timeout_millis
説明: 進行中の古いグループをアボートするためのタイムアウト。値が小さいと、積極的なアボートによってリソースの消費量が減りますが、長時間実行されるトランザクションで不要なアボートが発生する可能性も高くなります。
デフォルト値: 60000

`coordinator.group_commit.timeout_check_interval_millis`

フィールド: scalar.db.consensus_commit.coordinator.group_commit.timeout_check_interval_millis
説明: グループコミット関連のタイムアウトをチェックする間隔。
デフォルト値: 20

`coordinator.group_commit.metrics_monitor_log_enabled`

フィールド: scalar.db.consensus_commit.coordinator.group_commit.metrics_monitor_log_enabled
説明: グループコミットのメトリックが定期的にログに記録されるかどうか。
デフォルト値: false

ストレージ関連の設定

ScalarDB には、複数のストレージ実装をサポートするストレージ (データベース) 抽象化レイヤーがあります。scalar.db.storage プロパティを使用してストレージ実装を指定できます。

注記

複数のストレージの使用の詳細については、マルチストレージ設定を参照してください。

データベースを選択して、各ストレージで使用可能な設定を確認します。

JDBC databases
DynamoDB
Cosmos DB for NoSQL
Cassandra

JDBC データベースでは次の設定を使用できます。

`storage`

フィールド: scalar.db.storage
説明: jdbc を指定する必要があります。
デフォルト値: empty

`contact_points`

フィールド: scalar.db.contact_points
説明: JDBC 接続 URL。
デフォルト値: empty

`username`

フィールド: scalar.db.username
説明: データベースにアクセスするためのユーザー名。
デフォルト値: empty

`password`

フィールド: scalar.db.password
説明: データベースにアクセスするためのパスワード。
デフォルト値: empty

注記

次のプロパティは削除され、設定されても無視されます。これらのプロパティがまだ設定に含まれている場合は、警告メッセージを避けるために削除してください。

scalar.db.jdbc.connection_pool.max_idle
scalar.db.jdbc.table_metadata.connection_pool.max_idle
scalar.db.jdbc.admin.connection_pool.max_idle
scalar.db.jdbc.prepared_statements_pool.enabled
scalar.db.jdbc.prepared_statements_pool.max_open

`jdbc.connection_pool.min_idle`

フィールド: scalar.db.jdbc.connection_pool.min_idle
説明: コネクションプール内のアイドルコネクションの最小数。
デフォルト値: 20

`jdbc.connection_pool.max_total`

フィールド: scalar.db.jdbc.connection_pool.max_total
説明: コネクションプール内のアイドルコネクションとアクティブコネクションの最大合計数。
デフォルト値: 200

`jdbc.connection_pool.connection_timeout_millis`

フィールド: scalar.db.jdbc.connection_pool.connection_timeout_millis
説明: プールからコネクションを取得するまでの最大待機時間（ミリ秒単位）。
デフォルト値: 30000

`jdbc.connection_pool.idle_timeout_millis`

フィールド: scalar.db.jdbc.connection_pool.idle_timeout_millis
説明: コネクションがプール内でアイドル状態のまま維持される最大時間（ミリ秒単位）。この設定は min_idle が max_total より小さい場合にのみ適用されます。0 の値はアイドルコネクションが削除されないことを意味します。
デフォルト値: 600000

`jdbc.connection_pool.max_lifetime_millis`

フィールド: scalar.db.jdbc.connection_pool.max_lifetime_millis
説明: プール内のコネクションの最大生存時間（ミリ秒単位）。この生存時間を超えたコネクションは廃棄されます。この値は、データベースやインフラストラクチャによって課される任意のコネクションタイムアウトよりも数秒短く設定する必要があります。0 の値は最大生存時間がないことを意味します。
デフォルト値: 1800000

`jdbc.connection_pool.keepalive_time_millis`

フィールド: scalar.db.jdbc.connection_pool.keepalive_time_millis
説明: プールがコネクションをアライブに保とうとする間隔（ミリ秒単位）。これはデータベースやネットワークインフラストラクチャによってタイムアウトされることを防ぐためです。この値は max_lifetime_millis より小さくなければなりません。0 の値はキープアライブを無効にします。
デフォルト値: 0

`jdbc.isolation_level`

フィールド: scalar.db.jdbc.isolation_level
説明: JDBC の分離レベル。READ_COMMITTED、REPEATABLE_READ、または SERIALIZABLE を指定できます。
デフォルト値: 基盤データベース固有

`jdbc.table_metadata.connection_pool.min_idle`

フィールド: scalar.db.jdbc.table_metadata.connection_pool.min_idle
説明: テーブルメタデータのコネクションプール内のアイドルコネクションの最小数。
デフォルト値: 5

`jdbc.table_metadata.connection_pool.max_total`

フィールド: scalar.db.jdbc.table_metadata.connection_pool.max_total
説明: テーブルメタデータのコネクションプール内のアイドルコネクションとアクティブコネクションの最大合計数。
デフォルト値: 25

`jdbc.table_metadata.connection_pool.connection_timeout_millis`

フィールド: scalar.db.jdbc.table_metadata.connection_pool.connection_timeout_millis
説明: jdbc.connection_pool.connection_timeout_millis と同じですが、テーブルメタデータコネクションプール用です。
デフォルト値: 30000

`jdbc.table_metadata.connection_pool.idle_timeout_millis`

フィールド: scalar.db.jdbc.table_metadata.connection_pool.idle_timeout_millis
説明: jdbc.connection_pool.idle_timeout_millis と同じですが、テーブルメタデータコネクションプール用です。
デフォルト値: 600000

`jdbc.table_metadata.connection_pool.max_lifetime_millis`

フィールド: scalar.db.jdbc.table_metadata.connection_pool.max_lifetime_millis
説明: jdbc.connection_pool.max_lifetime_millis と同じですが、テーブルメタデータコネクションプール用です。
デフォルト値: 1800000

`jdbc.table_metadata.connection_pool.keepalive_time_millis`

フィールド: scalar.db.jdbc.table_metadata.connection_pool.keepalive_time_millis
説明: jdbc.connection_pool.keepalive_time_millis と同じですが、テーブルメタデータコネクションプール用です。
デフォルト値: 0

`jdbc.admin.connection_pool.min_idle`

フィールド: scalar.db.jdbc.admin.connection_pool.min_idle
説明: 管理者のコネクションプール内のアイドルコネクションの最小数。
デフォルト値: 5

`jdbc.admin.connection_pool.max_total`

フィールド: scalar.db.jdbc.admin.connection_pool.max_total
説明: 管理者のコネクションプール内のアイドルコネクションとアクティブコネクションの最大合計数。
デフォルト値: 25

`jdbc.admin.connection_pool.connection_timeout_millis`

フィールド: scalar.db.jdbc.admin.connection_pool.connection_timeout_millis
説明: jdbc.connection_pool.connection_timeout_millis と同じですが、管理者コネクションプール用です。
デフォルト値: 30000

`jdbc.admin.connection_pool.idle_timeout_millis`

フィールド: scalar.db.jdbc.admin.connection_pool.idle_timeout_millis
説明: jdbc.connection_pool.idle_timeout_millis と同じですが、管理者コネクションプール用です。
デフォルト値: 600000

`jdbc.admin.connection_pool.max_lifetime_millis`

フィールド: scalar.db.jdbc.admin.connection_pool.max_lifetime_millis
説明: jdbc.connection_pool.max_lifetime_millis と同じですが、管理者コネクションプール用です。
デフォルト値: 1800000

`jdbc.admin.connection_pool.keepalive_time_millis`

フィールド: scalar.db.jdbc.admin.connection_pool.keepalive_time_millis
説明: jdbc.connection_pool.keepalive_time_millis と同じですが、管理者コネクションプール用です。
デフォルト値: 0

`jdbc.db2.variable_key_column_size`

フィールド: scalar.db.jdbc.db2.variable_key_column_size
説明: IBM Db2 で主キーまたはセカンダリキーとして使用される場合の TEXT 列と BLOB 列の列サイズ。最小 64 バイト。
デフォルト値: 128

`jdbc.db2.time_column.default_date_component`

フィールド: scalar.db.jdbc.db2.time_column.default_date_component
説明: IBM Db2 で TIME データを格納するために使用される日付コンポーネントの値。ScalarDB の TIME 型データを格納するために IBM Db2 の TIMESTAMP 型が使用されるため (小数秒の精度を提供するため)、ScalarDB は比較と並べ替えを容易にするために、同じ日付コンポーネント値を持つ TIME データを保存します。
デフォルト値: 1970-01-01

`jdbc.spanner.time_column.default_date_component`

フィールド: scalar.db.jdbc.spanner.time_column.default_date_component
説明: Spanner で TIME データを格納するために使用される日付コンポーネントの値。Spanner (PostgreSQL 構文) にはネイティブの TIME 型がないため、ScalarDB は比較と並べ替えを可能にするために、固定された日付コンポーネントを持つ Spanner TIMESTAMP WITH TIME ZONE データとして TIME データを保存します。
デフォルト値: 1970-01-01

注記

SQLite3 を JDBC データベースとして使用している場合は、scalar.db.contact_points を次のように設定する必要があります。

scalar.db.contact_points=jdbc:sqlite:<SQLITE_DB_FILE_PATH>?busy_timeout=10000

他の JDBC データベースとは異なり、SQLite3 doesn't fully support concurrent access。SQLITE_BUSY によって内部的に頻繁に発生するエラーを回避するには、busy_timeout パラメータを設定することをお勧めします。

Spanner

Spanner への認証には、JSON 形式の Google Cloud サービスアカウントキーを使用する必要があります。scalar.db.password をサービスアカウントキーファイルの完全な内容として単一行 JSON で設定してください。scalar.db.username プロパティは Spanner では使用されません。ScalarDB は JVM システムプロパティ ENABLE_CREDENTIALS_PROVIDER=true も設定します。これは Spanner JDBC ドライバーが認証に必要とするものです。

例：

scalar.db.storage=jdbc
scalar.db.contact_points=jdbc:cloudspanner:/projects/<PROJECT_ID>/instances/<INSTANCE_ID>/databases/<DATABASE_ID>
scalar.db.username=
scalar.db.password=<content-of-service-account-key.json>

DynamoDB では次の設定が利用可能です。

`storage`

フィールド: scalar.db.storage
説明: dynamo を指定する必要があります。
デフォルト値: empty

`contact_points`

フィールド: scalar.db.contact_points
説明: ScalarDB が通信する AWS リージョン (例: us-east-1)。
デフォルト値: empty

`username`

フィールド: scalar.db.username
説明: AWS とやり取りするユーザーを識別するために使用される AWS アクセスキー。
デフォルト値: empty

`password`

フィールド: scalar.db.password
説明: AWS と対話するユーザーを認証するために使用される AWS シークレットアクセスキー。
デフォルト値: empty

`dynamo.endpoint_override`

フィールド: scalar.db.dynamo.endpoint_override
説明: ScalarDB が通信する Amazon DynamoDB エンドポイント。これは主に、AWS サービスではなくローカルインスタンスでのテストに使用されます。
デフォルト値: empty

`dynamo.namespace.prefix`

フィールド: scalar.db.dynamo.namespace.prefix
説明: ユーザー名前空間とメタデータ名前空間名のプレフィックス。AWS では単一の AWS リージョン内で一意のテーブル名を持つ必要があるため、単一の AWS リージョン内で複数の ScalarDB 環境 (開発、本番など) を使用する場合に便利です。
デフォルト値: empty

CosmosDB for NoSQL では次の設定が利用可能です。

`storage`

フィールド: scalar.db.storage
説明: cosmos を指定する必要があります。
デフォルト値: empty

`contact_points`

フィールド: scalar.db.contact_points
説明: ScalarDB が通信する NoSQL エンドポイント用の Azure Cosmos DB。
デフォルト値: empty

`password`

フィールド: scalar.db.password
説明: Azure Cosmos DB for NoSQL にアクセスするための認証を実行するために使用されるマスターキーまたは読み取り専用キーのいずれか。
デフォルト値: empty

`cosmos.consistency_level`

フィールド: scalar.db.cosmos.consistency_level
説明: Cosmos DB 操作に使用される一貫性レベル。STRONG または BOUNDED_STALENESS を指定できます。
デフォルト値: STRONG

Cassandra では次の設定が利用可能です。

`storage`

フィールド: scalar.db.storage
説明: cassandra を指定する必要があります。
デフォルト値: empty

`contact_points`

フィールド: scalar.db.contact_points
説明: カンマで区切られた連絡先。
デフォルト値: empty

`contact_port`

フィールド: scalar.db.contact_port
説明: すべての連絡先ポイントのポート番号。
デフォルト値: empty

`username`

フィールド: scalar.db.username
説明: データベースにアクセスするためのユーザー名。
デフォルト値: empty

`password`

フィールド: scalar.db.password
説明: データベースにアクセスするためのパスワード。
デフォルト値: empty

マルチストレージ設定

ScalarDB は複数のストレージ実装の同時使用をサポートしています。複数のストレージの使用の詳細については、マルチストレージトランザクションを参照してください。

`storage`

フィールド: scalar.db.storage
説明: multi-storage を指定する必要があります。

`multi_storage.storages`

フィールド: scalar.db.multi_storage.storages
説明: カンマ区切りのストレージ名 (例: cassandra,mysql)。これらのストレージ名は、名前空間をストレージにマップするために scalar.db.multi_storage.namespace_mapping プロパティで使用されます。
デフォルト値: empty

`multi_storage.default_storage`

フィールド: scalar.db.multi_storage.default_storage
説明: デフォルトのストレージ名。このストレージは、scalar.db.multi_storage.namespace_mapping プロパティでマッピングが定義されていない名前空間に使用されます。
デフォルト値: empty

`multi_storage.namespace_mapping`

フィールド: scalar.db.multi_storage.namespace_mapping
説明: 名前空間からストレージへのマッピング (例: user:my_cassandra,coordinator:my_mysql)。
デフォルト値: empty

ヒント

ストレージ名 (<STORAGE_NAME_FOR_NAMESPACE>) は、定義する必要がある任意の値です。マルチストレージ設定全体で一貫している限り、好きな名前を使用できます。

`multi_storage.storages.<STORAGE_NAME_FOR_NAMESPACE>.<PROPERTY_NAME>`

特定のストレージを設定するには、scalar.db.multi_storage.storages.<STORAGE_NAME_FOR_NAMESPACE>.<PROPERTY_NAME> を使用します。ここで、<STORAGE_NAME_FOR_NAMESPACE> は scalar.db.multi_storage.storages プロパティで指定されたストレージ名の1つであり、<PROPERTY_NAME> は特定のストレージのプロパティ名です。

例えば、名前空間マッピングを scalar.db.multi_storage.namespace_mapping=user:my_cassandra,coordinator:my_mysql として定義した場合、my_cassandra と my_mysql がそれぞれ user と coordinator 名前空間のストレージ名になります:

scalar.db.multi_storage.storages.my_cassandra.contact_points を使用して Cassandra のコンタクトポイントを指定できます。
scalar.db.multi_storage.storages.my_mysql.jdbc.connection_pool.min_idle を使用して MySQL のコネクションプール設定の最小アイドル接続数を指定できます。

各ストレージで使用可能なプロパティの詳細については、ストレージ関連の設定を参照してください。

パーティション間スキャン設定

以下で説明するようにパーティション間スキャンオプションを有効にすると、Scan 操作でパーティション全体のすべてのレコードを取得できます。さらに、cross_partition_scan.filtering と cross_partition_scan.ordering をそれぞれ有効にすることで、パーティション間 Scan 操作で任意の条件と順序を指定できます。現在、順序付けオプション付きのパーティション間スキャンは、JDBC データベースでのみ使用できます。フィルタリングと順序付けを有効にするには、scalar.db.cross_partition_scan.enabled を true に設定する必要があります。

パーティション間スキャンの使用方法の詳細については、スキャン操作を参照してください。

警告

非 JDBC データベースの場合、トランザクションはより低い分離レベル (つまり、SNAPSHOT) で実行される可能性があるため、SERIALIAZABLE 分離レベルでパーティション間スキャンを有効にすることはお勧めしません。非 JDBC データベースを使用する場合は、トランザクションの一貫性が重要でない場合にのみ、自己責任でパーティション間スキャンを使用してください。

`cross_partition_scan.enabled`

フィールド: scalar.db.cross_partition_scan.enabled
説明: パーティション間スキャンを有効にします。
デフォルト値: true

`cross_partition_scan.filtering.enabled`

フィールド: scalar.db.cross_partition_scan.filtering.enabled
説明: パーティション間スキャンでフィルタリングを有効にします。
デフォルト値: false

`cross_partition_scan.ordering.enabled`

フィールド: scalar.db.cross_partition_scan.ordering.enabled
説明: パーティション間スキャンで順序付けを有効にします。
デフォルト値: false

スキャンフェッチサイズ

ストレージのスキャン操作でフェッチサイズを次のプロパティで設定できます。

`scan_fetch_size`

フィールド: scalar.db.scan_fetch_size
説明: ストレージのスキャン操作時に一度に取得するレコード数を指定します。値を大きくすると、大きな結果セットの場合にストレージへのアクセスの往復回数が減りパフォーマンスが向上しますが、メモリ使用量も増加します。値を小さくするとメモリ使用量は減りますが、レイテンシが増加する場合があります。
デフォルト値: 10

ScalarDB Cluster GraphQL の設定

ScalarDB Cluster GraphQL の設定は以下の通りです。

`graphql.enabled`

フィールド: scalar.db.graphql.enabled
説明: ScalarDB Cluster GraphQL が有効かどうか。
デフォルト値: false

`graphql.port`

フィールド: scalar.db.graphql.port
説明: GraphQL サーバーのポート番号。
デフォルト値: 8080

`graphql.path`

フィールド: scalar.db.graphql.path
説明: GraphQL エンドポイントの URL のパスコンポーネント。
デフォルト値: /graphql

`graphql.namespaces`

フィールド: scalar.db.graphql.namespaces
説明: GraphQL サーバーがスキーマを生成するテーブルの名前空間のコンマ区切りリスト。指定しない場合、GraphQL サーバーは、すべての ScalarDB 管理名前空間内のすべてのテーブルのスキーマを生成します。
デフォルト値: empty

`graphql.graphiql`

フィールド: scalar.db.graphql.graphiql
説明: GraphQL サーバーが GraphiQL IDE を提供するかどうか。
デフォルト値: true

`graphql.schema_checking_interval_millis`

フィールド: scalar.db.graphql.schema_checking_interval_millis
説明: ScalarDB スキーマに変更が検出された場合に GraphQL サーバーが GraphQL スキーマを再構築する間隔 (ミリ秒単位)。
デフォルト値: 30000 (30秒)

サーバーの実行中に ScalarDB スキーマを作成または変更する

GraphQL スキーマはサーバーの起動時に静的に構築されるため、ScalarDB スキーマが変更された場合 (たとえば、テーブルが追加、変更、または削除された場合)、対応する GraphQL スキーマは再構築されない限り変更を反映しません。これに対処するために、GraphQL サーバーは、定期的なチェックとオンデマンドチェックの2つのメカニズムを提供します。

定期的なチェックを実行する

サーバーは、ScalarDB スキーマに変更が発生したかどうかを定期的にチェックし、必要に応じて対応する GraphQL スキーマを再構築します。デフォルトでは、チェックは30秒ごとに行われますが、間隔は scalar.db.graphql.schema_checking_interval_millis プロパティを使用して設定できます。

定期的なチェックを実行する必要がない場合は、プロパティ値を -1 に設定して無効にすることができます。

オンデマンドチェックを実行する

また、HTTP API の /update-graphql-schema エンドポイントに POST リクエストを実行して、サーバーに ScalarDB スキーマの変更をチェックし、必要に応じて対応する GraphQL スキーマを再構築するように要求することもできます。

たとえば、HTTP API が localhost:8080 で実行されていて、scalar.db.graphql.path プロパティが /graphql に設定されている場合、次のコマンドを実行してこのエンドポイントを呼び出すことができます。

curl -X POST http://localhost:8080/graphql/update-graphql-schema

SQL 関連の設定

ScalarDB Cluster SQL の設定は以下の通りです。

`sql.enabled`

フィールド: scalar.db.sql.enabled
説明: ScalarDB Cluster SQL が有効かどうか。
デフォルト値: false

`sql.statement_cache.enabled`

フィールド: scalar.db.sql.statement_cache.enabled
説明: ステートメントキャッシュを有効にします。
デフォルト値: false

`sql.statement_cache.size`

フィールド: scalar.db.sql.statement_cache.size
説明: キャッシュされたステートメントの最大数。
デフォルト値: 100

`sql.default_transaction_mode`

フィールド: scalar.db.sql.default_transaction_mode
説明: デフォルトのトランザクションモード。TRANSACTION または TWO_PHASE_COMMIT_TRANSACTION を設定できます。
デフォルト値: TRANSACTION

`sql.default_namespace_name`

フィールド: scalar.db.sql.default_namespace_name
説明: デフォルトの名前空間名。SQL ステートメントで名前空間名を指定しない場合は、この値が使用されます。
デフォルト値: empty

認証と認可の設定

ScalarDB Cluster の認証と認可の設定は以下の通りです。

`auth.enabled`

フィールド: scalar.db.cluster.auth.enabled
説明: 認証と認可が有効になっているかどうか。
デフォルト値: false

警告

ABAC 機能を有効にする場合は、認証と認可を有効にする必要もあります。詳細については、ユーザーの認証と認可を参照してください。

`auth.cache_expiration_time_millis`

フィールド: scalar.db.cluster.auth.cache_expiration_time_millis
説明: 認証と認可情報のキャッシュ有効期限時間 (ミリ秒単位)。
デフォルト値: 60000 (1分)

`auth.auth_token_expiration_time_minutes`

フィールド: scalar.db.cluster.auth.auth_token_expiration_time_minutes
説明: 認証と認可トークンの有効期限時間 (分単位)。
デフォルト値: 1440 (1日)

`auth.auth_token_gc_thread_interval_minutes`

フィールド: scalar.db.cluster.auth.auth_token_gc_thread_interval_minutes
説明: 認証と認可トークンのガベージコレクション (GC) スレッドの間隔 (分単位)。
デフォルト値: 360 (6時間)

`auth.pepper`

フィールド: scalar.db.cluster.auth.pepper
説明: ハッシュ化の前にパスワードに追加される秘密値。指定されていない場合、パスワードはペッパーなしでハッシュ化されます。
デフォルト値: empty

OIDC 設定

ScalarDB Cluster の OIDC 統合に使用できる設定は以下の通りです。OIDC 統合の詳細については、OIDC ベースの JWT アクセストークンを用いてユーザーアクセスを制御するを参照してください。

`auth.oidc.trusted_issuers`

フィールド: scalar.db.cluster.auth.oidc.trusted_issuers
説明: 信頼できる OIDC 発行者の URL。ScalarDB Cluster は、iss クレームがこの値と完全に一致しないトークンを拒否します。OIDC 統合を使用する場合は、このプロパティを指定する必要があります。現在、単一の発行者 URL のみがサポートされています。例: Keycloak の場合は http://localhost:8080/realms/my-realm。
デフォルト値: empty

`auth.oidc.audience.name`

フィールド: scalar.db.cluster.auth.oidc.audience.name
説明: JWT aud クレームで期待される値。ScalarDB Cluster は、aud にこの値が含まれていないトークンを拒否します。
デフォルト値: scalardb

`auth.oidc.username.claim_name`

フィールド: scalar.db.cluster.auth.oidc.username.claim_name
説明: ScalarDB ユーザー名を抽出するために使用される JWT クレーム名。OIDC 統合を使用する場合は、このプロパティを指定する必要があります。
デフォルト値: empty

`auth.oidc.jwt.access_token.require_at_jwt_typ`

フィールド: scalar.db.cluster.auth.oidc.jwt.access_token.require_at_jwt_typ
説明: RFC 9068 に従って JWT typ ヘッダーが at+jwt または application/at+jwt であることを要求するかどうか。開発目的でのみ false に設定してください。
デフォルト値: true

`auth.oidc.abac.enabled`

フィールド: scalar.db.cluster.auth.oidc.abac.enabled
説明: OIDC ABAC 統合が有効かどうか。true の場合、ScalarDB Cluster は JWT に ABAC クレームを要求し、動的な制限を適用します。ABAC クレームのないトークンは拒否されます。
デフォルト値: false

`auth.oidc.abac.claim_name`

フィールド: scalar.db.cluster.auth.oidc.abac.claim_name
説明: ABAC タグ用の JWT クレーム名。
デフォルト値: scalardb_abac

`auth.oidc.jwt.jwks.url_cache.expiration_seconds`

フィールド: scalar.db.cluster.auth.oidc.jwt.jwks.url_cache.expiration_seconds
説明: OIDC プロバイダー設定から取得した JWKS URL のキャッシュ有効期限 (秒単位)。
デフォルト値: 86400 (24時間)

`auth.oidc.jwt.jwks.content_cache.expiration_seconds`

フィールド: scalar.db.cluster.auth.oidc.jwt.jwks.content_cache.expiration_seconds
説明: フェッチされた JWKS コンテンツのキャッシュ有効期限 (秒単位)。
デフォルト値: 86400 (24時間)

`auth.oidc.jwt.max_clock_skew_seconds`

フィールド: scalar.db.cluster.auth.oidc.jwt.max_clock_skew_seconds
説明: JWT 有効期限検証における最大クロックスキュー許容時間 (秒単位)。
デフォルト値: 10

保存時データ暗号化設定

ScalarDB Cluster で保存時のデータを暗号化するための設定は以下の通りです。

保存時のデータ暗号化の詳細については、保存データの暗号化を参照してください。

`cluster.encryption.enabled`

フィールド: scalar.db.cluster.encryption.enabled
説明: ScalarDB が保存時のデータを暗号化するかどうか。
デフォルト値: false

`cluster.encryption.type`

フィールド: scalar.db.cluster.encryption.type
説明: 暗号化実装タイプ。vault（HashiCorp Vault 暗号化用）または self（自己暗号化用）のいずれかを指定できます。
デフォルト値: empty

`cluster.encryption.delete_data_encryption_key_on_drop_table.enabled`

フィールド: scalar.db.cluster.encryption.delete_data_encryption_key_on_drop_table.enabled
説明: テーブルを削除する際にデータ暗号化キー (DEK) を削除するかどうか。
デフォルト値: false

HashiCorp Vault 暗号化設定

HashiCorp Vault 暗号化（scalar.db.cluster.encryption.type=vault）を使用する場合の設定は以下の通りです。

`cluster.encryption.vault.key_type`

フィールド: scalar.db.cluster.encryption.vault.key_type
説明: キーの種類。現在、aes128-gcm96、aes256-gcm96、chacha20-poly1305 がサポートされています。キーの種類の詳細については、Key types を参照してください。
デフォルト値: aes128-gcm96

`cluster.encryption.vault.associated_data_required`

フィールド: scalar.db.cluster.encryption.vault.associated_data_required
説明: AEAD 暗号化で関連データが必要かどうか。
デフォルト値: false

`cluster.encryption.vault.address`

フィールド: scalar.db.cluster.encryption.vault.address
説明: HashiCorp Vault サーバーのアドレス。
デフォルト値: empty

`cluster.encryption.vault.token`

フィールド: scalar.db.cluster.encryption.vault.token
説明: HashiCorp Vault で認証するためのトークン。
デフォルト値: empty

`cluster.encryption.vault.namespace`

フィールド: scalar.db.cluster.encryption.vault.namespace
説明: HashiCorp Vault の名前空間。この設定はオプションです。
デフォルト値: empty

`cluster.encryption.vault.transit_secrets_engine_path`

フィールド: scalar.db.cluster.encryption.vault.transit_secrets_engine_path
説明: transit シークレットエンジンのパス。
デフォルト値: transit

`cluster.encryption.vault.column_batch_size`

フィールド: scalar.db.cluster.encryption.vault.column_batch_size
説明: HashiCorp Vault サーバーへの単一リクエストに含まれる列数。
デフォルト値: 64

自己暗号化設定

自己暗号化（scalar.db.cluster.encryption.type=self）を使用する場合の設定は以下の通りです。

`cluster.encryption.self.key_type`

フィールド: scalar.db.cluster.encryption.self.key_type
説明: キーの種類。現在、AES128_GCM、AES256_GCM、AES128_EAX、AES256_EAX、AES128_CTR_HMAC_SHA256、AES256_CTR_HMAC_SHA256、CHACHA20_POLY1305、XCHACHA20_POLY1305 がサポートされています。キーの種類の詳細については、キータイプを選択するを参照してください。
デフォルト値: AES128_GCM

`cluster.encryption.self.associated_data_required`

フィールド: scalar.db.cluster.encryption.self.associated_data_required
説明: AEAD 暗号化で関連データが必要かどうか。
デフォルト値: false

`cluster.encryption.self.kubernetes.secret.namespace_name`

フィールド: scalar.db.cluster.encryption.self.kubernetes.secret.namespace_name
説明: Kubernetes Secrets の名前空間名。
デフォルト値: default

`cluster.encryption.self.data_encryption_key_cache_expiration_time`

フィールド: scalar.db.cluster.encryption.self.data_encryption_key_cache_expiration_time
説明: DEK キャッシュの有効期限時間（ミリ秒単位）。
デフォルト値: 60000 (60秒)

ワイヤ暗号化設定

ScalarDB Cluster でワイヤ通信を暗号化するための設定は以下の通りです。

ワイヤ通信の暗号化の詳細については、ワイヤ通信の暗号化を参照してください。

`cluster.tls.enabled`

フィールド: scalar.db.cluster.tls.enabled
説明: ワイヤ暗号化 (TLS) が有効になっているかどうか。
デフォルト値: false

`cluster.tls.ca_root_cert_pem`

フィールド: scalar.db.cluster.tls.ca_root_cert_pem
説明: TLS 通信用のカスタム CA ルート証明書 (PEM データ)。
デフォルト値: empty

`cluster.tls.ca_root_cert_path`

フィールド: scalar.db.cluster.tls.ca_root_cert_path
説明: TLS 通信用のカスタム CA ルート証明書 (ファイルパス)。
デフォルト値: empty

`cluster.tls.override_authority`

フィールド: scalar.db.cluster.tls.override_authority
説明: TLS 通信用のカスタムオーソリティ。実際に接続されるホストは変更されません。これはテスト用に意図されていますが、DNS オーバーライドの代替手段として、テスト以外でも安全に使用できます。たとえば、scalar.db.cluster.node.tls.cert_chain_path に設定した証明書チェーンファイルで提示されるホスト名を指定できます。
デフォルト値: empty

`cluster.node.tls.cert_chain_path`

フィールド: scalar.db.cluster.node.tls.cert_chain_path
説明: TLS 通信に使用される証明書チェーンファイル。
デフォルト値: empty

`cluster.node.tls.private_key_path`

フィールド: scalar.db.cluster.node.tls.private_key_path
説明: TLS 通信に使用される秘密鍵ファイル。
デフォルト値: empty

ABAC 設定

属性ベースアクセス制御 (ABAC) の設定は以下の通りです。

警告

単一 CRUD 操作トランザクションマネージャーは ABAC をサポートしていません。

`abac.enabled`

フィールド: scalar.db.cluster.abac.enabled
説明: ABAC 機能が有効になっているかどうか。
デフォルト値: false

`abac.cache_expiration_time_millis`

フィールド: scalar.db.cluster.abac.cache_expiration_time_millis
説明: ABAC メタデータキャッシュのキャッシュ有効期限時間 (ミリ秒)。ABAC メタデータ (ポリシー設定など) を更新した場合、変更が適用されるまで、この有効期限時間に達するまで待つ必要がある場合があります。このプロパティを低い数値に設定すると、バックエンドデータベースへのアクセス数が増加し、パフォーマンスが低下する可能性があります。
デフォルト値: 60000 (1分)

リモートレプリケーション設定

ScalarDB Cluster のリモートレプリケーションに利用できる設定は以下の通りです。リモートレプリケーションは、高可用性とワークロード分散のために、リモートサイトへのデータレプリケーションを有効にします。

リモートレプリケーションの使用に関する詳細については、高可用性のためのデータレプリケーションを参照してください。

ベースレプリケーション設定

以下の設定は、ScalarDB Cluster における全体的なリモートレプリケーション設定に適用されます。

`partition_count`

フィールド: scalar.db.replication.partition_count
説明: transaction_groups テーブルのパーティション数。レプリケーションデータベース内のテーブルは、パフォーマンスとスケーラビリティのためにパーティション化され、書き込み操作はパーティション間に均等に分散されます。このフィールドは、プライマリサイトとバックアップサイト間で同一である必要があります。
デフォルト値: 256

警告

パーティション数の変更には、両サイトで ScalarDB Cluster を再起動する必要があります。

`repl_db.namespace`

フィールド: scalar.db.replication.repl_db.namespace
説明: レプリケーションテーブルの名前空間名。このフィールドは、プライマリサイトとバックアップサイト間で同一である必要があります。
デフォルト値: replication

`record_table_suffix`

フィールド: scalar.db.replication.record_table_suffix
説明: レプリケーションレコードメタデータテーブルの接尾辞。
デフォルト値: __records

LogWriter 設定 (プライマリサイト)

LogWriter 設定は、トランザクションコミット中にレプリケーションデータベースで書き込み操作がどのようにキャプチャおよび保存されるかを制御します。

`log_writer.enabled`

フィールド: scalar.db.replication.log_writer.enabled
説明: LogWriter 機能が有効かどうか。
デフォルト値: false

`log_writer.compression_type`

フィールド: scalar.db.replication.log_writer.compression_type
説明: レプリケーションデータベースに保存される書き込み操作の圧縮タイプ。利用可能な値: NONE、GZIP。
デフォルト値: GZIP

`log_writer.group_commit.retention.time_millis`

フィールド: scalar.db.replication.log_writer.group_commit.retention.time_millis
説明: レプリケーションデータベースのトランザクショングループをコミットするまでの最大待機時間。
デフォルト値: 100 (100ミリ秒)

`log_writer.group_commit.retention.values`

フィールド: scalar.db.replication.log_writer.group_commit.retention.values
説明: レプリケーションデータベース用にまとめてバッチ処理するトランザクションの最大数。
デフォルト値: 32

`log_writer.group_commit.timeout_check_interval_millis`

フィールド: scalar.db.replication.log_writer.group_commit.timeout_check_interval_millis
説明: レプリケーションデータベースのグループコミットタイムアウトをチェックする間隔。
デフォルト値: 20 (20ミリ秒)

`log_writer.group_commit.max_thread_pool_size`

フィールド: scalar.db.replication.log_writer.group_commit.max_thread_pool_size
説明: レプリケーションデータベースのグループコミット処理の最大スレッドプールサイズ。
デフォルト値: 4096

LogApplier 設定 (バックアップサイト)

LogApplier 設定は、レプリケーションデータがどのように処理され、バックアップサイトテーブルに適用されるかを制御します。

`log_applier.enabled`

フィールド: scalar.db.replication.log_applier.enabled
説明: LogApplier 機能が有効かどうか。
デフォルト値: false

`log_applier.transaction.expiration_millis`

フィールド: scalar.db.replication.log_applier.transaction.expiration_millis
説明: プライマリサイトからレプリケーションデータベースにレプリケートされたトランザクションの有効期限時間 (ミリ秒)。
デフォルト値: 30000 (30秒)

`log_applier.transaction_group_scanner.threads`

フィールド: scalar.db.replication.log_applier.transaction_group_scanner.threads
説明: レプリケーションデータベース内のトランザクショングループ用のスキャナースレッド数。
デフォルト値: 16

`log_applier.transaction_group_scanner.fetch_size`

フィールド: scalar.db.replication.log_applier.transaction_group_scanner.fetch_size
説明: レプリケーションデータベースから各スキャン操作で取得するトランザクショングループレコードの数。
デフォルト値: 32

`log_applier.transaction_group_scanner.wait_millis`

フィールド: scalar.db.replication.log_applier.transaction_group_scanner.wait_millis
説明: レプリケーションデータベース内のトランザクショングループのスキャン間の待機時間 (ミリ秒)。この値を増やすとスキャン頻度は減少しますが、レプリケーション遅延が増加する可能性があります。
デフォルト値: 1000 (1秒)

`log_applier.transaction_group_scanner.dedup.expiration_millis`

フィールド: scalar.db.replication.log_applier.transaction_group_scanner.dedup.expiration_millis
説明: トランザクショングループ重複排除キャッシュの有効期限時間。LogApplier は、レプリケーションデータベースから同じトランザクショングループを再処理することを避けるためにこのキャッシュを使用します。
デフォルト値: 10000 (10秒)

`log_applier.transaction_handler.threads`

フィールド: scalar.db.replication.log_applier.transaction_handler.threads
説明: LogApplier トランザクション処理のスレッド数。この値を増やすとレプリケーションパフォーマンスが向上する可能性がありますが、リソース消費量も増加します。
デフォルト値: 128

`log_applier.max_record_version`

フィールド: scalar.db.replication.log_applier.max_record_version
説明: 整数オーバーフローを防ぐための最大レコードバージョン (開発用)。
デフォルト値: Integer.MAX_VALUE - 1000 (Integer.MAX_VALUE は 2,147,483,647)

`log_applier.write_operation.expiration_millis`

フィールド: scalar.db.replication.log_applier.write_operation.expiration_millis
説明: レプリケーションレコードメタデータテーブルに保存される書き込み操作メタデータの有効期限時間 (ミリ秒)。この時間が経過すると、期限切れのメタデータはガベージコレクションの対象となります。
デフォルト値: 86400000 (1日)

`log_applier.replication_status_service.threads`

フィールド: scalar.db.replication.log_applier.replication_status_service.threads
説明: レプリケーションステータスサービスのスレッド数。
デフォルト値: 16

`log_applier.coordinator_state_cache.expiration_millis`

フィールド: scalar.db.replication.log_applier.coordinator_state_cache.expiration_millis
説明: コーディネーターステートキャッシュの有効期限時間 (ミリ秒)。LogApplier は、Coordinator データベースへのルックアップを減らすために Coordinator データベースからトランザクション状態をキャッシュします。値を小さくすると、Coordinator データベースに対するチェックがより頻繁になります。
デフォルト値: 30000 (30秒)

`log_applier.coordinator_state_cache.size`

フィールド: scalar.db.replication.log_applier.coordinator_state_cache.size
説明: コーディネーターステートキャッシュ内のエントリの最大数。このキャッシュは、Coordinator データベースへのルックアップを最適化するためにトランザクション状態を保存します。
デフォルト値: 1000

その他の ScalarDB Cluster 設定

ScalarDB Cluster で使用できる追加の設定は以下の通りです。

`metadata.cache_expiration_time_secs`

フィールド: scalar.db.metadata.cache_expiration_time_secs
説明: ScalarDB には、データベースへのリクエスト数を減らすためのメタデータキャッシュがあります。この設定では、キャッシュの有効期限を秒単位で指定します。-1を指定した場合は、キャッシュは期限切れになりません。
デフォルト値: 60

`active_transaction_management.expiration_time_millis`

フィールド: scalar.db.active_transaction_management.expiration_time_millis
説明: ScalarDB は進行中のトランザクションを管理しており、トランザクション ID を使用して再開できます。このプロセスは、リソースリークを防ぐために、長時間アイドル状態のトランザクションを期限切れにします。この設定は、このトランザクション管理機能の有効期限をミリ秒単位で指定します。
デフォルト値: 60000 (60秒)

`consensus_commit.include_metadata.enabled`

フィールド: scalar.db.consensus_commit.include_metadata.enabled
説明: Consensus Commit を使用している場合に、true に設定すると、Get および Scan 操作の結果にトランザクションメタデータが含まれます。特定のテーブルのトランザクションメタデータ列の詳細を表示するには、DistributedTransactionAdmin.getTableMetadata() メソッドを使用します。このメソッドは、トランザクションメタデータ列が追加されたテーブルメタデータを返します。この設定を使用すると、トランザクション関連の問題を調査するのに役立ちます。
デフォルト値: false

`consensus_commit.index.eventually_consistent_read.enabled`

フィールド: scalar.db.consensus_commit.index.eventually_consistent_read.enabled
説明: Consensus Commit を使用している場合に、true に設定すると、before-image インデックスチェックがスキップされ、インデックスベース読み取りは、インデックス列が同時に更新されているレコードを見逃す可能性があります。
デフォルト値: false

警告

これは後方互換性オプションであり、新しいワークロードには推奨されません。詳細については、インデックスベース読み取りの正確性を参照してください。

`default_namespace_name`

フィールド: scalar.db.default_namespace_name
説明: 指定された名前空間名は、名前空間を指定していない操作によって使用されます。
デフォルト値: empty

Java Client SDK 設定

このセクションでは、ScalarDB Cluster Java Client SDK の設定について説明します。

プリミティブインターフェースの設定

以下は、プリミティブインターフェース使用時の Java Client SDK の一般的な設定です。

`transaction_manager`

フィールド: scalar.db.transaction_manager
説明: cluster を指定する必要があります。
デフォルト値: empty

`contact_points`

フィールド: scalar.db.contact_points
説明: クラスターの接続先。indirect クライアントモードを使用する場合は、indirect:<LOAD_BALANCER_IP_ADDRESS> 形式を使用して、クラスターノードの前にあるロードバランサーの IP アドレスを指定します。direct-kubernetes クライアントモードを使用する場合は、direct-kubernetes:<NAMESPACE_NAME>/<ENDPOINT_NAME> または direct-kubernetes:<ENDPOINT_NAME> 形式を使用して、メンバーシップ情報を取得するための名前空間名 (オプション) と endpoint resource の名前を指定します。名前空間名を指定しない場合、Java Client SDK は default 名前空間を使用します。
デフォルト値: empty

注記

たとえば、indirect クライアントモードを使用し、ロードバランサーの IP アドレスが 192.168.10.1 の場合、次のように Java Client SDK を設定できます。

scalar.db.transaction_manager=cluster
scalar.db.contact_points=indirect:192.168.10.1

または、direct-kubernetes クライアントモードを使用し、エンドポイントの名前空間が ns、エンドポイント名が scalardb-cluster の場合、次のように Java Client SDK を設定できます。

scalar.db.transaction_manager=cluster
scalar.db.contact_points=direct-kubernetes:ns/scalardb-cluster

`contact_port`

フィールド: scalar.db.contact_port
説明: 接続先のポート番号。
デフォルト値: 60053

`cluster.grpc.deadline_duration_millis`

フィールド: scalar.db.cluster.grpc.deadline_duration_millis
説明: gRPC の期限期間 (ミリ秒単位)。
デフォルト値: 60000 (60秒)

`cluster.grpc.max_inbound_message_size`

フィールド: scalar.db.cluster.grpc.max_inbound_message_size
説明: 単一の gRPC フレームに許可される最大メッセージサイズ。
デフォルト値: gRPC のデフォルト値

`cluster.grpc.max_inbound_metadata_size`

フィールド: scalar.db.cluster.grpc.max_inbound_metadata_size
説明: 受信できるメタデータの最大サイズ。
デフォルト値: gRPC のデフォルト値

`cluster.client.scan_fetch_size`

フィールド: scalar.db.cluster.client.scan_fetch_size
説明: クラスターからデータを取得するために Scanner で使用されるフェッチサイズ。これは、Scanner がクラスターから一度に取得するレコード数です。値を大きくすると、クラスターへの往復回数が減ってパフォーマンスが向上しますが、メモリ使用量も増加する可能性があります。
デフォルト値: 10

`cluster.client.piggyback_begin.enabled`

フィールド: scalar.db.cluster.client.piggyback_begin.enabled
説明: ピギーバック begin 機能が有効かどうか。最初の CRUD 操作までトランザクション begin を遅延させ、最初の操作と begin をピギーバックして、専用の begin RPC 呼び出しを削除します。
デフォルト値: false

`cluster.client.write_buffering.enabled`

フィールド: scalar.db.cluster.client.write_buffering.enabled
説明: 書き込みバッファリング機能が有効かどうか。非条件書き込み操作 (挿入、アップサート、無条件 put/update/delete) をバッファリングし、バッチで実行することでRPC呼び出し数を減らします。
デフォルト値: false

警告

piggyback_begin が有効な場合、実際の開始操作が実行されるまで DistributedTransaction.getId() メソッドを呼び出すと IllegalStateException が発生します。
piggyback_begin または write_buffering が有効な場合、DistributedTransactionManager.resume() および DistributedTransactionManager.join() メソッドを呼び出すと常に IllegalStateException が発生します。

認証と認可の設定

以下は、プリミティブインターフェース使用時の Java Client SDK の認証と認可の設定です。

プリミティブインターフェース使用時の Java Client SDK を使用するアプリケーションやツール(クラスター用 Schema Loader や ScalarDB ベンチマークツールなど) を実行する場合、特にクラスターで認証と認可が有効になっている場合は、クライアント側の database.properties ファイルに次の設定を行う必要があります。

`auth.enabled`

フィールド: scalar.db.cluster.auth.enabled
説明: 認証と認可が有効になっているかどうか。
デフォルト値: false

`username`

フィールド: scalar.db.username
説明: ScalarDB Cluster にアクセスするためのユーザー名。OIDC JWT 認証を使用する場合は不要です。
デフォルト値: empty

`password`

フィールド: scalar.db.password
説明: ScalarDB Cluster にアクセスするためのパスワード。OIDC JWT 認証を使用する場合は不要です。
デフォルト値: empty

`cluster.client.auth.type`

フィールド: scalar.db.cluster.client.auth.type
説明: 認証タイプ。userpass はユーザー名とパスワードでの認証を使用します。oidc_jwt は OIDC JWT ベースのアクセス制御を使用します。oidc_jwt の詳細については、OIDC ベースの JWT アクセストークンを用いてユーザーアクセスを制御するを参照してください。
デフォルト値: empty (userpass として処理されます)

`auth.oidc_jwt.access_token`

フィールド: scalar.db.cluster.client.auth.oidc_jwt.access_token
説明: OIDC アクセス制御用の JWT アクセストークン。トークンは初期化時に設定されるため、リフレッシュすることはできず、JWT アクセストークンの有効期限の間のみ有効です。
デフォルト値: empty

ワイヤ暗号化の設定

以下の設定は Java Client SDK のワイヤ暗号化に利用できます。

ワイヤ通信の暗号化の詳細については、ワイヤ通信の暗号化を参照してください。

`cluster.tls.enabled`

フィールド: scalar.db.cluster.tls.enabled
説明: Java Client SDK でワイヤ暗号化 (TLS) が有効になっているかどうか。
デフォルト値: false

`cluster.tls.ca_root_cert_pem`

フィールド: scalar.db.cluster.tls.ca_root_cert_pem
説明: TLS 通信用のカスタム CA ルート証明書 (PEM データ)。
デフォルト値: empty

`cluster.tls.ca_root_cert_path`

フィールド: scalar.db.cluster.tls.ca_root_cert_path
説明: TLS 通信用のカスタム CA ルート証明書 (ファイルパス)。
デフォルト値: empty

`cluster.tls.override_authority`

フィールド: scalar.db.cluster.tls.override_authority
説明: TLS 通信用のカスタムオーソリティ。実際に接続されるホストは変更されません。これはテスト用に意図されていますが、DNS オーバーライドの代替手段として、テスト以外でも安全に使用できます。たとえば、scalar.db.cluster.node.tls.cert_chain_path に設定した証明書チェーンファイルで提示されるホスト名を指定できます。これは、クラスターの TLS 証明書のパスです。
デフォルト値: empty

SQL インターフェースの設定

以下は、SQL インターフェース使用時の Java Client SDK の設定です。

`sql.connection_mode`

フィールド: scalar.db.sql.connection_mode
説明: cluster を指定する必要があります。
デフォルト値: empty

`sql.cluster_mode.contact_points`

フィールド: scalar.db.sql.cluster_mode.contact_points
説明: クラスターの接続先。indirect クライアントモードを使用する場合は、indirect:<LOAD_BALANCER_IP_ADDRESS> 形式を使用して、クラスターノードの前にあるロードバランサーの IP アドレスを指定します。direct-kubernetes クライアントモードを使用する場合は、direct-kubernetes:<NAMESPACE_NAME>/<ENDPOINT_NAME> または direct-kubernetes:<ENDPOINT_NAME> 形式を使用して、メンバーシップ情報を取得するための名前空間名 (オプション) と endpoint resource の名前を指定します。名前空間名を指定しない場合、 Java Client SDK は default 名前空間を使用します。
デフォルト値: empty

注記

たとえば、indirect クライアントモードを使用し、ロードバランサーの IP アドレスが 192.168.10.1 の場合、次のように Java Client SDK を設定できます。

scalar.db.sql.connection_mode=cluster
scalar.db.sql.cluster_mode.contact_points=indirect:192.168.10.1

scalar.db.sql.connection_mode=cluster
scalar.db.sql.cluster_mode.contact_points=direct-kubernetes:ns/scalardb-cluster

ScalarDB JDBC の設定方法の詳細については、JDBC 接続 URL を参照してください。

Spring Data JDBC for ScalarDB の設定方法の詳細については、設定を参照してください。

`sql.cluster_mode.contact_port`

フィールド: scalar.db.sql.cluster_mode.contact_port
説明: 接続先のポート番号。
デフォルト値: 60053

`sql.default_transaction_mode`

フィールド: scalar.db.sql.default_transaction_mode
説明: デフォルトのトランザクションモード。TRANSACTION または TWO_PHASE_COMMIT_TRANSACTION を設定できます。
デフォルト値: TRANSACTION

`sql.default_namespace_name`

フィールド: scalar.db.sql.default_namespace_name
説明: デフォルトの名前空間名。SQL ステートメントで名前空間名を指定しない場合は、この値が使用されます。
デフォルト値: empty

`cluster.grpc.deadline_duration_millis`

フィールド: scalar.db.cluster.grpc.deadline_duration_millis
説明: gRPC の期限期間 (ミリ秒単位)。
デフォルト値: 60000 (60秒)

`cluster.grpc.max_inbound_message_size`

フィールド: scalar.db.cluster.grpc.max_inbound_message_size
説明: 単一の gRPC フレームに許可される最大メッセージサイズ。
デフォルト値: gRPC のデフォルト値

`cluster.grpc.max_inbound_metadata_size`

フィールド: scalar.db.cluster.grpc.max_inbound_metadata_size
説明: 受信できるメタデータの最大サイズ。
デフォルト値: gRPC のデフォルト値

`sql.cluster_mode.client.piggyback_begin.enabled`

フィールド: scalar.db.sql.cluster_mode.client.piggyback_begin.enabled
説明: SQL トランザクションのピギーバック開始機能が有効かどうか。最初の実行操作までトランザクション開始を遅延し、最初の操作で開始をピギーバックして専用の開始 RPC 呼び出しを排除します。
デフォルト値: false

`sql.cluster_mode.client.write_buffering.enabled`

フィールド: scalar.db.sql.cluster_mode.client.write_buffering.enabled
説明: SQL トランザクションの書き込みバッファリング機能が有効かどうか。クライアント側で INSERT および UPSERT ステートメントをバッファリングし、バッチで実行することで RPC 呼び出し数を削減します。
デフォルト値: false

警告

piggyback_begin が有効な場合、実際の開始操作が実行されるまで SqlSession.getTransactionId() は Optional.empty() を返します。
piggyback_begin または write_buffering が有効な場合、SqlSession.resume() および SqlSession.join() メソッドを呼び出すと常に IllegalStateException が発生します。

認証と認可の設定

以下は、SQL インターフェース使用時の Java Client SDK の認証と認可の設定です。

`auth.enabled`

フィールド: scalar.db.cluster.auth.enabled
説明: 認証と認可が有効になっているかどうか。
デフォルト値: false

`auth.username`

フィールド: scalar.db.sql.cluster_mode.username
説明: ScalarDB Cluster にアクセスするためのユーザー名。OIDC JWT 認証を使用する場合は不要です。
デフォルト値: empty

`auth.password`

フィールド: scalar.db.sql.cluster_mode.password
説明: ScalarDB Cluster にアクセスするためのパスワード。OIDC JWT 認証を使用する場合は不要です。
デフォルト値: empty

`auth.type`

フィールド: scalar.db.sql.cluster_mode.auth.type
説明: 認証タイプ。userpass はユーザー名とパスワードでの認証を使用します。oidc_jwt は OIDC JWT ベースのアクセス制御を使用します。oidc_jwt の詳細については、OIDC ベースの JWT アクセストークンを用いてユーザーアクセスを制御するを参照してください。
デフォルト値: empty (userpass として処理されます)

`auth.oidc_jwt.access_token`

フィールド: scalar.db.sql.cluster_mode.auth.oidc_jwt.access_token
説明: OIDC アクセス制御用の JWT アクセストークン。トークンは初期化時に設定されるため、リフレッシュすることはできず、JWT アクセストークンの有効期限の間のみ有効です。
デフォルト値: empty

設定例 - アプリ、ScalarDB Cluster、データベース

この設定例では、アプリ (gRPC を利用する ScalarDB ライブラリ) が ScalarDB Cluster を通じて基盤となるストレージまたはデータベース (この場合は Cassandra) に接続しています。ScalarDB Cluster は、ScalarDB Enterprise エディションでのみ利用可能なコンポーネントです。

注記

この設定は、ScalarDB Cluster が Scalar Admin インターフェースを実装しているため、本番環境での使用に適しています。このインターフェースにより、ScalarDB Cluster を一時停止することで、ScalarDB のトランザクション的に一貫性のあるバックアップを作成できます。

アプリを ScalarDB Cluster を通じて基盤となるデータベースに接続する設定例を以下に示します。

# トランザクションマネージャーの実装。
scalar.db.transaction_manager=cluster

# クラスターの接続先。
scalar.db.contact_points=indirect:<SCALARDB_CLUSTER_CONTACT_POINT>

Java Client SDK 設定の詳細については、ScalarDB Cluster の Java Client SDK 設定を参照してください。

アプリケーションのアクセスパターンを考慮し、アプリケーションで使用するストレージと同じストレージを使用して、いくつかのバリエーション (例: デフォルト値の75%と125%) でパフォーマンスをベンチマークし、最適な設定を決定することをお勧めします。適切な設定は、これらの要素に強く依存して決まります。また、最適な組み合わせを決定するために、これらのパラメータの組み合わせをベンチマークすることも重要です (例: 最初に slot_capacity:20 と group_size_fix_timeout_millis:40、次に slot_capacity:30 と group_size_fix_timeout_millis:40、3番目に slot_capacity:20 と group_size_fix_timeout_millis:80)。 ↩ ↩² ↩³

クラスター設定​

一般的な設定​

トランザクション管理設定​

transaction_manager​

isolation_level​

coordinator.namespace​

ノード設定​

cluster.membership.type​

cluster.membership.kubernetes.endpoint.namespace_name​

cluster.membership.kubernetes.endpoint.name​

cluster.node.decommissioning_duration_secs​

cluster.node.grpc.max_inbound_message_size​

cluster.node.grpc.max_inbound_metadata_size​

cluster.node.port​

cluster.internal.node.port​

cluster.node.admin.port​

cluster.node.prometheus_exporter_port​

cluster.grpc.deadline_duration_millis​

cluster.node.standalone_mode.enabled​

transaction.enabled​

cluster.node.scanner_management.expiration_time_millis​

cluster.node.grpc.max_connection_age_millis​

cluster.node.grpc.max_connection_age_grace_millis​

パフォーマンス関連の設定​

parallel_executor_count​

parallel_preparation.enabled​

parallel_validation.enabled​

parallel_commit.enabled​

parallel_rollback.enabled​

async_commit.enabled​

async_rollback.enabled​

parallel_implicit_pre_read.enabled​

one_phase_commit.enabled​

coordinator.write_omission_on_read_only.enabled​

coordinator.group_commit.enabled​

coordinator.group_commit.slot_capacity​

coordinator.group_commit.group_size_fix_timeout_millis​

coordinator.group_commit.delayed_slot_move_timeout_millis​

coordinator.group_commit.old_group_abort_timeout_millis​

coordinator.group_commit.timeout_check_interval_millis​

coordinator.group_commit.metrics_monitor_log_enabled​

ストレージ関連の設定​

storage

contact_points

username

password

jdbc.connection_pool.min_idle

jdbc.connection_pool.max_total

jdbc.connection_pool.connection_timeout_millis

jdbc.connection_pool.idle_timeout_millis

jdbc.connection_pool.max_lifetime_millis

jdbc.connection_pool.keepalive_time_millis

jdbc.isolation_level

jdbc.table_metadata.connection_pool.min_idle

jdbc.table_metadata.connection_pool.max_total

jdbc.table_metadata.connection_pool.connection_timeout_millis

jdbc.table_metadata.connection_pool.idle_timeout_millis

jdbc.table_metadata.connection_pool.max_lifetime_millis

jdbc.table_metadata.connection_pool.keepalive_time_millis

jdbc.admin.connection_pool.min_idle

jdbc.admin.connection_pool.max_total

jdbc.admin.connection_pool.connection_timeout_millis

jdbc.admin.connection_pool.idle_timeout_millis

jdbc.admin.connection_pool.max_lifetime_millis

jdbc.admin.connection_pool.keepalive_time_millis

jdbc.db2.variable_key_column_size

jdbc.db2.time_column.default_date_component

jdbc.spanner.time_column.default_date_component

storage

contact_points

username

password

dynamo.endpoint_override

dynamo.namespace.prefix

storage

contact_points

password

cosmos.consistency_level

storage

contact_points

クラスター設定

一般的な設定

トランザクション管理設定

`transaction_manager`

`isolation_level`

`coordinator.namespace`

ノード設定

`cluster.membership.type`

`cluster.membership.kubernetes.endpoint.namespace_name`

`cluster.membership.kubernetes.endpoint.name`

`cluster.node.decommissioning_duration_secs`

`cluster.node.grpc.max_inbound_message_size`

`cluster.node.grpc.max_inbound_metadata_size`

`cluster.node.port`

`cluster.internal.node.port`

`cluster.node.admin.port`

`cluster.node.prometheus_exporter_port`

`cluster.grpc.deadline_duration_millis`

`cluster.node.standalone_mode.enabled`

`transaction.enabled`

`cluster.node.scanner_management.expiration_time_millis`

`cluster.node.grpc.max_connection_age_millis`

`cluster.node.grpc.max_connection_age_grace_millis`

パフォーマンス関連の設定

`parallel_executor_count`

`parallel_preparation.enabled`

`parallel_validation.enabled`

`parallel_commit.enabled`

`parallel_rollback.enabled`

`async_commit.enabled`

`async_rollback.enabled`

`parallel_implicit_pre_read.enabled`

`one_phase_commit.enabled`

`coordinator.write_omission_on_read_only.enabled`

`coordinator.group_commit.enabled`

`coordinator.group_commit.slot_capacity`

`coordinator.group_commit.group_size_fix_timeout_millis`

`coordinator.group_commit.delayed_slot_move_timeout_millis`

`coordinator.group_commit.old_group_abort_timeout_millis`

`coordinator.group_commit.timeout_check_interval_millis`

`coordinator.group_commit.metrics_monitor_log_enabled`

ストレージ関連の設定

`storage`

`contact_points`

`username`

`password`

`jdbc.connection_pool.min_idle`

`jdbc.connection_pool.max_total`

`jdbc.connection_pool.connection_timeout_millis`

`jdbc.connection_pool.idle_timeout_millis`

`jdbc.connection_pool.max_lifetime_millis`

`jdbc.connection_pool.keepalive_time_millis`

`jdbc.isolation_level`

`jdbc.table_metadata.connection_pool.min_idle`

`jdbc.table_metadata.connection_pool.max_total`

`jdbc.table_metadata.connection_pool.connection_timeout_millis`

`jdbc.table_metadata.connection_pool.idle_timeout_millis`

`jdbc.table_metadata.connection_pool.max_lifetime_millis`

`jdbc.table_metadata.connection_pool.keepalive_time_millis`

`jdbc.admin.connection_pool.min_idle`

`jdbc.admin.connection_pool.max_total`

`jdbc.admin.connection_pool.connection_timeout_millis`

`jdbc.admin.connection_pool.idle_timeout_millis`

`jdbc.admin.connection_pool.max_lifetime_millis`

`jdbc.admin.connection_pool.keepalive_time_millis`

`jdbc.db2.variable_key_column_size`

`jdbc.db2.time_column.default_date_component`

`jdbc.spanner.time_column.default_date_component`

`storage`

`contact_points`

`username`

`password`

`dynamo.endpoint_override`

`dynamo.namespace.prefix`

`storage`

`contact_points`

`password`

`cosmos.consistency_level`

`storage`

`contact_points`