patroni

package module

Go to main page

Versions in this module

v1

v1.0.0

Jul 28, 2026

v0

v0.2.0

Jul 17, 2026

Changes in this version

type TLSOptions

+ IncludeSystemCAs bool

type TransportCache

+ func NewTransportCacheWithOptions(options TransportCacheOptions) (*TransportCache, error)

+ func (cache *TransportCache) Purge()

+ type TransportCacheOptions struct

+ MaxEntries int

v0.1.2

Jul 17, 2026

v0.1.1

Jul 17, 2026

v0.1.0

Jul 17, 2026

Changes in this version

+ const PatroniV3

+ const PatroniV3MPP

+ const PatroniV4

+ const PatroniV4Point1

+ func NewHTTPTransport(ctx context.Context, options TLSOptions) (*http.Transport, error)

+ func SupportsFeature(versionText string, feature Feature) (bool, error)

+ type Authorizer interface

+ Authorize func(context.Context, *http.Request) error

+ type BasicAuth struct

+ func NewBasicAuth(username, password string) BasicAuth

+ func (auth BasicAuth) Authorize(_ context.Context, request *http.Request) error

+ func (auth BasicAuth) GoString() string

+ func (auth BasicAuth) String() string

+ type Client struct

+ func NewClient(options ClientOptions) (*Client, error)

+ func (client *Client) DeleteRestart(ctx context.Context, baseURL string) (Response[string], error)

+ func (client *Client) DeleteSwitchover(ctx context.Context, baseURL string) (Response[string], error)

+ func (client *Client) GetCluster(ctx context.Context, baseURL string) (Response[Cluster], error)

+ func (client *Client) GetConfig(ctx context.Context, baseURL string) (Response[DynamicConfig], error)

+ func (client *Client) GetFailsafe(ctx context.Context, baseURL string) (Response[FailsafeTopology], error)

+ func (client *Client) GetHealth(ctx context.Context, baseURL string, alias HealthAlias, query HealthQuery) (Response[Status], error)

+ func (client *Client) GetHistory(ctx context.Context, baseURL string) (Response[History], error)

+ func (client *Client) GetLiveness(ctx context.Context, baseURL string) (Response[Empty], error)

+ func (client *Client) GetMetrics(ctx context.Context, baseURL string) (Response[string], error)

+ func (client *Client) GetPatroni(ctx context.Context, baseURL string) (Response[Status], error)

+ func (client *Client) GetReadiness(ctx context.Context, baseURL string, query ReadinessQuery) (Response[Empty], error)

+ func (client *Client) GoString() string

+ func (client *Client) HeadHealth(ctx context.Context, baseURL string, alias HealthAlias, query HealthQuery) (Response[Empty], error)

+ func (client *Client) OptionsHealth(ctx context.Context, baseURL string, alias HealthAlias) (Response[Empty], error)

+ func (client *Client) PatchConfig(ctx context.Context, baseURL string, patch DynamicConfig) (Response[DynamicConfig], error)

+ func (client *Client) PostCitus(ctx context.Context, baseURL string, event MPPEvent) (Response[string], error)

+ func (client *Client) PostFailover(ctx context.Context, baseURL string, request FailoverRequest) (Response[string], error)

+ func (client *Client) PostFailsafe(ctx context.Context, baseURL string, request FailsafePeerRequest) (Response[string], error)

+ func (client *Client) PostMPP(ctx context.Context, baseURL string, event MPPEvent) (Response[string], error)

+ func (client *Client) PostReinitialize(ctx context.Context, baseURL string, request ReinitializeRequest) (Response[string], error)

+ func (client *Client) PostReload(ctx context.Context, baseURL string) (Response[string], error)

+ func (client *Client) PostRestart(ctx context.Context, baseURL string, request RestartRequest) (Response[string], error)

+ func (client *Client) PostSigterm(ctx context.Context, baseURL string) (Response[string], error)

+ func (client *Client) PostSwitchover(ctx context.Context, baseURL string, request FailoverRequest) (Response[string], error)

+ func (client *Client) PutConfig(ctx context.Context, baseURL string, configuration DynamicConfig) (Response[DynamicConfig], error)

+ func (client *Client) String() string

+ type ClientOptions struct

+ Authorizer Authorizer

+ HTTPClient *http.Client

+ Logger *slog.Logger

+ MaxResponseBytes int64

+ Timeout time.Duration

+ Transport http.RoundTripper

+ UserAgent string

+ type Cluster struct

+ Members []ClusterMember

+ Pause *bool

+ ScheduledSwitchover *ScheduledSwitchover

+ Scope string

+ type ClusterMember struct

+ APIURL string

+ Host string

+ LSN json.RawMessage

+ Lag json.RawMessage

+ Name string

+ PendingRestart *bool

+ PendingRestartReason map[string]PendingRestartChange

+ Port *int

+ ReceiveLSN json.RawMessage

+ ReceiveLag json.RawMessage

+ ReplayLSN json.RawMessage

+ ReplayLag json.RawMessage

+ Role string

+ ScheduledRestart *ScheduledRestart

+ State string

+ Tags map[string]any

+ Timeline *int

+ type DeliveryState string

+ const DeliveryMaybeSent

+ const DeliveryNotSent

+ const DeliveryResponseReceived

+ type DynamicConfig map[string]any

+ type Empty struct

+ type Endpoint struct

+ ID string

+ Method string

+ Path string

+ Request string

+ Response string

+ Risk Risk

+ Since string

+ func EndpointCatalog() []Endpoint

