Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

database

package

Go to main page

Versions in this module

v0

v0.5.1

Mar 28, 2022

Changes in this version

type ListAppOptions

+ Enabled *bool

type SqlxCache

+ func (db *SqlxCache) BeginImmediatex() (*TxWrapper, error)

v0.5.0

Jan 2, 2022

v0.4.0

Jun 21, 2021

Changes in this version

+ var ErrInvalidName = errors.New("bad_request: Invalid name")

+ var ErrInvalidQuery = errors.New("invalid_query: Invalid query")

+ var ErrInvalidUserName = errors.New("bad_request: Invalid Username")

+ var ErrNoPasswordGiven = errors.New("bad_request: A user cannot have an empty password")

+ var ErrNoUpdate = errors.New("nop: Nothing to update")

+ var ErrNotFound = errors.New("not_found: The selected resource was not found")

+ var ErrSAccessDenied = errors.New("access_denied: You don't have necessary permissions for the given query")

+ var ErrUnimplemented = errors.New("The given functionality is currently unimplemented")

+ var ErrUserNotFound = errors.New("not_found: User was not found")

+ func AddCreateHook(f func(*AdminDB) error)

+ func CanSubscribe(db DB, e *events.Event) error

+ func CheckPassword(password, hashed string) error

+ func Create(a *assets.Assets) error

+ func ErrAccessDenied(err string, args ...interface{}) error

+ func ErrBadQuery(err string, args ...interface{}) error

+ func FillEvent(db *AdminDB, e *events.Event) error

+ func GenerateKey(length int) (string, error)

+ func GetExecError(result sql.Result, err error) error

+ func HashPassword(password string) (string, error)

+ func QQ(size int) string

+ func ValidGroupScopes(s *ScopeArray) error

+ func ValidIcon(icon string) error

+ func ValidUserName(name string) error

+ type AdminDB struct

+ func Open(a *assets.Assets) (*AdminDB, error)

+ func (db *AdminDB) AdminDB() *AdminDB

+ func (db *AdminDB) As(identifier string) (DB, error)

+ func (db *AdminDB) Assets() *assets.Assets

+ func (db *AdminDB) AuthUser(username string, password string) (string, string, error)

+ func (db *AdminDB) CanCreateObject(s *Object) error

+ func (db *AdminDB) Close() error

+ func (db *AdminDB) CreateApp(c *App) (string, string, error)

+ func (db *AdminDB) CreateObject(s *Object) (string, error)

+ func (db *AdminDB) CreateUser(u *User) error

+ func (db *AdminDB) CreateUserSession(username string, description string) (token string, sessionid string, err error)

+ func (db *AdminDB) DelApp(id string) error

+ func (db *AdminDB) DelObject(id string) error

+ func (db *AdminDB) DelUser(name string) error

+ func (db *AdminDB) DelUserSession(username, sessionid string) error

+ func (db *AdminDB) DelUserSessionByToken(token string) error

+ func (db *AdminDB) GetAppByAccessToken(accessToken string) (*App, error)

+ func (db *AdminDB) GetObjectShares(objectid string) (m map[string]*ScopeArray, err error)

+ func (db *AdminDB) GetUserSessionByToken(token string) (string, string, error)

+ func (db *AdminDB) ID() string

+ func (db *AdminDB) ListApps(o *ListAppOptions) ([]*App, error)

+ func (db *AdminDB) ListObjects(o *ListObjectsOptions) ([]*Object, error)

+ func (db *AdminDB) ListUserSessions(username string) (u []UserSession, err error)

+ func (db *AdminDB) ListUsers(o *ListUsersOptions) (u []*User, err error)

+ func (db *AdminDB) ReadApp(aid string, o *ReadAppOptions) (*App, error)

+ func (db *AdminDB) ReadObject(id string, o *ReadObjectOptions) (s *Object, err error)

+ func (db *AdminDB) ReadPluginDatabaseVersion(plugin string) (int, error)

+ func (db *AdminDB) ReadUser(name string, o *ReadUserOptions) (*User, error)

+ func (db *AdminDB) ReadUserPluginSettings(username string, plugin string) (v map[string]interface{}, err error)

+ func (db *AdminDB) ReadUserSettings(username string) (map[string]map[string]interface{}, error)

+ func (db *AdminDB) ShareObject(objectid, userid string, sa *ScopeArray) error

+ func (db *AdminDB) Type() DBType

+ func (db *AdminDB) UnshareObject(objectid string) error

