pgapi

type PgConnectionString struct {
	// contains filtered or unexported fields
}

type PgConnector interface {
	// ConnectionString provides the PgConnectionString of the current connection
	ConnectionString() PgConnectionString
	// IsConnected returns the current connection state,
	// true if the connection is established, false if not
	IsConnected() bool
	// TestConnection tries to establish a connection
	// and communicates with the Postgres instance if possible.
	// If the connection cannot be established, or the server does not communicate
	// as expected, an error is returned
	TestConnection() error
}

type PgDatabaseAPI interface {
	// IsDatabaseExisting returns true if a database
	// with the given name exists on the connected instance and false if not.
	IsDatabaseExisting(databaseName string) (bool, error)
	// CreateDatabase creates a new database on the connected instance
	CreateDatabase(databaseName string) error
	// DeleteDatabase drops the database with the given name on the connected instance
	DeleteDatabase(databaseName string) error
	// GetDatabaseOwner returns the owner of the database with the given name on the connected instance
	GetDatabaseOwner(databaseName string) (string, error)
	// UpdateDatabaseOwner changes the owner of the database with the given name to the role with the given name
	UpdateDatabaseOwner(databaseName string, roleName string) error
	// ResetDatabaseOwner changes the owner of the database with the given name to the role with which the client is connected
	ResetDatabaseOwner(databaseName string) error
	// UpdateDatabasePrivileges changes the given privileges on the given database for the given role
	UpdateDatabasePrivileges(databaseName string, roleName string, privileges []string) error
}

type PgInstanceAPI interface {
	PgConnector
	PgRoleAPI
	PgDatabaseAPI
	PgSchemaAPI
}

type PgRoleAPI interface {
	// IsRoleExisting returns true if a role
	// with the given name exists on the connected instance and false if not.
	IsRoleExisting(roleName string) (bool, error)
	// CreateRole creates the given role on the connected instance
	CreateRole(name string) error
	// DeleteRole drops the given role from the connected instance
	DeleteRole(name string) error
	// UpdateUserPassword changes the password for the given role
	UpdateUserPassword(name string, password string) error
}

type PgSchemaAPI interface {
	// IsSchemaInDatabase returns true if a schema
	// with the given name exists in the given database and false if not.
	IsSchemaInDatabase(databaseName string, schemaName string) (bool, error)
	// CreateSchema creates a new schema with the given name in the given database
	CreateSchema(databaseName string, schemaName string) error
	// DeleteSchema drops the given schema from the given database
	DeleteSchema(databaseName string, schemaName string) error
	// UpdateDefaultPrivileges updates the default privileges in the given schema
	// for the given role on the given type to the given privileges
	UpdateDefaultPrivileges(databaseName string, schemaName string, roleName string, typeName string, privileges []string) error
	// DeleteAllPrivilegesOnSchema removes all privileges on the given schema for the given role
	DeleteAllPrivilegesOnSchema(databaseName string, schemaName string, role string) error
}