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 ¶
- Variables
- type DeviceRow
- type NewerSchemaError
- type Store
- func (s *Store) Close() error
- func (s *Store) DefaultLayoutID() (string, error)
- func (s *Store) DeleteDevice(id string) (bool, error)
- func (s *Store) DeleteLayout(id string) (bool, error)
- func (s *Store) DeleteSource(id string) (bool, error)
- func (s *Store) DeleteTwitchAccount(role string) error
- func (s *Store) FirstLayoutID() (string, error)
- func (s *Store) GetLayout(id string) (*model.Layout, error)
- func (s *Store) GetSource(id string) (*model.Source, error)
- func (s *Store) GetTwitchAccount(role string) (*TwitchAccountRow, error)
- func (s *Store) KV() kv.Backend
- func (s *Store) ListDevices() ([]DeviceRow, error)
- func (s *Store) ListLayouts() ([]model.Layout, error)
- func (s *Store) ListSources() ([]model.Source, error)
- func (s *Store) ListTwitchAccounts() ([]TwitchAccountRow, error)
- func (s *Store) RenameScene(from, to string) (bool, error)
- func (s *Store) ResolveLayoutForScene(scene string) (*model.Layout, error)
- func (s *Store) SaveDevice(d DeviceRow) error
- func (s *Store) SaveLayout(l model.Layout) (stolen bool, err error)
- func (s *Store) SaveLayoutRev(l model.Layout, expect *int64) (rev int64, stolen bool, err error)
- func (s *Store) SaveSource(src model.Source) error
- func (s *Store) SaveTwitchAccount(r TwitchAccountRow) error
- func (s *Store) SceneOwner(scene string) (string, error)
- func (s *Store) Seed() error
- func (s *Store) SetDefaultLayoutID(id string) error
- func (s *Store) SetSetting(key, value string) error
- func (s *Store) Setting(key string) (string, bool, error)
- func (s *Store) TouchDevice(id, ip string, at time.Time) error
- type TwitchAccountRow
Constants ¶
This section is empty.
Variables ¶
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). Токен не хранится: он подписан секретом приложения, а «живым» считается, пока строка устройства есть в этой таблице (удаление = отзыв).
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 (*Store) DefaultLayoutID ¶
DefaultLayoutID — "" если не задан или layout уже удалён.
func (*Store) DeleteDevice ¶
DeleteDevice возвращает false, если такого устройства нет.
func (*Store) DeleteLayout ¶
DeleteLayout удаляет layout и его привязки; если он был default — сбрасывает default.
func (*Store) DeleteSource ¶
DeleteSource удаляет источник и ссылки на него из всех layout. false — источника не было.
func (*Store) DeleteTwitchAccount ¶
func (*Store) FirstLayoutID ¶
FirstLayoutID — запасной «активный» layout при старте (первый по имени).
func (*Store) GetTwitchAccount ¶
func (s *Store) GetTwitchAccount(role string) (*TwitchAccountRow, error)
func (*Store) ListDevices ¶
func (*Store) ListTwitchAccounts ¶
func (s *Store) ListTwitchAccounts() ([]TwitchAccountRow, error)
func (*Store) RenameScene ¶
RenameScene переносит привязку на новое имя сцены (сцену переименовали в OBS). true — что-то изменилось.
func (*Store) ResolveLayoutForScene ¶
ResolveLayoutForScene: layout, привязанный к сцене → иначе default → иначе nil.
func (*Store) SaveDevice ¶
func (*Store) SaveLayout ¶
SaveLayout сохраняет layout и его привязки к сценам одной транзакцией без проверки версии (серверные правки, создание). Сцены, которые принадлежали другим layout, переходят к этому (stolen=true). Layout должен быть уже провалидирован (model.Layout.Validate). Rev растёт в любом случае.
func (*Store) SaveLayoutRev ¶
SaveLayoutRev — то же, но при expect != nil сохраняет, только если Rev в базе равен *expect, иначе ErrRevConflict (ничего не меняется). Возвращает новый Rev.
func (*Store) SaveSource ¶
SaveSource — создание или обновление (upsert по id).
func (*Store) SaveTwitchAccount ¶
func (s *Store) SaveTwitchAccount(r TwitchAccountRow) error
func (*Store) SceneOwner ¶
SceneOwner — id layout, которому принадлежит сцена ("" если никому).
func (*Store) Seed ¶
Seed при первом запуске (пустая база) создаёт пустой layout «Default» и делает его layout по умолчанию: сцены без своего layout показывают его, а в редакторе сразу есть куда добавлять виджеты.
func (*Store) SetDefaultLayoutID ¶
SetDefaultLayoutID("") снимает default.
func (*Store) SetSetting ¶
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