Skip to content

OAS-11786: Added new attributes to Support new ConsolidationPolicy in… #724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bluepal-prasanthi-moparthi wants to merge 3 commits into
base: master
Choose a base branch
from
+51 −2
Open

OAS-11786: Added new attributes to Support new ConsolidationPolicy in… #724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f31c945
OAS-11786: Added new attributes to Support new ConsolidationPolicy in…
bluepal-prasanthi-moparthi Dec 15, 2025
24b7cc4
OAS-11786: Restore assertion that checks the view type is ArangoSearc…
bluepal-prasanthi-moparthi Dec 15, 2025
265fec7
OAS-11786: Mark consolidation policy attributes deprecated since 3.12.7
bluepal-prasanthi-moparthi Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion v2/arangodb/shared.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,17 +133,31 @@ type ConsolidationPolicyBytesAccum struct {
// ConsolidationPolicyTier contains fields used for ConsolidationPolicyTypeTier
type ConsolidationPolicyTier struct {
// MinScore Filter out consolidation candidates with a score less than this. Default: 0
// Deprecated: Only available up to v3.12.6.
MinScore *int64 `json:"minScore,omitempty"`

// SegmentsMin The minimum number of segments that are evaluated as candidates for consolidation. Default: 1
// Deprecated: Only available up to v3.12.6.
// Deprecated since v3.12.7. Use segment byte size skew–based consolidation.
SegmentsMin *int64 `json:"segmentsMin,omitempty"`

// SegmentsMax The maximum number of segments that are evaluated as candidates for consolidation. Default: 10
// Deprecated: Only available up to v3.12.6.
SegmentsMax *int64 `json:"segmentsMax,omitempty"`

// SegmentsBytesMax The maximum allowed size of all consolidated segments in bytes. Default: 5368709120
SegmentsBytesMax *int64 `json:"segmentsBytesMax,omitempty"`

// SegmentsBytesFloor Defines the value (in bytes) to treat all smaller segments as equal for consolidation selection. Default: 2097152
// Deprecated: Only available up to v3.12.6.
SegmentsBytesFloor *int64 `json:"segmentsBytesFloor,omitempty"`

// MaxSkewThreshold defines the maximum allowed size skew between segment files
// (value between 0.0 and 1.0) before they are considered for consolidation.
// Default: 0.4. Available from ArangoDB v3.12.7 onward.
MaxSkewThreshold *float64 `json:"maxSkewThreshold,omitempty"`

// MinDeletionRatio defines the minimum ratio of deleted documents (0.0–1.0)
// required to trigger segment cleanup.
// Default: 0.5. Available from ArangoDB v3.12.7 onward.
MinDeletionRatio *float64 `json:"minDeletionRatio,omitempty"`
}
16 changes: 15 additions & 1 deletion v2/arangodb/view_arango_search.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,19 +149,33 @@ type ArangoSearchConsolidationPolicyBytesAccum struct {

// ArangoSearchConsolidationPolicyTier contains fields used for ArangoSearchConsolidationPolicyTypeTier
type ArangoSearchConsolidationPolicyTier struct {
// Deprecated: Only available up to v3.12.6.
MinScore *int64 `json:"minScore,omitempty"`

// MinSegments specifies the minimum number of segments that will be evaluated as candidates for consolidation.
// Deprecated: Only available up to v3.12.6.
// Deprecated since v3.12.7. Use segment byte size skew–based consolidation.
MinSegments *int64 `json:"segmentsMin,omitempty"`

// MaxSegments specifies the maximum number of segments that will be evaluated as candidates for consolidation.
// Deprecated: Only available up to v3.12.6.
MaxSegments *int64 `json:"segmentsMax,omitempty"`

// SegmentsBytesMax specifies the maxinum allowed size of all consolidated segments in bytes.
SegmentsBytesMax *int64 `json:"segmentsBytesMax,omitempty"`

// SegmentsBytesFloor defines the value (in bytes) to treat all smaller segments as equal for consolidation selection.
// Deprecated: Only available up to v3.12.6.
SegmentsBytesFloor *int64 `json:"segmentsBytesFloor,omitempty"`

// MaxSkewThreshold defines the maximum allowed size skew between segment files
// (value between 0.0 and 1.0) before they are considered for consolidation.
// Default: 0.4. Available from ArangoDB v3.12.7 onward.
MaxSkewThreshold *float64 `json:"maxSkewThreshold,omitempty"`

// MinDeletionRatio defines the minimum ratio of deleted documents (0.0–1.0)
// required to trigger segment cleanup.
// Default: 0.5. Available from ArangoDB v3.12.7 onward.
MinDeletionRatio *float64 `json:"minDeletionRatio,omitempty"`
}

// ArangoSearchPrimarySortEntry describes an entry for the primarySort list
Expand Down
6 changes: 6 additions & 0 deletions v2/tests/database_collection_indexes_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,8 @@ func Test_NamedIndexes(t *testing.T) {
WithDatabase(t, client, nil, func(db arangodb.Database) {
WithCollectionV2(t, db, nil, func(col arangodb.Collection) {
withContextT(t, defaultTestTimeout, func(ctx context.Context, _ testing.TB) {
clientVersion, _ := client.Version(ctx)
t.Logf("Arangodb Version: %s", clientVersion.Version)

var namedIndexTestCases = []struct {
Name string
Expand Down Expand Up @@ -441,6 +443,10 @@ func Test_NamedIndexes(t *testing.T) {
},
},
})
if clientVersion.Version.CompareTo("3.12.7") >= 0 {
require.Equal(t, 0.4, *idx.InvertedIndex.ConsolidationPolicy.MaxSkewThreshold)
require.Equal(t, 0.5, *idx.InvertedIndex.ConsolidationPolicy.MinDeletionRatio)
}
return idx, err
},
},
Expand Down
15 changes: 15 additions & 0 deletions v2/tests/database_view-arangosearch-simple_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,18 @@ func Test_ArangoSearchSimple(t *testing.T) {
CommitInterval: utils.NewType[int64](500),
}

clientVersion, _ := client.Version(ctx)
t.Logf("Arangodb Version: %s", clientVersion.Version)

view, err := db.CreateArangoSearchView(ctx, viewName, opts)
require.NoError(t, err, "Failed to create alias view '%s'", viewName)

prop, err := view.Properties(ctx)
require.NoError(t, err)
if clientVersion.Version.CompareTo("3.12.7") >= 0 {
require.Equal(t, 0.4, *prop.ConsolidationPolicy.MaxSkewThreshold)
require.Equal(t, 0.5, *prop.ConsolidationPolicy.MinDeletionRatio)
}
require.Equal(t, prop.Type, arangodb.ViewTypeArangoSearch)
require.Equal(t, prop.Name, viewName)
require.Equal(t, int64(1), *prop.CleanupIntervalStep)
Expand All @@ -61,6 +68,10 @@ func Test_ArangoSearchSimple(t *testing.T) {

pr, err := view.Properties(ctx)
require.NoError(t, err)
if clientVersion.Version.CompareTo("3.12.7") >= 0 {
require.Equal(t, 0.4, *pr.ConsolidationPolicy.MaxSkewThreshold)
require.Equal(t, 0.5, *pr.ConsolidationPolicy.MinDeletionRatio)
}
require.Equal(t, pr.Type, arangodb.ViewTypeArangoSearch)
require.Equal(t, pr.Name, viewName)
require.Equal(t, int64(1), *pr.CleanupIntervalStep)
Expand All @@ -76,6 +87,10 @@ func Test_ArangoSearchSimple(t *testing.T) {

pr, err := view.Properties(ctx)
require.NoError(t, err)
if clientVersion.Version.CompareTo("3.12.7") >= 0 {
require.Equal(t, 0.4, *pr.ConsolidationPolicy.MaxSkewThreshold)
require.Equal(t, 0.5, *pr.ConsolidationPolicy.MinDeletionRatio)
}
require.Equal(t, pr.Type, arangodb.ViewTypeArangoSearch)
require.Equal(t, pr.Name, viewName)
require.Equal(t, int64(300), *pr.CommitInterval)
Expand Down