+ func (db *AdminDB) UnshareObjectFromUser(objectid, userid string) error

+ func (db *AdminDB) UpdateApp(c *App) (err error)

+ func (db *AdminDB) UpdateObject(s *Object) error

+ func (db *AdminDB) UpdateUser(u *User) error

+ func (db *AdminDB) UpdateUserPluginSettings(username string, plugin string, preferences map[string]interface{}) (err error)

+ func (db *AdminDB) User() (*User, error)

+ func (db *AdminDB) WritePluginDatabaseVersion(plugin string, version int) error

+ type App struct

+ AccessToken *string

+ CreatedDate dbutil.Date

+ Enabled *bool

+ LastAccessDate *dbutil.Date

+ Owner *string

+ Plugin *string

+ Scope *AppScopeArray

+ Settings *dbutil.JSONObject

+ SettingsSchema *dbutil.JSONObject

+ func (a *App) String() string

+ type AppDB struct

+ func NewAppDB(adb *AdminDB, c *App) *AppDB

+ func (c *AppDB) GetObjectAccess(s *Object) (sa ScopeArray)

+ func (db *AppDB) AdminDB() *AdminDB

+ func (db *AppDB) CanCreateObject(s *Object) error

+ func (db *AppDB) CreateApp(c *App) (string, string, error)

+ func (db *AppDB) CreateObject(s *Object) (string, error)

+ func (db *AppDB) CreateUser(u *User) error

+ func (db *AppDB) DelApp(cid string) error

+ func (db *AppDB) DelObject(id string) error

+ func (db *AppDB) DelUser(name string) error

+ func (db *AppDB) DelUserSession(name, id string) error

+ func (db *AppDB) GetObjectShares(objectid string) (m map[string]*ScopeArray, err error)

+ func (db *AppDB) ID() string

+ func (db *AppDB) ListApps(o *ListAppOptions) ([]*App, error)

+ func (db *AppDB) ListObjects(o *ListObjectsOptions) ([]*Object, error)

+ func (db *AppDB) ListUserSessions(name string) ([]UserSession, error)

+ func (db *AppDB) ListUsers(o *ListUsersOptions) ([]*User, error)

+ func (db *AppDB) ReadApp(cid string, o *ReadAppOptions) (*App, error)

+ func (db *AppDB) ReadObject(id string, o *ReadObjectOptions) (*Object, error)

+ func (db *AppDB) ReadUser(name string, o *ReadUserOptions) (*User, error)

+ func (db *AppDB) ReadUserPluginSettings(username string, plugin string) (map[string]interface{}, error)

+ func (db *AppDB) ReadUserSettings(username string) (map[string]map[string]interface{}, error)

+ func (db *AppDB) ShareObject(objectid, userid string, sa *ScopeArray) error

+ func (db *AppDB) Type() DBType

+ func (db *AppDB) UnshareObject(objectid string) error

+ func (db *AppDB) UnshareObjectFromUser(objectid, userid string) error

+ func (db *AppDB) UpdateApp(c *App) error

+ func (db *AppDB) UpdateObject(s *Object) error

+ func (db *AppDB) UpdateUser(u *User) error

+ func (db *AppDB) UpdateUserPluginSettings(username string, plugin string, preferences map[string]interface{}) error

+ func (db *AppDB) User() (*User, error)

+ type AppScopeArray struct

+ func (s *AppScopeArray) HasScope(sv string) (ok bool)

+ func (s *AppScopeArray) Update()

+ type DB interface

+ AdminDB func() *AdminDB

+ CanCreateObject func(s *Object) error

+ CreateApp func(c *App) (string, string, error)

+ CreateObject func(s *Object) (string, error)

+ CreateUser func(u *User) error

+ DelApp func(cid string) error

+ DelObject func(id string) error

+ DelUser func(name string) error

+ DelUserSession func(name, id string) error

+ GetObjectShares func(objectid string) (m map[string]*ScopeArray, err error)

+ ID func() string

+ ListApps func(o *ListAppOptions) ([]*App, error)

+ ListObjects func(o *ListObjectsOptions) ([]*Object, error)

+ ListUserSessions func(name string) ([]UserSession, error)

+ ListUsers func(o *ListUsersOptions) ([]*User, error)

+ ReadApp func(cid string, o *ReadAppOptions) (*App, error)

+ ReadObject func(id string, o *ReadObjectOptions) (*Object, error)

+ ReadUser func(name string, o *ReadUserOptions) (*User, error)