+ func EndpointCatalogFor(versionText string) ([]Endpoint, error)

+ func (endpoint Endpoint) AvailableIn(version model.Version) bool

+ type Error struct

+ Delivery DeliveryState

+ Endpoint string

+ Kind ErrorKind

+ Method string

+ StatusCode int

+ func (err *Error) AmbiguousWrite() bool

+ func (err *Error) Error() string

+ func (err *Error) GoString() string

+ func (err *Error) Unwrap() error

+ type ErrorKind string

+ const ErrorAuthentication

+ const ErrorDecode

+ const ErrorRequest

+ const ErrorResponseBody

+ const ErrorTransport

+ type FailoverRequest struct

+ Candidate string

+ Leader string

+ Member string

+ ScheduledAt string

+ type FailsafePeerRequest struct

+ APIURL string

+ ConnURL string

+ Name string

+ Slots map[string]int64

+ type FailsafeTopology map[string]string

+ type Feature string

+ const FeatureCoreRESTAPI

+ const FeatureFailsafeLSNHeader

+ const FeatureMPPEndpoint

+ const FeatureQuorumStatus

+ const FeatureReadinessLagMode

+ const FeatureReinitializeFromLeader

+ const FeatureStandbyClusterCLI

+ type FeatureAvailability struct

+ Description string

+ Feature Feature

+ Since string

+ func FeatureCatalog() []FeatureAvailability

+ type HealthAlias string

+ const HealthAny

+ const HealthAsync

+ const HealthAsynchronous

+ const HealthLeader

+ const HealthMaster

+ const HealthPrimary

+ const HealthQuorum

+ const HealthReadOnly

+ const HealthReadOnlyQuorum

+ const HealthReadOnlySync

+ const HealthReadOnlySynchronous

+ const HealthReadWrite

+ const HealthReplica

+ const HealthRoot

+ const HealthStandbyLeader

+ const HealthStandbyLeaderLegacy

+ const HealthSync

+ const HealthSynchronous

+ func HealthAliases() []HealthAlias

+ func HealthAliasesFor(versionText string) ([]HealthAlias, error)

+ type HealthQuery struct

+ Lag string

+ ReplicationState string

+ Tags map[string]string

+ type History []HistoryEntry

+ type HistoryEntry struct

+ Extra []json.RawMessage

+ LSN int64

+ Member string

+ Reason string

+ Timeline int64

+ Timestamp string

+ func (entry *HistoryEntry) UnmarshalJSON(data []byte) error

+ func (entry HistoryEntry) MarshalJSON() ([]byte, error)

+ type MPPEvent struct

+ Cooldown float64

+ Group int

+ Leader string

+ Timeout float64

+ Type string

+ type PatroniIdentity struct

+ Name string

+ Scope string

+ Version string

+ type PendingRestartChange struct

+ NewValue any

+ OldValue any

+ type ReadinessQuery struct

+ Lag string

+ Mode string

+ type ReinitializeRequest struct

+ Force bool

+ FromLeader bool

+ type ReplicationStatus struct

+ ApplicationName string

+ ClientAddress string

+ State string

+ SyncPriority *int

+ SyncState string

+ Username string

+ type Response struct

+ Data T

+ Header http.Header

+ Raw []byte

+ StatusCode int

+ type RestartRequest struct

+ PostgresVersion string

+ RestartPending *bool

+ Role string

+ Schedule string

+ Timeout any

+ type Risk string

+ const RiskAdminWrite

+ const RiskAvailabilityWrite

+ const RiskPeerInternal

+ const RiskPeerInternalRead

+ const RiskRead

+ const RiskTestPlatformDangerous

+ type ScheduledRestart struct

+ PostgresVersion string

+ RestartPending *bool

+ Role string

+ Schedule string

+ Timeout any

+ type ScheduledSwitchover struct

+ At string

+ From string

+ To string

+ type Status struct

+ ClusterUnlocked *bool

+ DCSLastSeen *int64

+ DatabaseSystemIdentifier string

+ FailsafeModeIsActive *bool

+ LoggerQueueSize *int

+ LoggerRecordsLost *int

+ Patroni PatroniIdentity

+ Pause *bool

+ PendingRestart *bool

+ PendingRestartReason map[string]PendingRestartChange

+ PostmasterStartTime string

+ QuorumStandby *bool

+ Replication []ReplicationStatus

+ ReplicationState string

+ Role string

+ ScheduledRestart *ScheduledRestart

+ ServerVersion *int

+ State string

+ SyncStandby *bool

+ Tags map[string]any

+ Timeline *int

+ WatchdogFailed *bool

+ XLog XLogStatus

+ type TLSConfigError struct

+ Field string

+ func (err *TLSConfigError) Error() string

+ func (err *TLSConfigError) GoString() string

+ func (err *TLSConfigError) Unwrap() error

+ type TLSOptions struct

+ CAFile string

+ CertFile string

+ InsecureSkipVerify bool

+ KeyFile string

+ ServerName string

+ func (options TLSOptions) GoString() string

+ func (options TLSOptions) String() string

+ func (options TLSOptions) WithKeyPassword(password string) TLSOptions

+ type TransportCache struct

+ func NewTransportCache() *TransportCache

+ func (cache *TransportCache) CloseIdleConnections()

+ func (cache *TransportCache) Transport(ctx context.Context, options TLSOptions) (*http.Transport, error)

+ type XLogStatus struct

+ Location *int64

+ Paused *bool

+ ReceivedLocation *int64

+ ReplayedLocation *int64

+ ReplayedTimestamp any

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL