api

Documentation

Index

• Variables
• func Connect(c *gin.Context)
• func ConnectWithBackend(c *gin.Context)
• func DB(c *gin.Context) *client.Client
• func DataExport(c *gin.Context)
• func Disconnect(c *gin.Context)
• func ExplainQuery(c *gin.Context)
• func GetActivity(c *gin.Context)
• func GetAssets() http.Handler
• func GetBookmarks(c *gin.Context)
• func GetConnectionInfo(c *gin.Context)
• func GetDatabases(c *gin.Context)
• func GetHistory(c *gin.Context)
• func GetHome() http.Handler
• func GetInfo(c *gin.Context)
• func GetObjects(c *gin.Context)
• func GetSchemas(c *gin.Context)
• func GetSessions(c *gin.Context)
• func GetTable(c *gin.Context)
• func GetTableConstraints(c *gin.Context)
• func GetTableIndexes(c *gin.Context)
• func GetTableInfo(c *gin.Context)
• func GetTableRows(c *gin.Context)
• func HandleQuery(query string, c *gin.Context)
• func RunQuery(c *gin.Context)
• func SetupMiddlewares(group *gin.RouterGroup)
• func SetupRoutes(router *gin.Engine)
• func StartSessionCleanup()
• func SwitchDb(c *gin.Context)
• type Backend
  • func (be Backend) FetchCredential(resource string, c *gin.Context) (*BackendCredential, error)
• type BackendCredential
• type BackendRequest
• type Error
  • func NewError(err error) Error

Variables

var (
	// DbClient represents the active database connection in a single-session mode
	DbClient *client.Client

	// DbSessions represents the mapping for client connections
	DbSessions = map[string]*client.Client{}
)

Functions

func Connect

func Connect(c *gin.Context)

Connect creates a new client connection

func ConnectWithBackend

func ConnectWithBackend(c *gin.Context)

ConnectWithBackend creates a new connection based on backend resource

func DB

func DB(c *gin.Context) *client.Client

DB returns a database connection from the client context

func DataExport

func DataExport(c *gin.Context)

DataExport performs database table export

func Disconnect

func Disconnect(c *gin.Context)

Disconnect closes the current database connection

func ExplainQuery

func ExplainQuery(c *gin.Context)

ExplainQuery renders query analyze profile

func GetActivity

func GetActivity(c *gin.Context)

GetActivity renders a list of running queries

func GetAssets

func GetAssets() http.Handler

func GetBookmarks

func GetBookmarks(c *gin.Context)

GetBookmarks renders the list of available bookmarks

func GetConnectionInfo

func GetConnectionInfo(c *gin.Context)

GetConnectionInfo renders information about current connection

func GetDatabases

func GetDatabases(c *gin.Context)

GetDatabases renders a list of all databases on the server

func GetHistory

func GetHistory(c *gin.Context)

GetHistory renders a list of recent queries

func GetHome

func GetHome() http.Handler

GetHome renderes the home page

func GetInfo

func GetInfo(c *gin.Context)

GetInfo renders the pgweb system information

func GetObjects

func GetObjects(c *gin.Context)

GetObjects renders a list of database objects

func GetSchemas

func GetSchemas(c *gin.Context)

GetSchemas renders list of available schemas

func GetSessions

func GetSessions(c *gin.Context)

GetSessions renders the number of active sessions

func GetTable

func GetTable(c *gin.Context)

GetTable renders table information

func GetTableConstraints

func GetTableConstraints(c *gin.Context)

GetTableConstraints renders a list of database constraints

func GetTableIndexes

func GetTableIndexes(c *gin.Context)

GetTableIndexes renders a list of database table indexes

func GetTableInfo

func GetTableInfo(c *gin.Context)

GetTableInfo renders a selected table information

func GetTableRows

func GetTableRows(c *gin.Context)

GetTableRows renders table rows

func HandleQuery

func HandleQuery(query string, c *gin.Context)

HandleQuery runs the database query

func RunQuery

func RunQuery(c *gin.Context)

RunQuery executes the query

func SetupMiddlewares

func SetupMiddlewares(group *gin.RouterGroup)

func SetupRoutes

func SetupRoutes(router *gin.Engine)

func StartSessionCleanup

func StartSessionCleanup()

StartSessionCleanup starts a goroutine to cleanup idle database sessions

func SwitchDb

func SwitchDb(c *gin.Context)

SwitchDb perform database switch for the client connection

Types

type Backend

type Backend struct {
	Endpoint    string
	Token       string
	PassHeaders string
}

Backend represents a third party configuration source

func (Backend) FetchCredential

func (be Backend) FetchCredential(resource string, c *gin.Context) (*BackendCredential, error)

FetchCredential sends an authentication request to a third-party service

type BackendCredential

type BackendCredential struct {
	DatabaseURL string `json:"database_url"`
}

BackendCredential represents the third-party response

type BackendRequest

type BackendRequest struct {
	Resource string            `json:"resource"`
	Token    string            `json:"token"`
	Headers  map[string]string `json:"headers"`
}

BackendRequest represents a payload sent to the third-party source

type Error

type Error struct {
	Message string `json:"error"`
}

func NewError

func NewError(err error) Error