+ ReadUserPluginSettings func(username string, plugin string) (map[string]interface{}, error)

+ ReadUserSettings func(username string) (map[string]map[string]interface{}, error)

+ ShareObject func(objectid, userid string, sa *ScopeArray) error

+ Type func() DBType

+ UnshareObject func(objectid string) error

+ UnshareObjectFromUser func(objectid, userid string) error

+ UpdateApp func(c *App) error

+ UpdateObject func(s *Object) error

+ UpdateUser func(u *User) error

+ UpdateUserPluginSettings func(username string, plugin string, preferences map[string]interface{}) error

+ type DBType int

+ const AdminType

+ const AppType

+ const PublicType

+ const UserType

+ type Details struct

+ Description *string

+ ID string

+ Icon *string

+ Name *string

+ type FilledHandler struct

+ DB *AdminDB

+ func NewFilledHandler(db *AdminDB, h events.Handler) FilledHandler

+ func (fh FilledHandler) Fire(e *events.Event)

+ type ListAppOptions struct

+ Owner *string

+ Plugin *string

+ type ListObjectsOptions struct

+ App *string

+ Key *string

+ Limit *int

+ Owner *string

+ Shared bool

+ Tags *string

+ Type *string

+ type ListUsersOptions struct

+ type Object struct

+ Access ScopeArray

+ App *string

+ CreatedDate *dbutil.Date

+ Key *string

+ Meta *dbutil.JSONObject

+ ModifiedDate *dbutil.Date

+ Owner *string

+ OwnerScope *ScopeArray

+ Tags *dbutil.StringArray

+ Type *string

+ func (s *Object) String() string

+ type PublicDB struct

+ func NewPublicDB(db *AdminDB) *PublicDB

+ func (db *PublicDB) AdminDB() *AdminDB

+ func (db *PublicDB) CanCreateObject(s *Object) error

+ func (db *PublicDB) CreateApp(c *App) (string, string, error)

+ func (db *PublicDB) CreateObject(s *Object) (string, error)

+ func (db *PublicDB) CreateUser(u *User) error

+ func (db *PublicDB) DelApp(cid string) error

+ func (db *PublicDB) DelObject(id string) error

+ func (db *PublicDB) DelUser(name string) error

+ func (db *PublicDB) DelUserSession(name, id string) error

+ func (db *PublicDB) GetObjectShares(objectid string) (m map[string]*ScopeArray, err error)

+ func (db *PublicDB) ID() string

+ func (db *PublicDB) ListApps(o *ListAppOptions) ([]*App, error)

+ func (db *PublicDB) ListObjects(o *ListObjectsOptions) ([]*Object, error)

+ func (db *PublicDB) ListUserSessions(name string) ([]UserSession, error)

+ func (db *PublicDB) ListUsers(o *ListUsersOptions) ([]*User, error)

+ func (db *PublicDB) ReadApp(cid string, o *ReadAppOptions) (*App, error)

+ func (db *PublicDB) ReadObject(id string, o *ReadObjectOptions) (*Object, error)

+ func (db *PublicDB) ReadUser(name string, o *ReadUserOptions) (*User, error)

+ func (db *PublicDB) ReadUserPluginSettings(username string, plugin string) (map[string]interface{}, error)

+ func (db *PublicDB) ReadUserSettings(username string) (map[string]map[string]interface{}, error)

+ func (db *PublicDB) ShareObject(objectid, userid string, sa *ScopeArray) error

+ func (db *PublicDB) Type() DBType

+ func (db *PublicDB) UnshareObject(objectid string) error

+ func (db *PublicDB) UnshareObjectFromUser(objectid, userid string) error

+ func (db *PublicDB) UpdateApp(c *App) error

+ func (db *PublicDB) UpdateObject(s *Object) error

+ func (db *PublicDB) UpdateUser(u *User) error

+ func (db *PublicDB) UpdateUserPluginSettings(username string, plugin string, preferences map[string]interface{}) error

+ func (db *PublicDB) User() (*User, error)

+ type ReadAppOptions struct

+ AccessToken bool

+ Icon bool

+ type ReadObjectOptions struct

+ Icon bool

+ type ReadUserOptions struct

+ Icon bool

+ type ScopeArray struct

+ Scope []string

+ func (s *ScopeArray) HasScope(sv string) (ok bool)

+ func (s *ScopeArray) Load(total string)

+ func (s *ScopeArray) MarshalJSON() ([]byte, error)

