postgres

Documentation

Index

• Variables
• type Database
  • func NewDatabase(dbProperties *config.DatabaseOptions, serverName gomatrixserverlib.ServerName) (*Database, error)
  • func (d *Database) CheckAccountAvailability(ctx context.Context, localpart string) (bool, error)
  • func (d *Database) CreateAccount(ctx context.Context, localpart, plaintextPassword, appserviceID string) (acc *api.Account, err error)
  • func (d *Database) CreateGuestAccount(ctx context.Context) (acc *api.Account, err error)
  • func (d *Database) DeactivateAccount(ctx context.Context, localpart string) (err error)
  • func (d *Database) GetAccountByLocalpart(ctx context.Context, localpart string) (*api.Account, error)
  • func (d *Database) GetAccountByPassword(ctx context.Context, localpart, plaintextPassword string) (*api.Account, error)
  • func (d *Database) GetAccountData(ctx context.Context, localpart string) (global map[string]json.RawMessage, rooms map[string]map[string]json.RawMessage, ...)
  • func (d *Database) GetAccountDataByType(ctx context.Context, localpart, roomID, dataType string) (data json.RawMessage, err error)
  • func (d *Database) GetLocalpartForThreePID(ctx context.Context, threepid string, medium string) (localpart string, err error)
  • func (d *Database) GetNewNumericLocalpart(ctx context.Context) (int64, error)
  • func (d *Database) GetProfileByLocalpart(ctx context.Context, localpart string) (*authtypes.Profile, error)
  • func (d *Database) GetThreePIDsForLocalpart(ctx context.Context, localpart string) (threepids []authtypes.ThreePID, err error)
  • func (d *Database) RemoveThreePIDAssociation(ctx context.Context, threepid string, medium string) (err error)
  • func (d *Database) SaveAccountData(ctx context.Context, localpart, roomID, dataType string, ...) error
  • func (d *Database) SaveThreePIDAssociation(ctx context.Context, threepid, localpart, medium string) (err error)
  • func (d *Database) SearchProfiles(ctx context.Context, searchString string, limit int) ([]authtypes.Profile, error)
  • func (d *Database) SetAvatarURL(ctx context.Context, localpart string, avatarURL string) error
  • func (d *Database) SetDisplayName(ctx context.Context, localpart string, displayName string) error
  • func (d *Database) SetPassword(ctx context.Context, localpart, plaintextPassword string) error

Variables

var Err3PIDInUse = errors.New("This third-party identifier is already in use")

Err3PIDInUse is the error returned when trying to save an association involving a third-party identifier which is already associated to a local user.

Types

type Database

type Database struct {
	sqlutil.PartitionOffsetStatements
	// contains filtered or unexported fields
}

Database represents an account database

func NewDatabase

func NewDatabase(dbProperties *config.DatabaseOptions, serverName gomatrixserverlib.ServerName) (*Database, error)

NewDatabase creates a new accounts and profiles database

func (*Database) CheckAccountAvailability

func (d *Database) CheckAccountAvailability(ctx context.Context, localpart string) (bool, error)

CheckAccountAvailability checks if the username/localpart is already present in the database. If the DB returns sql.ErrNoRows the Localpart isn't taken.

func (*Database) CreateAccount

func (d *Database) CreateAccount(
	ctx context.Context, localpart, plaintextPassword, appserviceID string,
) (acc *api.Account, err error)

CreateAccount makes a new account with the given login name and password, and creates an empty profile for this account. If no password is supplied, the account will be a passwordless account. If the account already exists, it will return nil, sqlutil.ErrUserExists.

func (*Database) CreateGuestAccount

func (d *Database) CreateGuestAccount(ctx context.Context) (acc *api.Account, err error)

CreateGuestAccount makes a new guest account and creates an empty profile for this account.

func (*Database) DeactivateAccount

func (d *Database) DeactivateAccount(ctx context.Context, localpart string) (err error)

DeactivateAccount deactivates the user's account, removing all ability for the user to login again.

func (*Database) GetAccountByLocalpart

func (d *Database) GetAccountByLocalpart(ctx context.Context, localpart string,
) (*api.Account, error)

GetAccountByLocalpart returns the account associated with the given localpart. This function assumes the request is authenticated or the account data is used only internally. Returns sql.ErrNoRows if no account exists which matches the given localpart.

