gaesettings

Documentation

Overview

Package gaesettings implements settings.Storage interface on top of GAE datastore.

By default, gaesettings must have its handlers installed into the "default" AppEngine module, and must be running on an instance with read/write datastore access.

See go.chromium.org/luci/server/settings for more details.

Index

• type Storage
  • func (s Storage) FetchAllSettings(ctx context.Context) (*settings.Bundle, time.Duration, error)
  • func (s Storage) GetConsistencyTime(ctx context.Context) (time.Time, error)
  • func (s Storage) UpdateSetting(ctx context.Context, key string, value json.RawMessage, who, why string) error

Types

type Storage

type Storage struct{}

Storage knows how to store JSON blobs with settings in the datastore.

It implements server/settings.EventualConsistentStorage interface.

func (Storage) FetchAllSettings

func (s Storage) FetchAllSettings(ctx context.Context) (*settings.Bundle, time.Duration, error)

FetchAllSettings fetches all latest settings at once.

func (Storage) GetConsistencyTime

func (s Storage) GetConsistencyTime(ctx context.Context) (time.Time, error)

GetConsistencyTime returns "last modification time" + "expiration period".

It indicates moment in time when last setting change is fully propagated to all instances.

Returns zero time if there are no settings stored.

func (Storage) UpdateSetting

func (s Storage) UpdateSetting(ctx context.Context, key string, value json.RawMessage, who, why string) error

UpdateSetting updates a setting at the given key.