Help us shape the future of Go! Take the 2026 Go Developer Survey

avro

package
v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

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

Provider generates Apache Avro schemas from applications.

func NewProvider

func NewProvider(specVersion string, schemaFiles []string) *Provider

NewProvider creates a new Avro schema provider specVersion should be the Avro specification version (e.g., "1.11.1").

func (*Provider) ContentType

func (p *Provider) ContentType() string

ContentType returns the content type.

func (*Provider) Endpoint

func (p *Provider) Endpoint() string

Endpoint returns the HTTP endpoint where the schema is served.

func (*Provider) Generate

func (p *Provider) Generate(ctx context.Context, app farp.Application) (any, error)

Generate generates an Avro schema from the application.

func (*Provider) GenerateDescriptor

func (p *Provider) GenerateDescriptor(ctx context.Context, app farp.Application, locationType farp.LocationType, locationConfig map[string]string) (*farp.SchemaDescriptor, error)

GenerateDescriptor generates a complete SchemaDescriptor for this schema.

func (*Provider) GetSchemaFiles

func (p *Provider) GetSchemaFiles() []string

GetSchemaFiles returns the configured schema files.

func (*Provider) Hash

func (p *Provider) Hash(schema any) (string, error)

Hash calculates SHA256 hash of the schema.

func (*Provider) Serialize

func (p *Provider) Serialize(schema any) ([]byte, error)

Serialize converts schema to JSON bytes.

func (*Provider) SetEndpoint

func (p *Provider) SetEndpoint(endpoint string)

SetEndpoint sets the HTTP endpoint for the Avro schema.

func (*Provider) SetSchemaFiles

func (p *Provider) SetSchemaFiles(files []string)

SetSchemaFiles sets the .avsc schema files to parse.

func (*Provider) SpecVersion

func (p *Provider) SpecVersion() string

SpecVersion returns the Avro specification version.

func (*Provider) Type

func (p *Provider) Type() farp.SchemaType

Type returns the schema type.

func (*Provider) Validate

func (p *Provider) Validate(schema any) error

Validate validates an Avro schema.

Jump to

Keyboard shortcuts

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