func (*Database) GetAccountByPassword

func (d *Database) GetAccountByPassword(
	ctx context.Context, localpart, plaintextPassword string,
) (*api.Account, error)

GetAccountByPassword returns the account associated with the given localpart and password. Returns sql.ErrNoRows if no account exists which matches the given localpart.

func (*Database) GetAccountData

func (d *Database) GetAccountData(ctx context.Context, localpart string) (
	global map[string]json.RawMessage,
	rooms map[string]map[string]json.RawMessage,
	err error,
)

GetAccountData returns account data related to a given localpart If no account data could be found, returns an empty arrays Returns an error if there was an issue with the retrieval

func (*Database) GetAccountDataByType

func (d *Database) GetAccountDataByType(
	ctx context.Context, localpart, roomID, dataType string,
) (data json.RawMessage, err error)

GetAccountDataByType returns account data matching a given localpart, room ID and type. If no account data could be found, returns nil Returns an error if there was an issue with the retrieval

func (*Database) GetLocalpartForThreePID

func (d *Database) GetLocalpartForThreePID(
	ctx context.Context, threepid string, medium string,
) (localpart string, err error)

GetLocalpartForThreePID looks up the localpart associated with a given third-party identifier. If no association involves the given third-party idenfitier, returns an empty string. Returns an error if there was a problem talking to the database.

func (*Database) GetNewNumericLocalpart

func (d *Database) GetNewNumericLocalpart(
	ctx context.Context,
) (int64, error)

GetNewNumericLocalpart generates and returns a new unused numeric localpart

func (*Database) GetProfileByLocalpart

func (d *Database) GetProfileByLocalpart(
	ctx context.Context, localpart string,
) (*authtypes.Profile, error)

GetProfileByLocalpart returns the profile associated with the given localpart. Returns sql.ErrNoRows if no profile exists which matches the given localpart.

func (*Database) GetThreePIDsForLocalpart

func (d *Database) GetThreePIDsForLocalpart(
	ctx context.Context, localpart string,
) (threepids []authtypes.ThreePID, err error)

GetThreePIDsForLocalpart looks up the third-party identifiers associated with a given local user. If no association is known for this user, returns an empty slice. Returns an error if there was an issue talking to the database.

func (*Database) RemoveThreePIDAssociation

func (d *Database) RemoveThreePIDAssociation(
	ctx context.Context, threepid string, medium string,
) (err error)

RemoveThreePIDAssociation removes the association involving a given third-party identifier. If no association exists involving this third-party identifier, returns nothing. If there was a problem talking to the database, returns an error.

func (*Database) SaveAccountData

func (d *Database) SaveAccountData(
	ctx context.Context, localpart, roomID, dataType string, content json.RawMessage,
) error

SaveAccountData saves new account data for a given user and a given room. If the account data is not specific to a room, the room ID should be an empty string If an account data already exists for a given set (user, room, data type), it will update the corresponding row with the new content Returns a SQL error if there was an issue with the insertion/update

func (*Database) SaveThreePIDAssociation

func (d *Database) SaveThreePIDAssociation(
	ctx context.Context, threepid, localpart, medium string,
) (err error)

SaveThreePIDAssociation saves the association between a third party identifier and a local Matrix user (identified by the user's ID's local part). If the third-party identifier is already part of an association, returns Err3PIDInUse. Returns an error if there was a problem talking to the database.

func (*Database) SearchProfiles

func (d *Database) SearchProfiles(ctx context.Context, searchString string, limit int,
) ([]authtypes.Profile, error)

SearchProfiles returns all profiles where the provided localpart or display name match any part of the profiles in the database.

func (*Database) SetAvatarURL

func (d *Database) SetAvatarURL(
	ctx context.Context, localpart string, avatarURL string,
) error

SetAvatarURL updates the avatar URL of the profile associated with the given localpart. Returns an error if something went wrong with the SQL query

func (*Database) SetDisplayName

func (d *Database) SetDisplayName(
	ctx context.Context, localpart string, displayName string,
) error

SetDisplayName updates the display name of the profile associated with the given localpart. Returns an error if something went wrong with the SQL query

func (*Database) SetPassword

func (d *Database) SetPassword(
	ctx context.Context, localpart, plaintextPassword string,
) error

SetPassword sets the account password to the given hash.