Function NewDatabaseContext

db/database.go:370–602

Creates a new DatabaseContext on a bucket. The bucket will be closed when this context closes.

(ctx context.Context, dbName string, bucket base.Bucket, autoImport bool, options DatabaseContextOptions)

// Creates a new DatabaseContext on a bucket. The bucket will be closed when this context closes.
func NewDatabaseContext(ctx context.Context, dbName string, bucket base.Bucket, autoImport bool, options DatabaseContextOptions) (dbc *DatabaseContext, returnedError error) {
	cleanupFunctions := make([]func(), 0)

	defer func() {
		if returnedError != nil {
			for _, cleanupFunc := range cleanupFunctions {
				cleanupFunc()
			}
		}
	}()

	if err := ValidateDatabaseName(dbName); err != nil {
		return nil, err
	}

	// add db info to ctx before having a DatabaseContext (cannot call AddDatabaseLogContext),
	// in order to pass it to RegisterImportPindexImpl
	ctx = base.DatabaseLogCtx(ctx, dbName, options.LoggingConfig)

	if err := base.RequireNoBucketTTL(ctx, bucket); err != nil {
		return nil, err
	}

	serverUUID, err := base.GetServerUUID(ctx, bucket)
	if err != nil {
		return nil, err
	}

	dbStats, statsError := initDatabaseStats(ctx, dbName, autoImport, options)
	if statsError != nil {
		return nil, statsError
	}

	// options.MetadataStore is always passed via rest._getOrAddDatabase...
	// but in db package tests this is unlikely to be set. In this case we'll use the existing bucket connection to store metadata.
	metadataStore := options.MetadataStore
	if metadataStore == nil {
		base.DebugfCtx(ctx, base.KeyAll, "MetadataStore was nil - falling back to use existing bucket connection %q for database %q", bucket.GetName(), dbName)
		metadataStore = bucket.DefaultDataStore()
	}

	bucketUUID, err := bucket.UUID()
	if err != nil {
		return nil, err
	}
	sourceID, err := base.GetSourceID(ctx, bucket)
	if err != nil {
		return nil, err
	}

	// Register the cbgt pindex type for the configGroup
	RegisterImportPindexImpl(ctx, options.GroupID)

	dbContext := &DatabaseContext{
		Name:                 dbName,
		UUID:                 cbgt.NewUUID(),
		MetadataStore:        metadataStore,
		Bucket:               bucket,