summaryrefslogtreecommitdiff
path: root/internal/db/user.go
diff options
context:
space:
mode:
Diffstat (limited to 'internal/db/user.go')
-rw-r--r--internal/db/user.go42
1 files changed, 42 insertions, 0 deletions
diff --git a/internal/db/user.go b/internal/db/user.go
new file mode 100644
index 000000000..a4d48db56
--- /dev/null
+++ b/internal/db/user.go
@@ -0,0 +1,42 @@
+/*
+ GoToSocial
+ Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package db
+
+import (
+ "context"
+
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+)
+
+// User contains functions related to user getting/setting/creation.
+type User interface {
+ // GetUserByID returns one user with the given ID, or an error if something goes wrong.
+ GetUserByID(ctx context.Context, id string) (*gtsmodel.User, Error)
+ // GetUserByAccountID returns one user by its account ID, or an error if something goes wrong.
+ GetUserByAccountID(ctx context.Context, accountID string) (*gtsmodel.User, Error)
+ // GetUserByID returns one user with the given email address, or an error if something goes wrong.
+ GetUserByEmailAddress(ctx context.Context, emailAddress string) (*gtsmodel.User, Error)
+ // GetUserByConfirmationToken returns one user by its confirmation token, or an error if something goes wrong.
+ GetUserByConfirmationToken(ctx context.Context, confirmationToken string) (*gtsmodel.User, Error)
+ // UpdateUser updates one user by its primary key. If columns is set, only given columns
+ // will be updated. If not set, all columns will be updated.
+ UpdateUser(ctx context.Context, user *gtsmodel.User, columns ...string) (*gtsmodel.User, Error)
+ // DeleteUserByID deletes one user by its ID.
+ DeleteUserByID(ctx context.Context, userID string) Error
+}