Documentation
¶
Overview ¶
Package registry implements a Confluent Schema Registry compliant client.
See the Confluent Schema Registry docs for an understanding of the API: https://docs.confluent.io/current/schema-registry/docs/api.html
Example ¶
package main
import (
"context"
"fmt"
"log"
"github.com/Zemanta/avro/registry"
)
func main() {
reg, err := registry.NewClient("http://example.com")
if err != nil {
log.Fatal(err)
}
schema, err := reg.GetSchema(context.Background(), 5)
if err != nil {
log.Fatal(err)
}
fmt.Println("schema: ", schema)
schemaRaw := `["null","string","int"]`
id, schema, err := reg.IsRegistered(context.Background(), "foobar", schemaRaw)
if err != nil {
id, schema, err = reg.CreateSchema(context.Background(), "foobar", schemaRaw)
if err != nil {
log.Fatal(err)
}
}
fmt.Println("id: ", id)
fmt.Println("schema: ", schema)
}
Output:
Index ¶
- type Client
- func (c *Client) CreateSchema(ctx context.Context, subject, schema string, references ...SchemaReference) (int, avro.Schema, error)
- func (c *Client) GetLatestSchema(ctx context.Context, subject string) (avro.Schema, error)
- func (c *Client) GetLatestSchemaInfo(ctx context.Context, subject string) (SchemaInfo, error)
- func (c *Client) GetSchema(ctx context.Context, id int) (avro.Schema, error)
- func (c *Client) GetSchemaByVersion(ctx context.Context, subject string, version int) (avro.Schema, error)
- func (c *Client) GetSubjects(ctx context.Context) ([]string, error)
- func (c *Client) GetVersions(ctx context.Context, subject string) ([]int, error)
- func (c *Client) IsRegistered(ctx context.Context, subject, schema string) (int, avro.Schema, error)
- type ClientFunc
- type Error
- type Registry
- type SchemaInfo
- type SchemaReference
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is an HTTP registry client.
func NewClient ¶
func NewClient(baseURL string, opts ...ClientFunc) (*Client, error)
NewClient creates a schema registry Client with the given base url.
func (*Client) CreateSchema ¶
func (c *Client) CreateSchema( ctx context.Context, subject, schema string, references ...SchemaReference, ) (int, avro.Schema, error)
CreateSchema creates a schema in the registry, returning the schema id.
func (*Client) GetLatestSchema ¶
GetLatestSchema gets the latest schema for a subject.
func (*Client) GetLatestSchemaInfo ¶
GetLatestSchemaInfo gets the latest schema and schema metadata for a subject.
func (*Client) GetSchema ¶
GetSchema returns the schema with the given id.
GetSchema will cache the schema in memory after it is successfully returned, allowing it to be used efficiently in a high load situation.
func (*Client) GetSchemaByVersion ¶
func (c *Client) GetSchemaByVersion(ctx context.Context, subject string, version int) (avro.Schema, error)
GetSchemaByVersion gets the schema by version.
func (*Client) GetSubjects ¶
GetSubjects gets the registry subjects.
func (*Client) GetVersions ¶
GetVersions gets the schema versions for a subject.
type ClientFunc ¶
type ClientFunc func(*Client)
ClientFunc is a function used to customize the Client.
func WithBasicAuth ¶
func WithBasicAuth(username, password string) ClientFunc
WithBasicAuth sets the credentials to perform http basic auth.
func WithHTTPClient ¶
func WithHTTPClient(client *http.Client) ClientFunc
WithHTTPClient sets the http client to make requests with.
type Error ¶
type Error struct {
StatusCode int `json:"-"`
Code int `json:"error_code"`
Message string `json:"message"`
}
Error is returned by the registry when there is an error.
type Registry ¶
type Registry interface {
// GetSchema returns the schema with the given id.
GetSchema(ctx context.Context, id int) (avro.Schema, error)
// GetSubjects gets the registry subjects.
GetSubjects(ctx context.Context) ([]string, error)
// GetVersions gets the schema versions for a subject.
GetVersions(ctx context.Context, subject string) ([]int, error)
// GetSchemaByVersion gets the schema by version.
GetSchemaByVersion(ctx context.Context, subject string, version int) (avro.Schema, error)
// GetLatestSchema gets the latest schema for a subject.
GetLatestSchema(ctx context.Context, subject string) (avro.Schema, error)
// GetLatestSchemaInfo gets the latest schema and schema metadata for a subject.
GetLatestSchemaInfo(ctx context.Context, subject string) (SchemaInfo, error)
// CreateSchema creates a schema in the registry, returning the schema id.
CreateSchema(ctx context.Context, subject, schema string, references ...SchemaReference) (int, avro.Schema, error)
// IsRegistered determines of the schema is registered.
IsRegistered(ctx context.Context, subject, schema string) (int, avro.Schema, error)
}
Registry represents a schema registry.
type SchemaInfo ¶
SchemaInfo represents a schema and metadata information.
type SchemaReference ¶
type SchemaReference struct {
Name string `json:"name"`
Subject string `json:"subject"`
Version int `json:"version"`
}
SchemaReference represents a schema reference.
Source Files