pocketbase

Documentation

Index

• type Bucket
  • func (bucket *Bucket) Count() uint
  • func (bucket *Bucket) DB() DB
  • func (bucket *Bucket) Delete(idI any) Error
  • func (bucket *Bucket) DeleteAll() Error
  • func (bucket *Bucket) Get(id any) (Model, Error)
  • func (bucket *Bucket) Manager() ManagerI
  • func (bucket *Bucket) Model() Model
  • func (bucket *Bucket) Name() string
  • func (bucket *Bucket) Save(model Model) Error
• type DataBase
  • func Open(address, identity, password string) *DataBase
  • func OpenWith(pb *PocketBase, buckets map[string]*Bucket) *DataBase
  • func (db *DataBase) Close() Error
  • func (db *DataBase) ExistsTable(name string) bool
  • func (db *DataBase) Table(name string, model Model) (Table, Error)
  • func (db *DataBase) TableFromCache(name string) Table
• type Form
  • func NewForm(app *PocketBase, record *Record) *Form
  • func (form *Form) AddFiles(field string, path ...string)
  • func (form *Form) LoadData(data map[string]any)
  • func (form *Form) Submit() error
• type Manager
  • func (manager *Manager) All() []Model
  • func (manager *Manager) Bucket() *Bucket
  • func (manager *Manager) Copy() ManagerI
  • func (manager *Manager) Count() uint
  • func (manager *Manager) Delete(id any)
  • func (manager *Manager) Filter(include Params, _ ...Params) ManagerI
  • func (manager *Manager) First() Model
  • func (manager *Manager) Get(idI any) Model
  • func (manager *Manager) IsInstance() bool
  • func (manager *Manager) Last() Model
  • func (manager *Manager) Table() Table
• type PocketBase
  • func New(address, identity, password string) *PocketBase
  • func NewLocal(identity, password string, port ...string) *PocketBase
  • func (pb *PocketBase) Delete(collectionNameOrId, id string) error
  • func (pb *PocketBase) Filter(collectionNameOrId string, data map[string]any, page ...uint) ([]*Record, error)
  • func (pb *PocketBase) GetFileAsSliceByte(collentionNameOrId, recordId, fileName string) ([]byte, error)
• type Record
  • func NewRecord(collectionNameOrId string, app *PocketBase) *Record
  • func (record *Record) CollectionNameOrId() string
  • func (record *Record) Get(key string) any
  • func (record *Record) Set(key string, value any)

Types

type Bucket

type Bucket struct {
	Objects *Manager
	// contains filtered or unexported fields
}

Bucket

func (*Bucket) Count

func (bucket *Bucket) Count() uint

func (*Bucket) DB

func (bucket *Bucket) DB() DB

func (*Bucket) Delete

func (bucket *Bucket) Delete(idI any) Error

func (*Bucket) DeleteAll

func (bucket *Bucket) DeleteAll() Error

func (*Bucket) Get

func (bucket *Bucket) Get(id any) (Model, Error)

func (*Bucket) Manager

func (bucket *Bucket) Manager() ManagerI

func (*Bucket) Model

func (bucket *Bucket) Model() Model

func (*Bucket) Name

func (bucket *Bucket) Name() string

func (*Bucket) Save

func (bucket *Bucket) Save(model Model) Error

type DataBase

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

DB

func Open

func Open(address, identity, password string) *DataBase

func OpenWith

func OpenWith(pb *PocketBase, buckets map[string]*Bucket) *DataBase

func (*DataBase) Close

func (db *DataBase) Close() Error

func (*DataBase) ExistsTable

func (db *DataBase) ExistsTable(name string) bool

func (*DataBase) Table

func (db *DataBase) Table(name string, model Model) (Table, Error)

func (*DataBase) TableFromCache

func (db *DataBase) TableFromCache(name string) Table

type Form

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

Form структура формы для создания или обновления записи

func NewForm

func NewForm(app *PocketBase, record *Record) *Form

NewForm возвращает экземпляр *Form

func (*Form) AddFiles

func (form *Form) AddFiles(field string, path ...string)

Form.AddFiles добавляет пути файлов к форме

func (*Form) LoadData

func (form *Form) LoadData(data map[string]any)

Form.LoadData загружает в форму данные

func (*Form) Submit

func (form *Form) Submit() error

Form.Submit записывает изменения в pb

type Manager

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

Manager

func (*Manager) All

func (manager *Manager) All() []Model

func (*Manager) Bucket

func (manager *Manager) Bucket() *Bucket

func (*Manager) Copy

func (manager *Manager) Copy() ManagerI

func (*Manager) Count

func (manager *Manager) Count() uint

func (*Manager) Delete

func (manager *Manager) Delete(id any)

func (*Manager) Filter

func (manager *Manager) Filter(include Params, _ ...Params) ManagerI

func (*Manager) First

func (manager *Manager) First() Model

func (*Manager) Get

func (manager *Manager) Get(idI any) Model

func (*Manager) IsInstance

func (manager *Manager) IsInstance() bool

func (*Manager) Last

func (manager *Manager) Last() Model

func (*Manager) Table

func (manager *Manager) Table() Table

type PocketBase

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

Pocketbase структура с данными авторизации для pb

func New

func New(address, identity, password string) *PocketBase

New возвращает экземпляр *Pocketbase с адресом `address`, индификатором `identity` и паролем `password`

address in format - http(s)://127.0.0.1(:8090)

func NewLocal

func NewLocal(identity, password string, port ...string) *PocketBase

func (*PocketBase) Delete

func (pb *PocketBase) Delete(collectionNameOrId, id string) error

func (*PocketBase) Filter

func (pb *PocketBase) Filter(collectionNameOrId string, data map[string]any, page ...uint) ([]*Record, error)

PocketBase.Filter возвращает список записей из pb удовлетворяющим фильтру `data`

func (*PocketBase) GetFileAsSliceByte

func (pb *PocketBase) GetFileAsSliceByte(collentionNameOrId, recordId, fileName string) ([]byte, error)

PocketBase.GetFileAsSliceByte возвращает список байтов файла из pb

По id записи `recordId` в колекции `collentionNameOrId` и имени файла `fileName`

type Record

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

Record структура записи в pb

func NewRecord

func NewRecord(collectionNameOrId string, app *PocketBase) *Record

NewRecord возвращает экземпляр *Record

func (*Record) CollectionNameOrId

func (record *Record) CollectionNameOrId() string

Record.CollectionNameOrId возвращает имяИлиId колекции

func (*Record) Get

func (record *Record) Get(key string) any

Record.Get возвращает значение по ключу `key`

func (*Record) Set

func (record *Record) Set(key string, value any)

Record.Set устанавливает значение `value` по ключу `key`