settingstore

Settings Store

Saves settings in an SQL database.

Description

Every application needs to preserve settings between multiple restarts. This package helps save the setting represented as key-value pairs in an SQL database.

License

This project is dual-licensed under the following terms:

• For non-commercial use, you may choose either the GNU Affero General Public License v3.0 (AGPLv3) or a separate commercial license (see below). You can find a copy of the AGPLv3 at: https://www.gnu.org/licenses/agpl-3.0.txt

• For commercial use, a separate commercial license is required. Commercial licenses are available for various use cases. Please contact me via my contact page to obtain a commercial license.

Features

• Saves settings data as key-value pairs
• Supports SQLite, MySQL and Postgres
• Uses sql.DB directly
• Automigration

Installation

go get -u github.com/gouniverse/settingstore

Setup

// as one line
settingStore, err = settingstore.NewStore(settingstore.NewStoreOptions{
	DB: databaseInstance,
	SettingTableName: "settings",
	AutomigrateEnabled: true,
})

if err != nil {
	panic(err)
}

// as multiple lines
settingStore, err = settingstore.NewStore(settingstore.NewStoreOptions{
	DB: databaseInstance,
	SettingTableName: "settings",
})

if err != nil {
	panic(err)
}

settingStore.AutoMigrate()

Usage

1. Create a new key value setting pair

settingsStore.Set("app.name", "My Web App")
settingsStore.Set("app.url", "http://localhost")
settingsStore.Set("server.ip", "127.0.0.1")
settingsStore.Set("server.port", "80")

1. Retrieve a setting value (or default value if not exists)

appName = settingsStore.Get("app.name", "Default Name")
appUrl = settingsStore.Get("app.url", "")
serverIp = settingsStore.Get("server.ip", "")
serverPort = settingsStore.Get("server.port", "")

1. Check if required setting is setup

if serverIp == "" {
    log.Panic("server ip not setup")
}

Methods

These methods may be subject to change as still in development

Store Methods

• NewStore(opts NewStoreOptions) (*store, error) - creates a new setting store
• AutoMigrate(ctx context.Context) error - auto migrate (create the tables in the database) the settings store tables
• DriverName(db *sql.DB) string - the name of the driver used for SQL strings (you may use this if you need to debug)
• SettingCount(ctx context.Context, query SettingQueryInterface) (int64, error) - counts the number of settings
• SettingCreate(ctx context.Context, setting SettingInterface) error - creates a new setting
• SettingDelete(ctx context.Context, setting SettingInterface) error - deletes a setting
• SettingDeleteByID(ctx context.Context, settingID string) error - deletes a setting by ID
• SettingDeleteByKey(ctx context.Context, settingKey string) error - deletes a setting by key
• SettingFindByID(ctx context.Context, settingID string) (SettingInterface, error) - finds a setting by ID
• SettingList(ctx context.Context, query SettingQueryInterface) ([]SettingInterface, error) - lists settings
• SettingSoftDelete(ctx context.Context, setting SettingInterface) error - soft deletes a setting
• SettingSoftDeleteByID(ctx context.Context, settingID string) error - soft deletes a setting by ID
• SettingUpdate(ctx context.Context, setting SettingInterface) error - updates a setting

Shortcut Methods

• Get(ctx context.Context, key string, valueDefault string) (string, error) - gets a value from key-value setting pair

• Set(ctx context.Context, key string, value string, seconds int64) error - sets new key value pair

• GetAny(ctx context.Context, key string, valueDefault interface{}) (interface{}, error) - gets a value from key-value setting pair

• GetJSON(key string, valueDefault interface{}) (interface{}, error) - gets a value as JSON from key-value setting pair

• SetJSON(ctx context.Context, key string, value interface{}, seconds int64) error - sets new key JSON value pair

• GetMap(ctx context.Context, key string, valueDefault map[string]any) (map[string]any, error) - gets a value as JSON from key-value setting pair

• MergeMap(ctx context.Context, key string, mergeMap map[string]any, seconds int64) error - merges a map with an existing map

• Has(ctx context.Context, settingKey string) (bool, error) - checks if a setting exists