Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

shdb

package module

Go to main page

Versions in this module

v1

v1.0.2

Apr 21, 2023

Changes in this version

+ var E_ShdbAliases = &file_pb_shdb_v1_shdb_proto_extTypes[2]

+ var E_ShdbOptions = &file_pb_shdb_v1_shdb_proto_extTypes[0]

+ var E_ShdbType = &file_pb_shdb_v1_shdb_proto_extTypes[1]

+ var E_ShdbTypeKey = &file_pb_shdb_v1_shdb_proto_extTypes[3]

+ var ErrDatabaseCorrupt = errors.New("database corrupt")

+ var File_pb_shdb_v1_shdb_proto protoreflect.FileDescriptor

+ var File_pb_shdb_v1_test_proto protoreflect.FileDescriptor

+ var ObjectService_ServiceDesc = grpc.ServiceDesc

+ var TypeKeyAll = TypeKey

+ func DeleteAll(tk TypeKey) error

+ func LoadSchema() (*descriptorpb.FileDescriptorSet, error)

+ func RegisterObjectServiceServer(s grpc.ServiceRegistrar, srv ObjectServiceServer)

+ func StoreSchema(files protoregistry.Files) error

+ type Client struct

+ func NewClient(ctx context.Context, cc *grpc.ClientConn) *Client

+ func (c *Client) Create(typ TypeKey) (IObject, error)

+ func (c *Client) Delete(tid TypeId) (IObject, error)

+ func (c *Client) Get(tid TypeId) (IObject, error)

+ func (c *Client) GetTypeNames() (map[string][]string, error)

+ func (c *Client) List(tk TypeKey) ([]IObject, error)

+ func (c *Client) SearchRef(tk TypeKey, selector func(obj *ObjRef) bool) (chan *ObjRef, error)

+ func (c *Client) TypeRegistry() *TypeRegistry

+ func (c *Client) Update(obj IObject) (IObject, error)

+ type CreateReq struct

+ Type []byte

+ func (*CreateReq) Descriptor() ([]byte, []int)

+ func (*CreateReq) ProtoMessage()

+ func (x *CreateReq) GetType() []byte

+ func (x *CreateReq) ProtoReflect() protoreflect.Message

+ func (x *CreateReq) Reset()

+ func (x *CreateReq) String() string

+ type DeleteReq struct

+ Ref *ObjRef

+ func (*DeleteReq) Descriptor() ([]byte, []int)

+ func (*DeleteReq) ProtoMessage()

+ func (x *DeleteReq) GetRef() *ObjRef

+ func (x *DeleteReq) ProtoReflect() protoreflect.Message

+ func (x *DeleteReq) Reset()

+ func (x *DeleteReq) String() string

+ type DynObject struct

+ func (o *DynObject) GetMetadata() *Metadata

+ type GetReq struct

+ Ref *ObjRef

+ func (*GetReq) Descriptor() ([]byte, []int)

+ func (*GetReq) ProtoMessage()

+ func (x *GetReq) GetRef() *ObjRef

+ func (x *GetReq) ProtoReflect() protoreflect.Message

+ func (x *GetReq) Reset()

+ func (x *GetReq) String() string

+ type GetTypeNamesRsp struct

+ TypeAliases []*GetTypeNamesRsp_TypeAliases

+ func (*GetTypeNamesRsp) Descriptor() ([]byte, []int)

+ func (*GetTypeNamesRsp) ProtoMessage()

+ func (x *GetTypeNamesRsp) GetTypeAliases() []*GetTypeNamesRsp_TypeAliases

+ func (x *GetTypeNamesRsp) ProtoReflect() protoreflect.Message

+ func (x *GetTypeNamesRsp) Reset()

+ func (x *GetTypeNamesRsp) String() string

+ type GetTypeNamesRsp_TypeAliases struct

+ Aliases []string

+ Fullname string

+ func (*GetTypeNamesRsp_TypeAliases) Descriptor() ([]byte, []int)

+ func (*GetTypeNamesRsp_TypeAliases) ProtoMessage()

+ func (x *GetTypeNamesRsp_TypeAliases) GetAliases() []string

