Method _getOrAddDatabaseFromConfig

rest/server_context.go:658–1093

Adds a database to the ServerContext. Attempts a read after it gets the write lock to see if it's already been added by another process. If so, returns either the existing DatabaseContext or an error based on the useExisting flag. Pass in a bucketFromBucketSpecFn to replace the default ConnectToBuc

(ctx context.Context, config DatabaseConfig, options getOrAddDatabaseConfigOptions)

// existing DatabaseContext or an error based on the useExisting flag.
// Pass in a bucketFromBucketSpecFn to replace the default ConnectToBucket function. This will cause the failFast argument to be ignored
func (sc *ServerContext) _getOrAddDatabaseFromConfig(ctx context.Context, config DatabaseConfig, options getOrAddDatabaseConfigOptions) (dbcontext *db.DatabaseContext, returnedError error) {
	var bucket base.Bucket
	// Generate bucket spec and validate whether db already exists
	spec, err := GetBucketSpec(ctx, &config, sc.Config)
	if err != nil {
		return nil, err
	}

	dbName := config.Name
	if dbName == "" {
		dbName = spec.BucketName
	}

	// we do not have per database logging parameters, but it is still useful to have the database name in the log context. This must be set again after dbcOptionsFromConfig is called.
	ctx = base.DatabaseLogCtx(ctx, dbName, nil)

	defer func() {
		if returnedError == nil {
			return
		}
		// database exists in global map, management is deferred to REST api
		_, dbRegistered := sc._databases[dbName]
		if dbRegistered {
			return
		}
		if dbcontext != nil {
			dbcontext.Close(ctx) // will close underlying bucket
		} else if bucket != nil {
			bucket.Close(ctx)
		}
	}()

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

	previousDatabase := sc._databases[dbName]
	if previousDatabase != nil {
		if options.useExisting {
			return previousDatabase, nil
		}

		return nil, base.HTTPErrorf(http.StatusPreconditionFailed, // what CouchDB returns
			"Duplicate database name %q", dbName)
	}

	if config.DbConfig.CacheConfig != nil {
		if config.DbConfig.CacheConfig.ChannelCacheConfig != nil {
			if config.DbConfig.CacheConfig.ChannelCacheConfig.EnableStarChannel != nil && !*config.DbConfig.CacheConfig.ChannelCacheConfig.EnableStarChannel {
				base.WarnfCtx(ctx, `enable_star_channel config option is set to false, set it to true`)
				sc._handleInvalidDatabaseConfig(ctx, spec.BucketName, config, db.NewDatabaseError(db.DatabaseEnableStarChannelFalseError))
				return nil, errors.New("enable_star_channel in cache config is set to false, please set the value to true")
			}
		}
	}

	// Generate database context options from config and server context
	contextOptions, err := dbcOptionsFromConfig(ctx, sc, &config.DbConfig, dbName)