Documentation
¶
Overview ¶
Package httphandler provides REST API endpoints for PostgreSQL management operations.
Register all handlers with an http.ServeMux:
httphandler.RegisterBackendHandlers(mux, "/api/v1", mgr)
This registers endpoints for roles, databases, schemas, objects, tablespaces, extensions, connections, settings, statements, replication slots, and Prometheus metrics.
Index ¶
- func RegisterBackendHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterConnectionHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterDatabaseHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterExtensionHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterFrontendHandler(router *http.ServeMux, prefix string, enabled bool)
- func RegisterMetricsHandler(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterObjectHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterReplicationSlotHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterRoleHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterSchemaHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterSettingHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterStatementHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
- func RegisterTablespaceHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterBackendHandlers ¶ added in v1.0.13
func RegisterConnectionHandlers ¶
RegisterConnectionHandlers registers HTTP handlers for connection operations on the provided router with the given path prefix. The manager must be non-nil.
func RegisterDatabaseHandlers ¶
RegisterDatabaseHandlers registers HTTP handlers for database CRUD operations on the provided router with the given path prefix. The manager must be non-nil.
func RegisterExtensionHandlers ¶
RegisterExtensionHandlers registers HTTP handlers for extension CRUD operations on the provided router with the given path prefix. The manager must be non-nil.
func RegisterFrontendHandler ¶ added in v1.0.13
RegisterFrontendHandler registers a fallback handler when frontend is not included
func RegisterMetricsHandler ¶
RegisterMetricsHandler registers a HTTP handler for prometheus metrics on the provided router with the given path prefix. The manager must be non-nil.
func RegisterObjectHandlers ¶
RegisterObjectHandlers registers HTTP handlers for object listing and retrieval on the provided router with the given path prefix. The manager must be non-nil.
func RegisterReplicationSlotHandlers ¶
func RegisterReplicationSlotHandlers(router *http.ServeMux, prefix string, manager *manager.Manager)
RegisterReplicationSlotHandlers registers HTTP handlers for replication slot CRUD operations on the provided router with the given path prefix.
func RegisterRoleHandlers ¶
RegisterRoleHandlers registers HTTP handlers for role CRUD operations on the provided router with the given path prefix. The manager must be non-nil.
func RegisterSchemaHandlers ¶
RegisterSchemaHandlers registers HTTP handlers for schema CRUD operations on the provided router with the given path prefix. The manager must be non-nil.
func RegisterSettingHandlers ¶
RegisterSettingHandlers registers HTTP handlers for server setting operations on the provided router with the given path prefix. The manager must be non-nil.
func RegisterStatementHandlers ¶
RegisterStatementHandlers registers HTTP handlers for pg_stat_statements operations on the provided router with the given path prefix. The manager must be non-nil.
Types ¶
This section is empty.
Source Files