+ func (x *GetTypeNamesRsp_TypeAliases) GetFullname() string

+ func (x *GetTypeNamesRsp_TypeAliases) ProtoReflect() protoreflect.Message

+ func (x *GetTypeNamesRsp_TypeAliases) Reset()

+ func (x *GetTypeNamesRsp_TypeAliases) String() string

+ type ListReq struct

+ PageSize int32

+ PageToken string

+ Type []byte

+ func (*ListReq) Descriptor() ([]byte, []int)

+ func (*ListReq) ProtoMessage()

+ func (x *ListReq) GetPageSize() int32

+ func (x *ListReq) GetPageToken() string

+ func (x *ListReq) GetType() []byte

+ func (x *ListReq) ProtoReflect() protoreflect.Message

+ func (x *ListReq) Reset()

+ func (x *ListReq) String() string

+ type ListRsp struct

+ NextPageToken string

+ Objects []*Object

+ func (*ListRsp) Descriptor() ([]byte, []int)

+ func (*ListRsp) ProtoMessage()

+ func (x *ListRsp) GetNextPageToken() string

+ func (x *ListRsp) GetObjects() []*Object

+ func (x *ListRsp) ProtoReflect() protoreflect.Message

+ func (x *ListRsp) Reset()

+ func (x *ListRsp) String() string

+ type MessageInfo struct

+ Aliases []string

+ Fullname string

+ IsDynamic bool

+ MessageType protoreflect.MessageType

+ PrintTemplates map[string]string

+ TypeKey TypeKey

type ObjRef

+ func MustParseObjRef(typeKey TypeKey, id interface{}) *ObjRef

+ func ObjRefFromUUID(typeKey TypeKey, id string) (*ObjRef, error)

+ func ParseObjRef(typeKey TypeKey, id interface{}) (*ObjRef, error)

+ func SearchRef(ctx context.Context, selector func(*ObjRef) bool, pageSize int32, ...) (result []*ObjRef, nextPageToken string, err error)

+ func (r *ObjRef) Equal(other *ObjRef) bool

+ func (r *ObjRef) UUID() uuid.UUID

+ type Object struct

+ Key []byte

+ Value []byte

+ func (*Object) Descriptor() ([]byte, []int)

+ func (*Object) ProtoMessage()

+ func (x *Object) GetKey() []byte

+ func (x *Object) GetValue() []byte

+ func (x *Object) ProtoReflect() protoreflect.Message

+ func (x *Object) Reset()

+ func (x *Object) String() string

+ type ObjectServiceClient interface

+ Create func(ctx context.Context, in *CreateReq, opts ...grpc.CallOption) (*Object, error)

+ Delete func(ctx context.Context, in *DeleteReq, opts ...grpc.CallOption) (*Object, error)

+ Get func(ctx context.Context, in *GetReq, opts ...grpc.CallOption) (*Object, error)

+ GetSchema func(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*descriptorpb.FileDescriptorSet, error)

+ GetTypeNames func(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*GetTypeNamesRsp, error)

+ List func(ctx context.Context, in *ListReq, opts ...grpc.CallOption) (*ListRsp, error)

+ StreamRefs func(ctx context.Context, in *StreamRefReq, opts ...grpc.CallOption) (ObjectService_StreamRefsClient, error)

+ Update func(ctx context.Context, in *UpdateReq, opts ...grpc.CallOption) (*Object, error)

+ func NewObjectServiceClient(cc grpc.ClientConnInterface) ObjectServiceClient

+ type ObjectServiceServer interface

+ Create func(context.Context, *CreateReq) (*Object, error)

+ Delete func(context.Context, *DeleteReq) (*Object, error)

+ Get func(context.Context, *GetReq) (*Object, error)

+ GetSchema func(context.Context, *emptypb.Empty) (*descriptorpb.FileDescriptorSet, error)

+ GetTypeNames func(context.Context, *emptypb.Empty) (*GetTypeNamesRsp, error)

+ List func(context.Context, *ListReq) (*ListRsp, error)

+ StreamRefs func(*StreamRefReq, ObjectService_StreamRefsServer) error

+ Update func(context.Context, *UpdateReq) (*Object, error)

