bucket_schema

Documentation

Index

• Constants
• type Client
  • func (c Client) Create(ctx context.Context, params CreateParams) error
  • func (c Client) List(ctx context.Context, params ListParams) error
  • func (c Client) Update(ctx context.Context, params UpdateParams) error
• type ColumnsDecoderFn
• type ColumnsFormat
  • func (f ColumnsFormat) DecoderFn(path string) (ColumnsDecoderFn, error)
  • func (f *ColumnsFormat) Set(v string) error
  • func (f ColumnsFormat) String() string
• type CreateParams
• type ListParams
• type UpdateParams

Constants

const (
	IDHdr              = "ID"
	MeasurementNameHdr = "Measurement Name"
	ColumnNameHdr      = "Column Name"
	ColumnTypeHdr      = "Column Type"
	ColumnDataTypeHdr  = "Column Data Type"
	BucketIDHdr        = "Bucket ID"
)

Constants for table column headers

Types

type Client

type Client struct {
	api.BucketsApi
	api.BucketSchemasApi
	clients.CLI
}

func (Client) Create

func (c Client) Create(ctx context.Context, params CreateParams) error

func (Client) List

func (c Client) List(ctx context.Context, params ListParams) error

func (Client) Update

func (c Client) Update(ctx context.Context, params UpdateParams) error

type ColumnsDecoderFn

type ColumnsDecoderFn func(r io.Reader) ([]api.MeasurementSchemaColumn, error)

ColumnsDecoderFn is a function which decodes a slice of api.MeasurementSchemaColumn elements from r.

type ColumnsFormat

type ColumnsFormat int

ColumnsFormat is a type which defines the supported formats

const (
	ColumnsFormatAuto ColumnsFormat = iota
	ColumnsFormatCSV
	ColumnsFormatNDJson
	ColumnsFormatJson
)

func (ColumnsFormat) DecoderFn

func (f ColumnsFormat) DecoderFn(path string) (ColumnsDecoderFn, error)

DecoderFn uses f and path to return a function capable of decoding measurement schema columns from a given io.Reader. If no combination of decoder exists for f and path, DecoderFn returns an error.

func (*ColumnsFormat) Set

func (f *ColumnsFormat) Set(v string) error

func (ColumnsFormat) String

func (f ColumnsFormat) String() string

type CreateParams

type CreateParams struct {
	clients.OrgBucketParams
	Name           string
	Stdin          io.Reader
	ColumnsFile    string
	ColumnsFormat  ColumnsFormat
	ExtendedOutput bool
}

type ListParams

type ListParams struct {
	clients.OrgBucketParams
	Name           string
	ExtendedOutput bool
}

type UpdateParams

type UpdateParams struct {
	clients.OrgBucketParams
	Name           string
	ID             string
	Stdin          io.Reader
	ColumnsFile    string
	ColumnsFormat  ColumnsFormat
	ExtendedOutput bool
}