ikvclient

package
v0.0.13 Latest Latest
Warning

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

 Go to latest Published: Feb 27, 2024 License: MIT Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var BUCKET_NAME string = "ikv-binaries"
View Source 
var REGION string = "us-west-2"

Functions

This section is empty.

Types

type BinaryManager added in v0.0.13 

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

Manages native IKV binaries for dynamic loading.

func NewBinaryManager added in v0.0.13 

func NewBinaryManager(mount_dir string) (*BinaryManager, error)

func (*BinaryManager) GetPathToNativeBinary added in v0.0.13 

func (manager *BinaryManager) GetPathToNativeBinary() (string, error)

type ClientOptions 

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

type ClientOptionsBuilder 

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

func NewClientOptionsBuilder 

func NewClientOptionsBuilder() *ClientOptionsBuilder

Create a new options builder.

func (*ClientOptionsBuilder) Build 

func (builder *ClientOptionsBuilder) Build() (ClientOptions, error)

func (*ClientOptionsBuilder) WithAccountId 

func (builder *ClientOptionsBuilder) WithAccountId(accountId string) *ClientOptionsBuilder

func (*ClientOptionsBuilder) WithAccountPasskey 

func (builder *ClientOptionsBuilder) WithAccountPasskey(accountPasskey string) *ClientOptionsBuilder

func (*ClientOptionsBuilder) WithConsoleLogging 

func (builder *ClientOptionsBuilder) WithConsoleLogging(level string) *ClientOptionsBuilder

func (*ClientOptionsBuilder) WithFileLogging 

func (builder *ClientOptionsBuilder) WithFileLogging(filepath string, level string) *ClientOptionsBuilder

func (*ClientOptionsBuilder) WithKafkaPropertyOverride 

func (builder *ClientOptionsBuilder) WithKafkaPropertyOverride(key string, value string) *ClientOptionsBuilder

Ex. withKafkaPropertyOverride("ssl.ca.location", "/etc/ssl/certs") is required on Ubuntu hosts to declare CA certificates.

func (*ClientOptionsBuilder) WithMountDirectory 

func (builder *ClientOptionsBuilder) WithMountDirectory(dir string) *ClientOptionsBuilder

func (*ClientOptionsBuilder) WithStoreName 

func (builder *ClientOptionsBuilder) WithStoreName(name string) *ClientOptionsBuilder

type DefaultIKVReader 

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

func (*DefaultIKVReader) GetBytesValue 

func (reader *DefaultIKVReader) GetBytesValue(key interface{}, fieldname string) ([]byte, error)

func (*DefaultIKVReader) GetStringValue 

func (reader *DefaultIKVReader) GetStringValue(key interface{}, fieldname string) (string, error)

func (*DefaultIKVReader) HealthCheck added in v0.0.12 

func (reader *DefaultIKVReader) HealthCheck() (bool, error)

func (*DefaultIKVReader) Shutdown 

func (reader *DefaultIKVReader) Shutdown() error

Shutdown. Reader invokes shutdown sequence on the embedded index via cgo.

func (*DefaultIKVReader) Startup 

func (reader *DefaultIKVReader) Startup() error

Startup. Reader fetches and combines server/client configs and opens embedded index via cgo.

type DefaultIKVWriter 

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

func NewDefaultIKVWriter 

func NewDefaultIKVWriter(clientOptions *ClientOptions) (*DefaultIKVWriter, error)

Constructor for creating new instances.

func (*DefaultIKVWriter) HealthCheck added in v0.0.12 

func (writer *DefaultIKVWriter) HealthCheck() (bool, error)

HealthCheck implements IKVWriter.

func (*DefaultIKVWriter) Helloworld 

func (writer *DefaultIKVWriter) Helloworld(input string) (*schemas.HelloWorldResponse, error)

func (*DefaultIKVWriter) Shutdown 

func (writer *DefaultIKVWriter) Shutdown() error

Shutdown. Teardown connection.

func (*DefaultIKVWriter) Startup 

func (writer *DefaultIKVWriter) Startup() error

Startup. Connection initialization.

func (*DefaultIKVWriter) UpsertFields 

func (writer *DefaultIKVWriter) UpsertFields(document *IKVDocument) error

Upsert. Publish a document.

type IKVClientFactory 

type IKVClientFactory struct {
}

func (*IKVClientFactory) CreateNewReader 

func (f *IKVClientFactory) CreateNewReader(clientOptions *ClientOptions) (IKVReader, error)

Create new IKV reader instance.

func (*IKVClientFactory) CreateNewWriter 

func (f *IKVClientFactory) CreateNewWriter(clientOptions *ClientOptions) (IKVWriter, error)

Create new IKV writer instance.

type IKVDocument 

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

Represents an indexable document for IKV (collection of fields associated with a primary key). See IKVDocumentBuilder to build documents.

type IKVDocumentBuilder 

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

func NewIKVDocumentBuilder 

func NewIKVDocumentBuilder() *IKVDocumentBuilder

Constructor for a new document builder.

func (*IKVDocumentBuilder) Build 

func (builder *IKVDocumentBuilder) Build() (IKVDocument, error)

Build this document.

func (*IKVDocumentBuilder) PutBytesField 

func (builder *IKVDocumentBuilder) PutBytesField(fieldname string, value []byte) *IKVDocumentBuilder

Insert a bytes field.

func (*IKVDocumentBuilder) PutStringField 

func (builder *IKVDocumentBuilder) PutStringField(fieldname string, value string) *IKVDocumentBuilder

Insert a string field.

type IKVReader 

type IKVReader interface {
	Startup() error
	Shutdown() error
	GetBytesValue(key interface{}, fieldname string) ([]byte, error)
	GetStringValue(key interface{}, fieldname string) (string, error)
	HealthCheck() (bool, error)
}

See IKVClientFactory to create a new instance.

func NewDefaultIKVReader added in v0.0.12 

func NewDefaultIKVReader(clientOptions *ClientOptions) (IKVReader, error)

type IKVWriter 

type IKVWriter interface {
	Startup() error
	Shutdown() error
	UpsertFields(document *IKVDocument) error
	HealthCheck() (bool, error)
}

See IKVClientFactory to create a new instance.

type NativeReaderV2 added in v0.0.13 

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

func NewNativeReaderV2 added in v0.0.13 

func NewNativeReaderV2(dllPath string) (*NativeReaderV2, error)

func (*NativeReaderV2) Close added in v0.0.13 

func (nr *NativeReaderV2) Close() error

func (*NativeReaderV2) GetFieldValue added in v0.0.13 

func (nr *NativeReaderV2) GetFieldValue(primaryKey []byte, fieldName string) []byte

func (*NativeReaderV2) HealthCheck added in v0.0.13 

func (nr *NativeReaderV2) HealthCheck(input string) (bool, error)

func (*NativeReaderV2) Open added in v0.0.13 

func (nr *NativeReaderV2) Open(config []byte) error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.