+ type ObjectService_StreamRefsClient interface

+ Recv func() (*ObjRef, error)

+ type ObjectService_StreamRefsServer interface

+ Send func(*ObjRef) error

+ type Server struct

+ func NewServer(ctx context.Context, grpcServer *grpc.Server, typeReg *TypeRegistry) *Server

+ func (s *Server) Create(ctx context.Context, req *CreateReq) (*Object, error)

+ func (s *Server) Delete(ctx context.Context, req *DeleteReq) (*Object, error)

+ func (s *Server) Get(ctx context.Context, req *GetReq) (*Object, error)

+ func (s *Server) GetSchema(ctx context.Context, req *emptypb.Empty) (*descriptorpb.FileDescriptorSet, error)

+ func (s *Server) GetTypeNames(ctx context.Context, req *emptypb.Empty) (*GetTypeNamesRsp, error)

+ func (s *Server) List(ctx context.Context, req *ListReq) (*ListRsp, error)

+ func (s *Server) StreamRefs(req *StreamRefReq, stream ObjectService_StreamRefsServer) error

+ func (s *Server) Update(ctx context.Context, req *UpdateReq) (*Object, error)

+ type Shdb_Message_Options struct

+ Aliases []string

+ PrintTemplates map[string]string

+ Type string

+ TypeKey []byte

+ func (*Shdb_Message_Options) Descriptor() ([]byte, []int)

+ func (*Shdb_Message_Options) ProtoMessage()

+ func (x *Shdb_Message_Options) GetAliases() []string

+ func (x *Shdb_Message_Options) GetPrintTemplates() map[string]string

+ func (x *Shdb_Message_Options) GetType() string

+ func (x *Shdb_Message_Options) GetTypeKey() []byte

+ func (x *Shdb_Message_Options) ProtoReflect() protoreflect.Message

+ func (x *Shdb_Message_Options) Reset()

+ func (x *Shdb_Message_Options) String() string

+ type StreamRefReq struct

+ TypeKey []byte

+ func (*StreamRefReq) Descriptor() ([]byte, []int)

+ func (*StreamRefReq) ProtoMessage()

+ func (x *StreamRefReq) GetTypeKey() []byte

+ func (x *StreamRefReq) ProtoReflect() protoreflect.Message

+ func (x *StreamRefReq) Reset()

+ func (x *StreamRefReq) String() string

type TObject

+ Any *anypb.Any

+ MyString string

+ Timestamp *timestamppb.Timestamp

+ func (x *TObject) GetAny() *anypb.Any

+ func (x *TObject) GetMyString() string

+ func (x *TObject) GetTimestamp() *timestamppb.Timestamp

type TypeId

+ func MustParseTypeId(typeKey TypeKey, id interface{}) TypeId

+ func ParseTypeId(typeKey TypeKey, id interface{}) (tid TypeId, err error)

type TypeKey

+ func TypeKeyOf(fullname string) TypeKey

+ type TypeRegistry struct

+ func NewTypeRegistry() *TypeRegistry

+ func (r *TypeRegistry) AddFile(fd protoreflect.FileDescriptor) error

+ func (r *TypeRegistry) AddFileFromProtoFileDescriptor(fd *descriptorpb.FileDescriptorProto) error

+ func (r *TypeRegistry) CreateEmptyObject(tk TypeKey) (IObject, error)

+ func (r *TypeRegistry) CreateObject(spec interface{}) (IObject, error)

+ func (r *TypeRegistry) GetFileDescriptorSet() *descriptorpb.FileDescriptorSet

+ func (r *TypeRegistry) GetMessageInfo(tk TypeKey) (MessageInfo, error)

+ func (r *TypeRegistry) GetTypeKeyFromToA(toa string) (TypeKey, error)

+ func (r *TypeRegistry) GetTypeNames() map[string][]string

+ func (r *TypeRegistry) LoadSchema() (err error)

+ func (r *TypeRegistry) StoreSchema() error

+ func (r *TypeRegistry) Unmarshal(key []byte, value []byte) (IObject, error)

