f65dad83bb
* migrate emojistore to request.ctx * use mlog.CreateConsoleTestLogger * Add comment to WithMaster and RequestContextWithMaster
55 строки
1.6 KiB
Go
55 строки
1.6 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package sqlstore
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/mattermost/mattermost/server/public/shared/request"
|
|
)
|
|
|
|
// storeContextKey is the base type for all context keys for the store.
|
|
type storeContextKey string
|
|
|
|
// contextValue is a type to hold some pre-determined context values.
|
|
type contextValue string
|
|
|
|
// Different possible values of contextValue.
|
|
const (
|
|
useMaster contextValue = "useMaster"
|
|
)
|
|
|
|
// WithMaster adds the context value that master DB should be selected for this request.
|
|
//
|
|
// Deprecated: This method is deprecated and there's ongoing change to use `request.CTX` across
|
|
// instead of `context.Context`. Please use `RequestContextWithMaster` instead.
|
|
func WithMaster(ctx context.Context) context.Context {
|
|
return context.WithValue(ctx, storeContextKey(useMaster), true)
|
|
}
|
|
|
|
// RequestContextWithMaster adds the context value that master DB should be selected for this request.
|
|
func RequestContextWithMaster(c request.CTX) request.CTX {
|
|
ctx := WithMaster(c.Context())
|
|
c.SetContext(ctx)
|
|
return c
|
|
}
|
|
|
|
// hasMaster is a helper function to check whether master DB should be selected or not.
|
|
func hasMaster(ctx context.Context) bool {
|
|
if v := ctx.Value(storeContextKey(useMaster)); v != nil {
|
|
if res, ok := v.(bool); ok && res {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// DBXFromContext is a helper utility that returns the sqlx DB handle from a given context.
|
|
func (ss *SqlStore) DBXFromContext(ctx context.Context) *sqlxDBWrapper {
|
|
if hasMaster(ctx) {
|
|
return ss.GetMasterX()
|
|
}
|
|
return ss.GetReplicaX()
|
|
}
|