Method GetMetadataPurgeInterval

db/database.go:1610–1646

GetMetadataPurgeInterval returns the current value for the metadata purge interval for the backing bucket. if forceRefresh is set, we'll always fetch a new Metadata Purge Interval from the bucket, even if we had one cached.

(ctx context.Context, forceRefresh bool)

// GetMetadataPurgeInterval returns the current value for the metadata purge interval for the backing bucket.
// if forceRefresh is set, we'll always fetch a new Metadata Purge Interval from the bucket, even if we had one cached.
func (db *DatabaseContext) GetMetadataPurgeInterval(ctx context.Context, forceRefresh bool) time.Duration {
	// look for metadata purge interval preferentially:
	// 1. test override value specified in DatabaseContextOptions
	// 2. cached metadata purge interval (if forceRefresh is false)
	// 3. bucket level
	// 4. cluster level
	// 5. default fallback value
	if db.Options.TestPurgeIntervalOverride != nil {
		return *db.Options.TestPurgeIntervalOverride
	}

	// fetch cached value if available
	if !forceRefresh {
		mpi := db.CachedPurgeInterval.Load()
		if mpi != nil {
			return *mpi
		}
	}

	// fetch from server
	cbStore, ok := base.AsCouchbaseBucketStore(db.Bucket)
	if !ok {
		return DefaultPurgeInterval
	}
	serverPurgeInterval, err := cbStore.MetadataPurgeInterval(ctx)
	if err != nil {
		base.WarnfCtx(ctx, "Unable to retrieve server's metadata purge interval - using default purge interval %.2f days. %s", DefaultPurgeInterval.Hours()/24, err)
	}

	mpi := DefaultPurgeInterval
	if serverPurgeInterval > 0 {
		mpi = serverPurgeInterval
	}

	db.CachedPurgeInterval.Store(&mpi)
	return mpi
}

// GetVersionPruningWindow returns the current value for the XDCR Version Pruning Window for the backing bucket.
// if forceRefresh is set, we'll always fetch a new value from the bucket, even if we had one cached.