mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-27 15:12:53 +00:00
81 lines
2.0 KiB
Markdown
81 lines
2.0 KiB
Markdown
[vectordb](../README.md) / [Exports](../modules.md) / CompactionOptions
|
|
|
|
# Interface: CompactionOptions
|
|
|
|
## Table of contents
|
|
|
|
### Properties
|
|
|
|
- [materializeDeletions](CompactionOptions.md#materializedeletions)
|
|
- [materializeDeletionsThreshold](CompactionOptions.md#materializedeletionsthreshold)
|
|
- [maxRowsPerGroup](CompactionOptions.md#maxrowspergroup)
|
|
- [numThreads](CompactionOptions.md#numthreads)
|
|
- [targetRowsPerFragment](CompactionOptions.md#targetrowsperfragment)
|
|
|
|
## Properties
|
|
|
|
### materializeDeletions
|
|
|
|
• `Optional` **materializeDeletions**: `boolean`
|
|
|
|
If true, fragments that have rows that are deleted may be compacted to
|
|
remove the deleted rows. This can improve the performance of queries.
|
|
Default is true.
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:660](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L660)
|
|
|
|
___
|
|
|
|
### materializeDeletionsThreshold
|
|
|
|
• `Optional` **materializeDeletionsThreshold**: `number`
|
|
|
|
A number between 0 and 1, representing the proportion of rows that must be
|
|
marked deleted before a fragment is a candidate for compaction to remove
|
|
the deleted rows. Default is 10%.
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:666](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L666)
|
|
|
|
___
|
|
|
|
### maxRowsPerGroup
|
|
|
|
• `Optional` **maxRowsPerGroup**: `number`
|
|
|
|
The maximum number of rows per group. Defaults to 1024.
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:654](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L654)
|
|
|
|
___
|
|
|
|
### numThreads
|
|
|
|
• `Optional` **numThreads**: `number`
|
|
|
|
The number of threads to use for compaction. If not provided, defaults to
|
|
the number of cores on the machine.
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:671](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L671)
|
|
|
|
___
|
|
|
|
### targetRowsPerFragment
|
|
|
|
• `Optional` **targetRowsPerFragment**: `number`
|
|
|
|
The number of rows per fragment to target. Fragments that have fewer rows
|
|
will be compacted into adjacent fragments to produce larger fragments.
|
|
Defaults to 1024 * 1024.
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:650](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L650)
|