ccms

package module
v0.0.19 Latest Latest
Warning

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

Go to latest
Published: Feb 16, 2026 License: AGPL-3.0 Imports: 12 Imported by: 0

README

CCMS - Collaborative Collections Management System

Copyright © 2025-2026 Index Data ApS

This software is distributed under the terms of the GNU Affero General Public License version 3. See the file LICENSE for more information.

See the file CHANGELOG.md for release notes.

Documentation: https://d1f3dtrg62pav.cloudfront.net/ccms/doc/current/

Client API: https://pkg.go.dev/github.com/indexdata/ccms

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	Host          string // server host name
	Port          string // server port
	User          string // user name for authentication
	Password      string // user password
	NoTLS         bool   // disable TLS (insecure)
	TLSSkipVerify bool   // do not verify server certificate chain and host name (insecure)
}

client that connects to a CCMS server

func (*Client) Send

func (c *Client) Send(cmd string) (*Response, error)

send one or more commands to the server and return the response

type DataRow

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

a row of data

func (*DataRow) Values

func (d *DataRow) Values() []any

return the data values

type FieldDescription

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

metadata for an attribute

func (*FieldDescription) DataType added in v0.0.18

func (f *FieldDescription) DataType() string

return the field data type

func (*FieldDescription) Name

func (f *FieldDescription) Name() string

return the field name

type Response

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

response from CCMS server

func NewResponse added in v0.0.18

func NewResponse() *Response

return an initialized response

func (*Response) AddResult added in v0.0.18

func (r *Response) AddResult(result *Result)

add a result to the response

func (*Response) Encode added in v0.0.18

func (r *Response) Encode(w http.ResponseWriter) error

encode the reponse as JSON

func (*Response) Results added in v0.0.17

func (r *Response) Results() iter.Seq[Result]

return an iterator over results contained in the response

type Result added in v0.0.17

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

result of a command

func NewResult added in v0.0.18

func NewResult(status string) *Result

return an initialized result

func (*Result) AddData added in v0.0.18

func (r *Result) AddData(values []any)

add a data row to this result

func (*Result) AddField added in v0.0.18

func (r *Result) AddField(name, dataType string)

add metadata for a field to this result

func (*Result) AddMessage added in v0.0.18

func (r *Result) AddMessage(message string)

add a message to this result

func (*Result) Data added in v0.0.17

func (r *Result) Data() iter.Seq[DataRow]

return an iterator over data rows contained in the result

func (*Result) Fields added in v0.0.17

func (r *Result) Fields() []FieldDescription

return the field metadata in this result

func (*Result) Message added in v0.0.17

func (r *Result) Message() string

return the result message

func (*Result) Status added in v0.0.17

func (r *Result) Status() string

return the result status

Directories

Path Synopsis
cmd
ccc command
ccd command
ccd/parser
Code generated by goyacc -l -o gram.go gram.y.
Code generated by goyacc -l -o gram.go gram.y.
internal

Jump to

Keyboard shortcuts

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