+ func (s *ScopeArray) Scan(val interface{}) error

+ func (s *ScopeArray) String() string

+ func (s *ScopeArray) UnmarshalJSON(b []byte) error

+ func (s *ScopeArray) Update()

+ func (s *ScopeArray) Value() (driver.Value, error)

+ type SqlxCache struct

+ DB *sqlx.DB

+ Verbose bool

+ func (c *SqlxCache) InitCache(sqldb *sqlx.DB)

+ func (db *SqlxCache) Beginx() (TxWrapper, error)

+ func (db *SqlxCache) Exec(query string, args ...interface{}) (sql.Result, error)

+ func (db *SqlxCache) ExecUncached(query string, args ...interface{}) (sql.Result, error)

+ func (db *SqlxCache) Get(dest interface{}, query string, args ...interface{}) error

+ func (db *SqlxCache) GetOrPrepare(query string) (*sqlx.Stmt, error)

+ func (db *SqlxCache) GetOrPrepareNamed(query string) (*sqlx.NamedStmt, error)

+ func (db *SqlxCache) NamedExec(query string, arg interface{}) (sql.Result, error)

+ func (db *SqlxCache) Queryx(query string, args ...interface{}) (*sqlx.Rows, error)

+ func (db *SqlxCache) Select(dest interface{}, query string, args ...interface{}) error

+ type TxWrapper struct

+ Verbose bool

+ func (tx TxWrapper) Commit() error

+ func (tx TxWrapper) Exec(query string, args ...interface{}) (sql.Result, error)

+ func (tx TxWrapper) Get(dest interface{}, query string, args ...interface{}) error

+ func (tx TxWrapper) Queryx(query string, args ...interface{}) (*sqlx.Rows, error)

+ func (tx TxWrapper) Rollback() error

+ func (tx TxWrapper) Select(dest interface{}, query string, args ...interface{}) error

+ type User struct

+ Password *string

+ PublicRead *bool

+ UserName *string

+ UsersRead *bool

+ type UserDB struct

+ func NewUserDB(adb *AdminDB, user string) *UserDB

+ func (db *UserDB) AdminDB() *AdminDB

+ func (db *UserDB) CanCreateObject(s *Object) error

+ func (db *UserDB) CreateApp(c *App) (string, string, error)

+ func (db *UserDB) CreateObject(s *Object) (string, error)

+ func (db *UserDB) CreateUser(u *User) error

+ func (db *UserDB) DelApp(cid string) error

+ func (db *UserDB) DelObject(id string) error

+ func (db *UserDB) DelUser(name string) error

+ func (db *UserDB) DelUserSession(username, id string) error

+ func (db *UserDB) GetObjectShares(objectid string) (m map[string]*ScopeArray, err error)

+ func (db *UserDB) ID() string

+ func (db *UserDB) ListApps(o *ListAppOptions) ([]*App, error)

+ func (db *UserDB) ListObjects(o *ListObjectsOptions) ([]*Object, error)

+ func (db *UserDB) ListUserSessions(username string) ([]UserSession, error)

+ func (db *UserDB) ListUsers(o *ListUsersOptions) ([]*User, error)

+ func (db *UserDB) ReadApp(cid string, o *ReadAppOptions) (*App, error)

+ func (db *UserDB) ReadObject(id string, o *ReadObjectOptions) (*Object, error)

+ func (db *UserDB) ReadUser(name string, o *ReadUserOptions) (*User, error)

+ func (db *UserDB) ReadUserPluginSettings(username string, plugin string) (map[string]interface{}, error)

+ func (db *UserDB) ReadUserSettings(username string) (map[string]map[string]interface{}, error)

+ func (db *UserDB) ShareObject(objectid, userid string, sa *ScopeArray) error

+ func (db *UserDB) Type() DBType

+ func (db *UserDB) UnshareObject(objectid string) error

+ func (db *UserDB) UnshareObjectFromUser(objectid, userid string) error

+ func (db *UserDB) UpdateApp(c *App) error

+ func (db *UserDB) UpdateObject(s *Object) error

+ func (db *UserDB) UpdateUser(u *User) error

+ func (db *UserDB) UpdateUserPluginSettings(username string, plugin string, preferences map[string]interface{}) error

+ func (db *UserDB) User() (*User, error)

+ type UserSession struct

+ CreatedDate dbutil.Date

+ Description string

+ LastAccessDate dbutil.Date

+ SessionID string

v0.4.0-alpha.1

Feb 28, 2020