+ func (r *TypeRegistry) UseFileDescriptorSet(fds *descriptorpb.FileDescriptorSet) (err error)

+ type UnimplementedObjectServiceServer struct

+ func (UnimplementedObjectServiceServer) Create(context.Context, *CreateReq) (*Object, error)

+ func (UnimplementedObjectServiceServer) Delete(context.Context, *DeleteReq) (*Object, error)

+ func (UnimplementedObjectServiceServer) Get(context.Context, *GetReq) (*Object, error)

+ func (UnimplementedObjectServiceServer) GetSchema(context.Context, *emptypb.Empty) (*descriptorpb.FileDescriptorSet, error)

+ func (UnimplementedObjectServiceServer) GetTypeNames(context.Context, *emptypb.Empty) (*GetTypeNamesRsp, error)

+ func (UnimplementedObjectServiceServer) List(context.Context, *ListReq) (*ListRsp, error)

+ func (UnimplementedObjectServiceServer) StreamRefs(*StreamRefReq, ObjectService_StreamRefsServer) error

+ func (UnimplementedObjectServiceServer) Update(context.Context, *UpdateReq) (*Object, error)

+ type UnsafeObjectServiceServer interface

+ type UpdateReq struct

+ Object *Object

+ func (*UpdateReq) Descriptor() ([]byte, []int)

+ func (*UpdateReq) ProtoMessage()

+ func (x *UpdateReq) GetObject() *Object

+ func (x *UpdateReq) ProtoReflect() protoreflect.Message

+ func (x *UpdateReq) Reset()

+ func (x *UpdateReq) String() string

v1.0.1

Mar 22, 2023

Changes in this version

+ func GetRef(ref *ObjRef) (T, error)

type Metadata

+ func (m *Metadata) Fill() error

+ func (m *Metadata) GetUuidAsString() (string, error)

+ func (m *Metadata) GetUuidAsUUID() (uuid.UUID, error)

+ func (m *Metadata) Ref() *ObjRef

+ type ObjRef struct

+ Type []byte

+ Uuid []byte

+ func UnmarshalObjRef(data []byte) (*ObjRef, error)

+ func (*ObjRef) Descriptor() ([]byte, []int)

+ func (*ObjRef) ProtoMessage()

+ func (r *ObjRef) Marshal() []byte

+ func (r *ObjRef) TypeId() *TypeId

+ func (x *ObjRef) GetType() []byte

+ func (x *ObjRef) GetUuid() []byte

+ func (x *ObjRef) ProtoReflect() protoreflect.Message

+ func (x *ObjRef) Reset()

+ func (x *ObjRef) String() string

v1.0.0

Mar 20, 2023

Changes in this version

+ const EventCreated

+ const EventDeleted

+ const EventUpdated

+ const InvalidWatchEvent

+ var ErrContextCancelled = errors.New("context cancelled")

+ var ErrInvalidType = errors.New("invalid type")

+ var ErrNotAnObject = errors.New("not an object type")

+ var ErrNotFound = errors.New("not found")

+ var ErrSessionInvalid = errors.New("session invalid")

+ var File_shdb_proto protoreflect.FileDescriptor

+ func Close() error

+ func Create(typeKey TypeKey) (T, error)

+ func Delete(tid TypeId) (T, error)

+ func Get(tid TypeId) (T, error)

+ func GetAll(typeKey TypeKey) ([]T, error)

+ func GetFirst(typeKey TypeKey, selector func(obj T) bool) (T, error)

+ func Init(dbFile string)

+ func List(ctx context.Context, typ TypeKey, pageSize int32, pageToken string) (result []T, nextPageToken string, err error)

+ func MustNew(typeKey TypeKey) T

+ func New(typeKey TypeKey) (obj T, err error)

+ func Put(val ...T) error

+ func Query(ctx context.Context, typ TypeKey, selectFn func(obj T) (bool, error), ...) (result []T, nextPageToken string, err error)

+ func Register(tmpl T)

+ func RemoveWatcher(watcherId string) error

+ func SearchProto(m proto.Message, query func(s string) bool) (hits []string, err error)

+ func Unmarshal(kv KeyVal) (T, error)

