README
¶
Confluent Kafka Schema Registry CLI and client
This repository contains a Command Line Interface (CLI) and a Go client for the REST API of Confluent's Kafka Schema Registry.
CLI
To install the CLI, assuming a properly setup Go installation, do:
go get github.com/datamountaineer/schema-registry/schema-registry-cli
After that, the CLI is found in $GOPATH/bin/schema-registry-cli. Running schema-registry-cli without arguments gives:
A command line interface for the Confluent schema registry
Usage:
schema-registry-cli [command]
Available Commands:
add registers the schema provided through stdin
exists checks if the schema provided through stdin exists for the subject
get retrieves a schema specified by id or subject
subjects lists all registered subjects
versions lists all available versions
Flags:
-h, --help help for schema-registry-cli
-e, --url string schema registry url, overrides SCHEMA_REGISTRY_URL (default "http://localhost:8081")
-v, --verbose be verbose
Use "schema-registry-cli [command] --help" for more information about a command.
The schema registry url can be configured through the SCHEMA_REGISTRY_URL environment variable, and overridden through --url. When none is provided, http://localhost:8081 is used as default.
Client
The client package provides a client to deal with the registry from code. It is used by the CLI internally. Usage looks like:
import "github.com/datamountaineer/schema-registry"
client, _ := schemaregistry.NewClient(schemaregistry.DefaultUrl)
client.Subjects()
The documentation of the package can be found here:
Documentation
¶
Overview ¶
Package schemaregistry provides a client for Confluent's Kafka Schema Registry REST API.
Index ¶
- Variables
- type Client
- type MockClient
- func (c *MockClient) GetLatestSchema(subject string) (Schema, error)
- func (c *MockClient) GetSchemaById(id int) (string, error)
- func (c *MockClient) GetSchemaBySubject(subject string, ver int) (Schema, error)
- func (c *MockClient) IsRegistered(subject, schema string) (bool, Schema, error)
- func (c *MockClient) RegisterNewSchema(subject, schema string) (int, error)
- func (c *MockClient) Subjects() (subjects []string, err error)
- func (c *MockClient) Versions(subject string) (versions []int, err error)
- type Schema
Constants ¶
This section is empty.
Variables ¶
var DefaultUrl = "http://localhost:8081"
DefaultUrl is the address where a local schema registry listens by default.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client interface {
Subjects() (subjects []string, err error)
Versions(subject string) (versions []int, err error)
RegisterNewSchema(subject, schema string) (int, error)
IsRegistered(subject, schema string) (bool, Schema, error)
GetSchemaById(id int) (string, error)
GetSchemaBySubject(subject string, ver int) (s Schema, err error)
GetLatestSchema(subject string) (s Schema, err error)
}
A Client is a client for the schema registry.
func NewNOOPClient ¶
func NewNOOPClient() Client
type MockClient ¶
type MockClient struct {
SubjectsFn func() (subjects []string, err error)
VersionsFn func(subject string) (versions []int, err error)
RegisterNewSchemaFn func(subject, schema string) (int, error)
IsRegisteredFn func(subject, schema string) (bool, Schema, error)
GetSchemaByIdFn func(id int) (string, error)
GetSchemaBySubjectFn func(subject string, ver int) (Schema, error)
GetLatestSchemaFn func(subject string) (Schema, error)
}
func (*MockClient) GetLatestSchema ¶
func (c *MockClient) GetLatestSchema(subject string) (Schema, error)
func (*MockClient) GetSchemaById ¶
func (c *MockClient) GetSchemaById(id int) (string, error)
func (*MockClient) GetSchemaBySubject ¶
func (c *MockClient) GetSchemaBySubject(subject string, ver int) (Schema, error)
func (*MockClient) IsRegistered ¶
func (c *MockClient) IsRegistered(subject, schema string) (bool, Schema, error)
func (*MockClient) RegisterNewSchema ¶
func (c *MockClient) RegisterNewSchema(subject, schema string) (int, error)
func (*MockClient) Subjects ¶
func (c *MockClient) Subjects() (subjects []string, err error)
type Schema ¶
type Schema struct {
Schema string `json:"schema"` // The actual AVRO schema
Subject string `json:"subject"` // Subject where the schema is registered for
Version int `json:"version"` // Version within this subject
Id int `json:"id"` // Registry's unique id
}
The Schema type is an object produced by the schema registry.
Source Files
Directories