binding

package module

Go to main page

Versions in this module

v0

v0.19.3

Sep 1, 2026

v0.19.2

Aug 26, 2026

v0.19.1

Aug 21, 2026

v0.19.0

Aug 21, 2026

v0.18.20

Aug 15, 2026

Changes in this version

type Client

+ func (c *Client) CheckBindingHealth(ctx context.Context, bindingMetadata BindingMetadata) error

+ func (c *Client) CheckHealth(ctx context.Context) error

type Provider

+ func (p *Provider) CheckBindingHealth(ctx context.Context, bindingMetadata BindingMetadata) error

+ func (p *Provider) CheckHealth(ctx context.Context) error

type ServiceBinding

+ CheckBindingHealth func(ctx context.Context, bindingMetadata BindingMetadata) error

+ CheckHealth func(ctx context.Context) error

v0.18.18

Aug 12, 2026

v0.18.11

Jul 21, 2026

v0.18.10

Jul 21, 2026

v0.18.9

Jul 21, 2026

v0.18.8

Jul 21, 2026

v0.18.7

Jul 21, 2026

Changes in this version

+ const MaxMessageSize

v0.1.0

Jul 18, 2026

Changes in this version

+ const AccountKeyURL

+ const AccountKeyURLDirect

+ const BindingHostnameDisable

+ const BindingIDPrefix

+ const GrantTargetAll

+ const PluginName

+ const ProtocolVersion

+ var Handshake = plugin.HandshakeConfig

+ func AccountName(prefixProd, prefixStg, bindingId string, isStaging bool, opts NameOptions) (string, error)

+ func AccountURLs(adminURL, user, password, bindingHostname string) (accountURL, accountDirectURL string, err error)

+ func DiffGrants(currentGrants []BindingGrant, newGrants []BindingGrant) ([]BindingGrant, []BindingGrant)

+ func IsLocalBindingHost(host string) bool

+ func RandomHex(n int) (string, error)

+ func RevokeThenRegrant(revokes, regrants []BindingGrant, ...) error

+ func Serve(config *ServeConfig)

+ func ServiceConfigWithLocalhostBindingHostname(serviceConfig map[string]string, serviceURL string, ...) map[string]string

+ func SetURLHostname(u *url.URL, hostname string)

+ func VerifyKeys(inputKeys []string, requiredKeys []string, optionalKeys []string) error

+ type Artifact struct

+ Name string

+ Type ArtifactType

+ type ArtifactType string

+ const ArtifactDatabase

+ const ArtifactLogin

+ const ArtifactRole

+ const ArtifactSchema

+ const ArtifactUser

+ type BindingGrant struct

+ GrantTarget string

+ GrantType GrantType

+ func ParseGrant(grant string, supportedGrantTypes []GrantType) (BindingGrant, error)

+ func ParseGrants(grants []string, supportedGrantTypes []GrantType) ([]BindingGrant, error)

+ func SubtractGrants(list, remove []BindingGrant) []BindingGrant

+ func UnionGrants(base, extra []BindingGrant) []BindingGrant

+ func (g BindingGrant) String() string

+ type BindingMetadata struct

+ Account map[string]string

+ ApplyInfo []byte

+ Config map[string]string

+ Grants []string

+ GrantsApplied []BindingGrant

+ type Builder func() ServiceBinding

+ type Client struct

+ func (c *Client) ApplyGrants(ctx context.Context, account map[string]string, ...) (GrantApplyResult, error)

+ func (c *Client) CloseService(ctx context.Context) error

+ func (c *Client) DeleteArtifact(ctx context.Context, artifact Artifact) error

+ func (c *Client) Describe(ctx context.Context) (string, []ServiceTypeInfo, error)

+ func (c *Client) GenerateAccount(ctx context.Context, bindingId, bindingPath string, ...) (map[string]string, []Artifact, error)

+ func (c *Client) GetAccountEnv(ctx context.Context, serviceType string) ([]string, []string, error)

+ func (c *Client) InitializeService(ctx context.Context, serviceType string, serviceConfig map[string]string, ...) error

+ func (c *Client) RevokeGrants(ctx context.Context, account map[string]string, ...) error

+ func (c *Client) RunCommand(ctx context.Context, bindingMetadata BindingMetadata, command string) (map[string]any, error)

+ type GrantApplyResult struct

+ Granted []BindingGrant

+ GrantsApplied []BindingGrant

+ PendingRevokes []BindingGrant

+ func ApplyGrantsIncremental(bindingMetadata BindingMetadata, supportedGrantTypes []GrantType, ...) (GrantApplyResult, error)

+ func ApplyGrantsRebuild(bindingMetadata BindingMetadata, supportedGrantTypes []GrantType, ...) (GrantApplyResult, error)

+ type GrantType string

+ const GrantTypeCreate

+ const GrantTypeFull

+ const GrantTypeRead

+ type LaunchConfig struct

+ ExecPath string

+ LogLevel string

+ Logger hclog.Logger

+ SecureConfig *plugin.SecureConfig

+ type Logger struct

+ func NewLogger(level string) *Logger

+ type NameOptions struct

+ KeepIDPrefix bool

+ MaxLen int

+ Uppercase bool

+ type Provider struct

+ func LaunchProvider(config LaunchConfig) (*Provider, error)

+ func (p *Provider) ApplyGrants(ctx context.Context, account map[string]string, ...) (GrantApplyResult, error)

+ func (p *Provider) CloseService(ctx context.Context) error

+ func (p *Provider) DeleteArtifact(ctx context.Context, artifact Artifact) error

+ func (p *Provider) Describe(ctx context.Context) (string, []ServiceTypeInfo, error)

+ func (p *Provider) Exited() bool

+ func (p *Provider) GenerateAccount(ctx context.Context, bindingId, bindingPath string, ...) (map[string]string, []Artifact, error)

+ func (p *Provider) GetAccountEnv(ctx context.Context, serviceType string) ([]string, []string, error)

+ func (p *Provider) InitializeService(ctx context.Context, serviceType string, serviceConfig map[string]string, ...) error

+ func (p *Provider) Kill()

+ func (p *Provider) RevokeGrants(ctx context.Context, account map[string]string, ...) error

+ func (p *Provider) RunCommand(ctx context.Context, bindingMetadata BindingMetadata, command string) (map[string]any, error)

+ type ProviderError struct

+ Message string

+ func (e *ProviderError) Error() string

+ type ServeConfig struct

+ Bindings map[string]Builder

+ ProviderVersion string

+ TypeInfo map[string]ServiceTypeInfo

+ type ServiceBinding interface

+ ApplyGrants func(ctx context.Context, account map[string]string, ...) (GrantApplyResult, error)

+ CloseService func(ctx context.Context) error

+ DeleteArtifact func(ctx context.Context, artifact Artifact) error

+ GenerateAccount func(ctx context.Context, bindingId, bindingPath string, ...) (map[string]string, []Artifact, error)

+ GetAccountEnv func(ctx context.Context) ([]string, []string, error)

+ InitializeService func(ctx context.Context, logger *Logger, serviceConfig map[string]string, ...) error

+ RevokeGrants func(ctx context.Context, account map[string]string, ...) error

+ RunCommand func(ctx context.Context, bindingMetadata BindingMetadata, command string) (map[string]any, error)

+ type ServiceBindingRuntime struct

+ LocalhostBindingHostname string

+ type ServiceTypeInfo struct

+ OptionalConfigKeys []string

+ RequiredConfigKeys []string

+ ServiceType string

+ SupportedGrantTypes []GrantType

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