gotosocial/internal/db/db.go

72 lines
2.3 KiB
Go
Raw Normal View History

2021-03-02 17:26:30 +00:00
/*
GoToSocial
Copyright (C) 2021 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 (
2021-03-02 21:52:31 +00:00
"context"
2021-03-02 17:26:30 +00:00
"fmt"
"strings"
"github.com/go-fed/activity/pub"
2021-03-14 16:56:16 +00:00
"github.com/go-oauth2/oauth2/v4"
2021-03-04 13:38:18 +00:00
"github.com/gotosocial/gotosocial/internal/config"
2021-03-02 21:52:31 +00:00
"github.com/sirupsen/logrus"
2021-03-02 17:26:30 +00:00
)
const dbTypePostgres string = "POSTGRES"
2021-03-04 13:38:18 +00:00
// DB provides methods for interacting with an underlying database (for now, just postgres).
// The function mapping lines up with the DB interface described in go-fed.
2021-03-02 17:26:30 +00:00
// See here: https://github.com/go-fed/activity/blob/master/pub/database.go
2021-03-04 13:38:18 +00:00
type DB interface {
2021-03-02 17:26:30 +00:00
/*
GO-FED DATABASE FUNCTIONS
*/
pub.Database
2021-03-14 16:56:16 +00:00
/*
OAUTH2 DATABASE FUNCTIONS
*/
TokenStore() oauth2.TokenStore
2021-03-02 17:26:30 +00:00
/*
ANY ADDITIONAL DESIRED FUNCTIONS
*/
2021-03-05 17:31:12 +00:00
// CreateSchema should populate the database with the required tables
CreateSchema(context.Context) error
// Stop should stop and close the database connection cleanly, returning an error if this is not possible
2021-03-02 21:52:31 +00:00
Stop(context.Context) error
2021-03-05 17:31:12 +00:00
// IsHealthy should return nil if the database connection is healthy, or an error if not
IsHealthy(context.Context) error
2021-03-02 17:26:30 +00:00
}
2021-03-04 13:38:18 +00:00
// New returns a new database service that satisfies the Service interface and, by extension,
2021-03-02 17:26:30 +00:00
// the go-fed database interface described here: https://github.com/go-fed/activity/blob/master/pub/database.go
2021-03-04 13:38:18 +00:00
func New(ctx context.Context, c *config.Config, log *logrus.Logger) (DB, error) {
switch strings.ToUpper(c.DBConfig.Type) {
2021-03-02 17:26:30 +00:00
case dbTypePostgres:
2021-03-04 13:38:18 +00:00
return newPostgresService(ctx, c, log.WithField("service", "db"))
2021-03-02 17:26:30 +00:00
default:
2021-03-04 13:38:18 +00:00
return nil, fmt.Errorf("database type %s not supported", c.DBConfig.Type)
2021-03-02 17:26:30 +00:00
}
}