mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2026-01-06 21:53:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update comments

Browse source
This commit is contained in:
Neil Alexander 2022-05-03 13:13:15 +01:00
parent 7a805e16d5
commit 6fb0575123
No known key found for this signature in database
GPG key ID: A02A2019A2BB0944
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
setup/base/base.go
View file

@ -236,8 +236,8 @@ func NewBaseDendrite(cfg *config.Dendrite, componentName string, options ...Base
DendriteAdminMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.DendriteAdminPathPrefix).Subrouter().UseEncodedPath(), DendriteAdminMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.DendriteAdminPathPrefix).Subrouter().UseEncodedPath(),
SynapseAdminMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.SynapseAdminPathPrefix).Subrouter().UseEncodedPath(), SynapseAdminMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.SynapseAdminPathPrefix).Subrouter().UseEncodedPath(),
apiHttpClient: &apiClient, apiHttpClient: &apiClient,
Database: db, // monolith only Database: db, // set if monolith with global connection pool only
DatabaseWriter: writer, // monolith only DatabaseWriter: writer, // set if monolith with global connection pool only
} }
} }
@ -246,14 +246,24 @@ func (b *BaseDendrite) Close() error {
return b.tracerCloser.Close() return b.tracerCloser.Close()
} }
// DatabaseConnection sets up a new database connection if appropriate, // DatabaseConnection assists in setting up a database connection. It accepts
// or returns the global connection pool if not. // the database properties and a new writer for the given component. If we're
// running in monolith mode with a global connection pool configured then we
// will return that connection, along with the global writer, effectively
// ignoring the options provided. Otherwise we'll open a new database connection
// using the supplied options and writer. Note that it's possible for the pointer
// receiver to be nil here – that's deliberate as some of the unit tests don't
// have a BaseDendrite and just want a connection with the supplied config
// without any pooling stuff.
func (b *BaseDendrite) DatabaseConnection(dbProperties *config.DatabaseOptions, writer sqlutil.Writer) (*sql.DB, sqlutil.Writer, error) { func (b *BaseDendrite) DatabaseConnection(dbProperties *config.DatabaseOptions, writer sqlutil.Writer) (*sql.DB, sqlutil.Writer, error) {
if dbProperties.ConnectionString != "" || b == nil { if dbProperties.ConnectionString != "" || b == nil {
// Open a new database connection using the supplied config.
db, err := sqlutil.Open(dbProperties, writer) db, err := sqlutil.Open(dbProperties, writer)
return db, writer, err return db, writer, err
} }
if b.Database != nil { if b.Database != nil && b.DatabaseWriter != nil {
// Ignore the supplied config and return the global pool and
// writer.
return b.Database, b.DatabaseWriter, nil return b.Database, b.DatabaseWriter, nil
} }
return nil, nil, fmt.Errorf("no database connections configured") return nil, nil, fmt.Errorf("no database connections configured")