+ func UnmarshalMany(kvs []KeyVal) ([]T, error)

+ func UnwatchType(watcherId string, typeKeys ...TypeKey) error

+ func UnwatchTypeId(watcherId string, tids ...TypeId) error

+ func Update(tid TypeId, updater func(obj T) (T, error)) (t T, err error)

+ func WatchType(watcherId string, eventCh chan *EventInfo, typeKeys ...TypeKey) (string, error)

+ func WatchTypeId(watcherId string, eventCh chan *EventInfo, tids ...TypeId) (string, error)

+ type EventInfo struct

+ Kind int

+ Object IObject

+ Previous IObject

+ Tid TypeId

+ type IObject interface

+ GetMetadata func() *Metadata

+ type KeyVal struct

+ Value []byte

+ func GetAllKV(typeKey TypeKey) ([]KeyVal, error)

+ func Marshal(objs ...T) (ret []KeyVal, err error)

+ type Metadata struct

+ CreatedAt *timestamppb.Timestamp

+ Description string

+ Labels []string

+ Type []byte

+ UpdatedAt *timestamppb.Timestamp

+ Uuid []byte

+ func (*Metadata) Descriptor() ([]byte, []int)

+ func (*Metadata) ProtoMessage()

+ func (m *Metadata) TypeId() TypeId

+ func (x *Metadata) GetCreatedAt() *timestamppb.Timestamp

+ func (x *Metadata) GetDescription() string

+ func (x *Metadata) GetLabels() []string

+ func (x *Metadata) GetType() []byte

+ func (x *Metadata) GetUpdatedAt() *timestamppb.Timestamp

+ func (x *Metadata) GetUuid() []byte

+ func (x *Metadata) ProtoReflect() protoreflect.Message

+ func (x *Metadata) Reset()

+ func (x *Metadata) String() string

+ type SearchHit struct

+ Hits []string

+ Metadata *Metadata

+ func (*SearchHit) Descriptor() ([]byte, []int)

+ func (*SearchHit) ProtoMessage()

+ func (x *SearchHit) GetHits() []string

+ func (x *SearchHit) GetMetadata() *Metadata

+ func (x *SearchHit) ProtoReflect() protoreflect.Message

+ func (x *SearchHit) Reset()

+ func (x *SearchHit) String() string

+ type SearchResult struct

+ Hits []*SearchHit

+ func Search(ctx context.Context, typ TypeKey, selector func(string) bool, pageSize int32, ...) (result *SearchResult, nextPageToken string, err error)

+ func (*SearchResult) Descriptor() ([]byte, []int)

+ func (*SearchResult) ProtoMessage()

+ func (x *SearchResult) GetHits() []*SearchHit

+ func (x *SearchResult) ProtoReflect() protoreflect.Message

+ func (x *SearchResult) Reset()

+ func (x *SearchResult) String() string

+ type TObject struct

+ Metadata *Metadata

+ MyField string

+ MyInt uint64

+ func (*TObject) Descriptor() ([]byte, []int)

+ func (*TObject) ProtoMessage()

+ func (x *TObject) GetMetadata() *Metadata

+ func (x *TObject) GetMyField() string

+ func (x *TObject) GetMyInt() uint64

+ func (x *TObject) ProtoReflect() protoreflect.Message

+ func (x *TObject) Reset()

+ func (x *TObject) String() string

+ type TypeId struct

+ func GetTypeId(obj IObject) *TypeId

+ func MarshalTypeId(key []byte) *TypeId

+ func NewTypeId(typeKey TypeKey, id []byte) *TypeId

+ func TypeIdFromString(str string) (*TypeId, error)

+ func (k *TypeId) Equal(other *TypeId) bool

+ func (k *TypeId) Key() []byte

+ func (k *TypeId) SetType(keyType TypeKey)

+ func (k *TypeId) SetUuid(id uuid.UUID)

+ func (k *TypeId) SetUuidBytes(id []byte)

+ func (k *TypeId) String() string

+ func (k TypeId) TypeKey() TypeKey

+ func (k TypeId) Uuid() uuid.UUID

+ func (k TypeId) UuidBytes() []byte

+ type TypeKey = [4]byte