store

package
v0.0.0-...-9be6d64 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package store — SQLite через GORM (pure-Go драйвер github.com/glebarez/sqlite, без CGO).

Таблицы: sources, layouts (объекты layout лежат JSON-колонкой), layout_scenes (сцена → layout; первичный ключ по имени сцены гарантирует «сцена принадлежит одному layout»), settings (key/value: default_layout).

Index

Constants

This section is empty.

Variables

View Source
var ErrRevConflict = errors.New("layout was changed by someone else")

ErrRevConflict — layout уже изменили после того, как клиент его прочитал (не совпал Rev).

Functions

This section is empty.

Types

type DeviceRow

type DeviceRow struct {
	ID        string `gorm:"primaryKey"`
	Name      string
	CreatedAt time.Time
	LastSeen  time.Time
	LastIP    string
}

DeviceRow — устройство, прошедшее сопряжение (доступ извне localhost). Токен не хранится: он подписан секретом приложения, а «живым» считается, пока строка устройства есть в этой таблице (удаление = отзыв).

func (DeviceRow) TableName

func (DeviceRow) TableName() string

type NewerSchemaError

type NewerSchemaError struct{ Have, Supported int }

NewerSchemaError — база создана более новой версией приложения.

func (*NewerSchemaError) Error

func (e *NewerSchemaError) Error() string

type Store

type Store struct {
	// contains filtered or unexported fields
}

func Open

func Open(path string) (*Store, error)

Open открывает (создаёт) базу и приводит схему к актуальной версии (см. migrate.go).

func (*Store) Close

func (s *Store) Close() error

func (*Store) DefaultLayoutID

func (s *Store) DefaultLayoutID() (string, error)

DefaultLayoutID — "" если не задан или layout уже удалён.

func (*Store) DeleteDevice

func (s *Store) DeleteDevice(id string) (bool, error)

DeleteDevice возвращает false, если такого устройства нет.

func (*Store) DeleteLayout

func (s *Store) DeleteLayout(id string) (bool, error)

DeleteLayout удаляет layout и его привязки; если он был default — сбрасывает default.

func (*Store) DeleteSource

func (s *Store) DeleteSource(id string) (bool, error)

DeleteSource удаляет источник и ссылки на него из всех layout. false — источника не было.

func (*Store) DeleteTwitchAccount

func (s *Store) DeleteTwitchAccount(role string) error

func (*Store) FirstLayoutID

func (s *Store) FirstLayoutID() (string, error)

FirstLayoutID — запасной «активный» layout при старте (первый по имени).

func (*Store) GetLayout

func (s *Store) GetLayout(id string) (*model.Layout, error)

GetLayout возвращает nil, nil, если layout нет.

func (*Store) GetSource

func (s *Store) GetSource(id string) (*model.Source, error)

func (*Store) GetTwitchAccount

func (s *Store) GetTwitchAccount(role string) (*TwitchAccountRow, error)

func (*Store) KV

func (s *Store) KV() kv.Backend

KV возвращает хранилище данных плагинов поверх этой базы.

func (*Store) ListDevices

func (s *Store) ListDevices() ([]DeviceRow, error)

func (*Store) ListLayouts

func (s *Store) ListLayouts() ([]model.Layout, error)

func (*Store) ListSources

func (s *Store) ListSources() ([]model.Source, error)

func (*Store) ListTwitchAccounts

func (s *Store) ListTwitchAccounts() ([]TwitchAccountRow, error)

func (*Store) RenameScene

func (s *Store) RenameScene(from, to string) (bool, error)

RenameScene переносит привязку на новое имя сцены (сцену переименовали в OBS). true — что-то изменилось.

func (*Store) ResolveLayoutForScene

func (s *Store) ResolveLayoutForScene(scene string) (*model.Layout, error)

ResolveLayoutForScene: layout, привязанный к сцене → иначе default → иначе nil.

func (*Store) SaveDevice

func (s *Store) SaveDevice(d DeviceRow) error

func (*Store) SaveLayout

func (s *Store) SaveLayout(l model.Layout) (stolen bool, err error)

SaveLayout сохраняет layout и его привязки к сценам одной транзакцией без проверки версии (серверные правки, создание). Сцены, которые принадлежали другим layout, переходят к этому (stolen=true). Layout должен быть уже провалидирован (model.Layout.Validate). Rev растёт в любом случае.

func (*Store) SaveLayoutRev

func (s *Store) SaveLayoutRev(l model.Layout, expect *int64) (rev int64, stolen bool, err error)

SaveLayoutRev — то же, но при expect != nil сохраняет, только если Rev в базе равен *expect, иначе ErrRevConflict (ничего не меняется). Возвращает новый Rev.

func (*Store) SaveSource

func (s *Store) SaveSource(src model.Source) error

SaveSource — создание или обновление (upsert по id).

func (*Store) SaveTwitchAccount

func (s *Store) SaveTwitchAccount(r TwitchAccountRow) error

func (*Store) SceneOwner

func (s *Store) SceneOwner(scene string) (string, error)

SceneOwner — id layout, которому принадлежит сцена ("" если никому).

func (*Store) Seed

func (s *Store) Seed() error

Seed при первом запуске (пустая база) создаёт пустой layout «Default» и делает его layout по умолчанию: сцены без своего layout показывают его, а в редакторе сразу есть куда добавлять виджеты.

func (*Store) SetDefaultLayoutID

func (s *Store) SetDefaultLayoutID(id string) error

SetDefaultLayoutID("") снимает default.

func (*Store) SetSetting

func (s *Store) SetSetting(key, value string) error

func (*Store) Setting

func (s *Store) Setting(key string) (string, bool, error)

Setting / SetSetting — произвольные строковые настройки (секрет подписи токенов и т.п.). "" и false — нет значения.

func (*Store) TouchDevice

func (s *Store) TouchDevice(id, ip string, at time.Time) error

TouchDevice обновляет «последний раз виден».

type TwitchAccountRow

type TwitchAccountRow struct {
	Role         string `gorm:"primaryKey"`
	UserID       string
	Login        string
	DisplayName  string
	AccessToken  string
	RefreshToken string
	Scopes       string // через пробел
	ExpiresAt    time.Time
	ConnectedAt  time.Time
	LastError    string // последняя ошибка обновления токена; не пусто — нужно переподключить
}

TwitchAccountRow — подключённый аккаунт Twitch в одной из ролей ("streamer" | "bot"). Токены лежат в базе открытым текстом (как и пароль OBS в config.json): файл доступен только пользователю ОС.

func (TwitchAccountRow) TableName

func (TwitchAccountRow) TableName() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL