goavro

README

goavro

Documentation

Index

• Constants
• func Union(name string, datum interface{}) interface{}
• type BinaryCoder
• type BinaryDecoder
• type BinaryEncoder
• type Codec
  • func NewCodec(schemaSpecification string) (*Codec, error)
  • func (c Codec) BinaryDecode(buf []byte) (interface{}, []byte, error)
  • func (c Codec) BinaryEncode(buf []byte, datum interface{}) ([]byte, error)
• type Compression
• type ErrInvalidName
  • func (e ErrInvalidName) Error() string
• type OCFReader
  • func NewOCFReader(ior io.Reader) (*OCFReader, error)
  • func (ocfr *OCFReader) Err() error
  • func (ocfr *OCFReader) Read() (interface{}, error)
  • func (ocfr *OCFReader) Scan() bool
  • func (ocfr *OCFReader) Schema() string
• type OCFWriter
  • func NewOCFWriter(config OCFWriterConfig) (*OCFWriter, error)
  • func (ocf *OCFWriter) Append(data []interface{}) error
• type OCFWriterConfig

Constants

const (
	CompressionNullLabel    = "null"
	CompressionDeflateLabel = "deflate"
	CompressionSnappyLabel  = "snappy"
)

Functions

func Union

func Union(name string, datum interface{}) interface{}

Union wraps a datum value in a map for encoding as a Union, as required by Union encoder.

Types

type BinaryCoder

type BinaryCoder interface {
	BinaryDecoder
	BinaryEncoder
}

BinaryCoder interface describes types that expose both the Decode and the Encode methods.

type BinaryDecoder

type BinaryDecoder interface {
	BinaryDecode([]byte) (interface{}, []byte, error)
}

BinaryDecoder interface describes types that expose the Decode method.

type BinaryEncoder

type BinaryEncoder interface {
	BinaryEncode([]byte, interface{}) ([]byte, error)
}

BinaryEncoder interface describes types that expose the Encode method.

type Codec

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

Codec stores function pointers for encoding and decoding Avro blobs according to their defined specification. Their state is created during initialization, but then never modified, so the same Codec may be safely used in multiple go routines to encode and or decode different Avro streams concurrently.

func NewCodec

func NewCodec(schemaSpecification string) (*Codec, error)

NewCodec returns a Codec that can encode and decode the specified Avro schema.

func (Codec) BinaryDecode

func (c Codec) BinaryDecode(buf []byte) (interface{}, []byte, error)

BinaryDecode decodes the provided byte slice in accordance with the Codec's Avro schema. On success, it returns the decoded value, along with a new byte slice with the decoded bytes consumed. In other words, when decoding an Avro int that happens to take 3 bytes, the returned byte slice will be like the original byte slice, but with the first three bytes removed. On error, it returns the original byte slice without any bytes consumed and the error.

func (Codec) BinaryEncode

func (c Codec) BinaryEncode(buf []byte, datum interface{}) ([]byte, error)

BinaryEncode encodes the provided datum value in accordance with the Codec's Avro schema. It takes a byte slice to which to append the encoded bytes. On success, it returns the new byte slice with the appended byte slice. On error, it returns the original byte slice without any encoded bytes.

type Compression

type Compression uint8

Compression are values used to specify compression algorithm used to compress and decompress Avro Object Container File (OCF) streams.

const (
	CompressionNull    Compression = iota // CompressionNull is used when OCF blocks are not compressed.
	CompressionDeflate                    // CompressionDeflate is used when OCF blocks are compressed using the deflate algorithm.
	CompressionSnappy                     // CompressionSnappy is used when OCF blocks are compressed using the snappy algorithm.
)

type ErrInvalidName

type ErrInvalidName struct {
	Message string
}

ErrInvalidName is the error returned when one or more parts of an Avro name is invalid.

func (ErrInvalidName) Error

func (e ErrInvalidName) Error() string

type OCFReader

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

OCFReader structure is used to read Object Container Files (OCF).

func NewOCFReader

func NewOCFReader(ior io.Reader) (*OCFReader, error)

NewOCFReader initializes and returns a new structure used to read an Avro Object Container File (OCF).

func (*OCFReader) Err

func (ocfr *OCFReader) Err() error

Err returns the last error encountered while reading the OCF file. It does not reset the read error.

func (*OCFReader) Read

func (ocfr *OCFReader) Read() (interface{}, error)

Read consumes one data item from the Avro OCF stream and returns it.

func (*OCFReader) Scan

func (ocfr *OCFReader) Scan() bool

Scan returns true when there is at least one more data item to be read from the Avro OCF.

func (*OCFReader) Schema

func (ocfr *OCFReader) Schema() string

type OCFWriter

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

OCFWriter is used to create an Avro Object Container File (OCF).

func NewOCFWriter

func NewOCFWriter(config OCFWriterConfig) (*OCFWriter, error)

NewOCFWriter returns a newly created OCFWriter which may be used to create an Avro Object Container File (OCF).

func (*OCFWriter) Append

func (ocf *OCFWriter) Append(data []interface{}) error

type OCFWriterConfig

type OCFWriterConfig struct {
	W           io.Writer   // W specifies the io.Writer to send the encode the data, (required).
	Schema      string      // Schema specifies the Avro schema for the data to be encoded, (required).
	Compression Compression // Codec specifies the compression codec used, (optional). If omitted, defaults to "null" codec.
}

OCFWriterConfig is used to specify creation parameters for OCFWriter.