pgdb

package

v0.0.0-...-48663ca Latest Latest Go to latest Published: Nov 28, 2023 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/raintreeinc/knowledgebase

Documentation ¶

Overview ¶

stringSlice support based on

https://gist.github.com/adharris/4163702
and comments

Remove when Array support lands in pq

Index ¶

Variables
type Access
type Context
type Database
- func New(params string) (*Database, error)
- func (db Database) Context(user kb.Slug) kb.Context
- func (db *Database) Initialize() error
type Groups
type GuestLogin
type Index
type Pages
type Users

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNotImplemented = errors.New("not implemented")

Functions ¶

This section is empty.

Types ¶

type Access ¶

type Access struct{ Context }

func (Access) AddUser ¶

func (db Access) AddUser(group, user kb.Slug) error

func (Access) BoolQuery ¶

func (db Access) BoolQuery(q string, args ...interface{}) bool

func (Access) CommunityAdd ¶

func (db Access) CommunityAdd(group, member kb.Slug, rights kb.Rights) error

func (Access) CommunityRemove ¶

func (db Access) CommunityRemove(group, member kb.Slug) error

func (Access) IsAdmin ¶

func (db Access) IsAdmin(user kb.Slug) bool

func (Access) List ¶

func (db Access) List(group kb.Slug) (members []kb.Member, err error)

TODO: fix this for OwnerID, GroupID

func (Access) RemoveUser ¶

func (db Access) RemoveUser(group, user kb.Slug) error

func (Access) Rights ¶

func (db Access) Rights(group, user kb.Slug) kb.Rights

func (Access) SetAdmin ¶

func (db Access) SetAdmin(user kb.Slug, isAdmin bool) error

func (Access) VerifyUser ¶

func (db Access) VerifyUser(user kb.User) error

type Context ¶

type Context struct {
	Database
	ActiveUser kb.Slug
}

func (Context) Access ¶

func (ctx Context) Access() kb.Access

func (Context) ActiveUserID ¶

func (ctx Context) ActiveUserID() kb.Slug

func (Context) Groups ¶

func (ctx Context) Groups() kb.Groups

func (Context) GuestLogin ¶

func (ctx Context) GuestLogin() kb.GuestLogin

func (Context) Index ¶

func (ctx Context) Index(user kb.Slug) kb.Index

func (Context) Pages ¶

func (ctx Context) Pages(group kb.Slug) kb.Pages

func (Context) Users ¶

func (ctx Context) Users() kb.Users

type Database ¶

type Database struct {
	*sql.DB
}

func New ¶

func New(params string) (*Database, error)

func (Database) Context ¶

func (db Database) Context(user kb.Slug) kb.Context

func (*Database) Initialize ¶

func (db *Database) Initialize() error

type Groups ¶

type Groups struct{ Context }

func (Groups) ByID ¶

func (db Groups) ByID(id kb.Slug) (group kb.Group, err error)

func (Groups) Create ¶

func (db Groups) Create(group kb.Group) error

func (Groups) Delete ¶

func (db Groups) Delete(id kb.Slug) error

func (Groups) List ¶

func (db Groups) List() (groups []kb.Group, err error)

type GuestLogin ¶

type GuestLogin struct{ Context }

func (GuestLogin) Add ¶

func (db GuestLogin) Add(name, email, password string) error

func (GuestLogin) Boot ¶

func (db GuestLogin) Boot() template.HTML

func (GuestLogin) Verify ¶

func (db GuestLogin) Verify(name, password string) (kb.User, error)

type Index ¶

type Index struct {
	Context
	UserID kb.Slug
}

func (Index) ByGroup ¶

func (db Index) ByGroup(groupID kb.Slug) ([]kb.PageEntry, error)

func (Index) ByTag ¶

func (db Index) ByTag(tag kb.Slug) ([]kb.PageEntry, error)

func (Index) ByTagFilter ¶

func (db Index) ByTagFilter(tags []kb.Slug, exclude, include string) ([]kb.PageEntry, error)

func (Index) ByTitle ¶

func (db Index) ByTitle(suffix kb.Slug) ([]kb.PageEntry, error)

func (Index) Groups ¶

func (db Index) Groups(min kb.Rights) (groups []kb.Group, err error)

func (Index) List ¶

func (db Index) List() ([]kb.PageEntry, error)

func (Index) RecentChanges ¶

func (db Index) RecentChanges(n int) ([]kb.PageEntry, error)

func (Index) RecentChangesByGroup ¶

func (db Index) RecentChangesByGroup(n int, groupID kb.Slug) ([]kb.PageEntry, error)

func (Index) Search ¶

func (db Index) Search(text string) ([]kb.PageEntry, error)

func (db Index) SearchFilter(text, exclude, include string) ([]kb.PageEntry, error)

func (Index) Tags ¶

func (db Index) Tags() ([]kb.TagEntry, error)

type Pages ¶

type Pages struct {
	Context
	GroupID kb.Slug
}

func (Pages) BatchReplace ¶

func (db Pages) BatchReplace(pages map[kb.Slug]*kb.Page, complete func(string, kb.Slug)) error

func (Pages) BatchReplaceDelta ¶

func (db Pages) BatchReplaceDelta(pages map[kb.Slug]*kb.Page, complete func(string, kb.Slug)) error

func (Pages) Create ¶

func (db Pages) Create(page *kb.Page) error

func (Pages) Delete ¶

func (db Pages) Delete(id kb.Slug, version int) (err error)

func (Pages) Edit ¶

func (db Pages) Edit(id kb.Slug, version int, action kb.Action) error

func (Pages) History ¶

func (db Pages) History(id kb.Slug) (entries []kb.PageEntry, err error)

func (Pages) List ¶

func (db Pages) List() ([]kb.PageEntry, error)

func (Pages) Load ¶

func (db Pages) Load(id kb.Slug) (*kb.Page, error)

func (Pages) LoadRaw ¶

func (db Pages) LoadRaw(id kb.Slug) ([]byte, error)

func (Pages) LoadRawVersion ¶

func (db Pages) LoadRawVersion(id kb.Slug, version int) ([]byte, error)

func (Pages) Overwrite ¶

func (db Pages) Overwrite(id kb.Slug, version int, page *kb.Page) error

type Users ¶

type Users struct{ Context }

func (Users) ByID ¶

func (db Users) ByID(id kb.Slug) (user kb.User, err error)

func (Users) Create ¶

func (db Users) Create(user kb.User) error

func (Users) Delete ¶

func (db Users) Delete(id kb.Slug) error

func (Users) List ¶

func (db Users) List() (users []kb.User, err error)

Source Files ¶

View all Source files

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