Skip to content

Commit 3ebf49b

Browse files
DOC-10413: Document REST endpoint to change LSS segment size (#200)
* Add LSS Segment File Size * Minor Vale updates * Update links * Update units * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <tech-comm-team@couchbase.com>
1 parent dbbc65a commit 3ebf49b

2 files changed

Lines changed: 45 additions & 4 deletions

File tree

docs/modules/index-rest-settings/attachments/_index-settings.yaml

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,23 @@ components:
9090
Settings:
9191
type: object
9292
properties:
93+
indexer.plasma.LSSSegmentFileSize:
94+
x-alt-title: indexer.&#8203;plasma.&#8203;LSSSegmentFileSize
95+
type: integer
96+
format: int32
97+
x-has-example: true
98+
example: 67108864
99+
description: |-
100+
For standard indexes using Plasma, the maximum size for Log Structured Store segment files, in bytes.
101+
Index compaction and space reclamation are triggered when the segment file size reaches this value.
102+
103+
The default value is 512&nbsp;MiB on Microsoft Windows and 4&nbsp;GiB on GNU Linux and macOS.
104+
Specifying a lower value (for example, 64&nbsp;MiB) may trigger index compaction more frequently in cases where an index uses a lot of disk space, or index fragmentation is high.
105+
106+
This setting only applies to indexes created after the setting is changed.
107+
For existing indexes, you must rebuild the index after changing the setting.
108+
109+
For more information, see [Standard Index Storage](/server/8.0/indexes/storage-modes.html#standard-index-storage).
93110
indexer.rebalance.transferBatchSize:
94111
x-alt-title: indexer.&#8203;rebalance.&#8203;transferBatchSize
95112
type: integer
@@ -279,7 +296,7 @@ components:
279296
description: |-
280297
Whether Bloom filters are enabled for memory management.
281298
282-
For details, see [Per Page Bloom Filters](/server/8.0/learn/services-and-indexes/indexes/storage-modes.html#per-page-bloom-filters).
299+
For more information, see [Per Page Bloom Filters](/server/8.0/indexes/storage-modes.html#per-page-bloom-filters).
283300
indexer.settings.enable_shard_affinity:
284301
x-alt-title: indexer.&#8203;settings.&#8203;enable_shard_affinity
285302
type: boolean
@@ -575,7 +592,7 @@ components:
575592
576593
* When false (the default), such redistribution does not occur.
577594
578-
For details, see [Rebalance](/server/8.0/learn/clusters-and-availability/rebalance.html#rebalancing-the-index-service).
595+
For more information, see [Rebalance](/server/8.0/learn/clusters-and-availability/rebalance.html#rebalancing-the-index-service).
579596
indexer.settings.recovery.max_rollbacks:
580597
x-alt-title: indexer.&#8203;settings.&#8203;recovery.&#8203;max_rollbacks
581598
type: integer

docs/modules/index-rest-settings/pages/index.adoc

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,30 @@ endif::collapse-models[]
557557
|===
558558
¦ Property ¦ ¦ Schema
559559

560+
561+
*indexer.&#8203;plasma.&#8203;LSSSegmentFileSize* +
562+
_optional_
563+
564+
565+
[markdown]
566+
--
567+
For standard indexes using Plasma, the maximum size for Log Structured Store segment files, in bytes.
568+
Index compaction and space reclamation are triggered when the segment file size reaches this value.
569+
570+
The default value is 512&nbsp;MiB on Microsoft Windows and 4&nbsp;GiB on GNU Linux and macOS.
571+
Specifying a lower value (for example, 64&nbsp;MiB) may trigger index compaction more frequently in cases where an index uses a lot of disk space, or index fragmentation is high.
572+
573+
This setting only applies to indexes created after the setting is changed.
574+
For existing indexes, you must rebuild the index after changing the setting.
575+
576+
For more information, see [Standard Index Storage](/server/8.0/indexes/storage-modes.html#standard-index-storage).
577+
--
578+
579+
[%hardbreaks]
580+
*Example:* `67108864`
581+
{blank}
582+
a¦ Integer (int32)
583+
560584
561585
*indexer.&#8203;rebalance.&#8203;transferBatchSize* +
562586
_optional_
@@ -915,7 +939,7 @@ a¦
915939
--
916940
Whether Bloom filters are enabled for memory management.
917941

918-
For details, see [Per Page Bloom Filters](/server/8.0/learn/services-and-indexes/indexes/storage-modes.html#per-page-bloom-filters).
942+
For more information, see [Per Page Bloom Filters](/server/8.0/indexes/storage-modes.html#per-page-bloom-filters).
919943
--
920944

921945
[%hardbreaks]
@@ -1487,7 +1511,7 @@ Whether to redistribute indexes on rebalance.
14871511

14881512
* When false (the default), such redistribution does not occur.
14891513

1490-
For details, see [Rebalance](/server/8.0/learn/clusters-and-availability/rebalance.html#rebalancing-the-index-service).
1514+
For more information, see [Rebalance](/server/8.0/learn/clusters-and-availability/rebalance.html#rebalancing-the-index-service).
14911515
--
14921516

14931517
[%hardbreaks]

0 commit comments

Comments
 (0)