kvs

package
v7.2.1 Latest Latest
Warning

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

 Go to latest Published: Apr 10, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	KVS_Read_FullMethodName                  = "/KVS/Read"
	KVS_ReadStreaming_FullMethodName         = "/KVS/ReadStreaming"
	KVS_GetHeader_FullMethodName             = "/KVS/GetHeader"
	KVS_GetHeaderStreaming_FullMethodName    = "/KVS/GetHeaderStreaming"
	KVS_Exists_FullMethodName                = "/KVS/Exists"
	KVS_ExistsStreaming_FullMethodName       = "/KVS/ExistsStreaming"
	KVS_Write_FullMethodName                 = "/KVS/Write"
	KVS_WriteStreaming_FullMethodName        = "/KVS/WriteStreaming"
	KVS_Delete_FullMethodName                = "/KVS/Delete"
	KVS_DeleteStreaming_FullMethodName       = "/KVS/DeleteStreaming"
	KVS_Touch_FullMethodName                 = "/KVS/Touch"
	KVS_TouchStreaming_FullMethodName        = "/KVS/TouchStreaming"
	KVS_Operate_FullMethodName               = "/KVS/Operate"
	KVS_OperateStreaming_FullMethodName      = "/KVS/OperateStreaming"
	KVS_Execute_FullMethodName               = "/KVS/Execute"
	KVS_ExecuteStreaming_FullMethodName      = "/KVS/ExecuteStreaming"
	KVS_BatchOperate_FullMethodName          = "/KVS/BatchOperate"
	KVS_BatchOperateStreaming_FullMethodName = "/KVS/BatchOperateStreaming"
)
View Source 
const (
	Scan_Scan_FullMethodName          = "/Scan/Scan"
	Scan_ScanStreaming_FullMethodName = "/Scan/ScanStreaming"
)
View Source 
const (
	Query_Query_FullMethodName                         = "/Query/Query"
	Query_QueryStreaming_FullMethodName                = "/Query/QueryStreaming"
	Query_BackgroundExecute_FullMethodName             = "/Query/BackgroundExecute"
	Query_BackgroundExecuteStreaming_FullMethodName    = "/Query/BackgroundExecuteStreaming"
	Query_BackgroundTaskStatus_FullMethodName          = "/Query/BackgroundTaskStatus"
	Query_BackgroundTaskStatusStreaming_FullMethodName = "/Query/BackgroundTaskStatusStreaming"
)
View Source 
const (
	About_Get_FullMethodName = "/About/Get"
)

Variables

View Source 
var (
	ReadModeAP_name = map[int32]string{
		0: "ONE",
		1: "ALL",
	}
	ReadModeAP_value = map[string]int32{
		"ONE": 0,
		"ALL": 1,
	}
)

Enum value maps for ReadModeAP.

View Source 
var (
	ReadModeSC_name = map[int32]string{
		0: "SESSION",
		1: "LINEARIZE",
		2: "ALLOW_REPLICA",
		3: "ALLOW_UNAVAILABLE",
	}
	ReadModeSC_value = map[string]int32{
		"SESSION":           0,
		"LINEARIZE":         1,
		"ALLOW_REPLICA":     2,
		"ALLOW_UNAVAILABLE": 3,
	}
)

Enum value maps for ReadModeSC.

View Source 
var (
	Replica_name = map[int32]string{
		0: "SEQUENCE",
		1: "MASTER",
		2: "MASTER_PROLES",
		3: "PREFER_RACK",
		4: "RANDOM",
	}
	Replica_value = map[string]int32{
		"SEQUENCE":      0,
		"MASTER":        1,
		"MASTER_PROLES": 2,
		"PREFER_RACK":   3,
		"RANDOM":        4,
	}
)

Enum value maps for Replica.

View Source 
var (
	IndexCollectionType_name = map[int32]string{
		0: "DEFAULT",
		1: "LIST",
		2: "MAPKEYS",
		3: "MAPVALUES",
	}
	IndexCollectionType_value = map[string]int32{
		"DEFAULT":   0,
		"LIST":      1,
		"MAPKEYS":   2,
		"MAPVALUES": 3,
	}
)

Enum value maps for IndexCollectionType.

View Source 
var (
	OperationType_name = map[int32]string{
		0:  "READ",
		1:  "READ_HEADER",
		2:  "WRITE",
		3:  "CDT_READ",
		4:  "CDT_MODIFY",
		5:  "MAP_READ",
		6:  "MAP_MODIFY",
		7:  "ADD",
		8:  "EXP_READ",
		9:  "EXP_MODIFY",
		10: "APPEND",
		11: "PREPEND",
		12: "TOUCH",
		13: "BIT_READ",
		14: "BIT_MODIFY",
		15: "DELETE",
		16: "HLL_READ",
		17: "HLL_MODIFY",
	}
	OperationType_value = map[string]int32{
		"READ":        0,
		"READ_HEADER": 1,
		"WRITE":       2,
		"CDT_READ":    3,
		"CDT_MODIFY":  4,
		"MAP_READ":    5,
		"MAP_MODIFY":  6,
		"ADD":         7,
		"EXP_READ":    8,
		"EXP_MODIFY":  9,
		"APPEND":      10,
		"PREPEND":     11,
		"TOUCH":       12,
		"BIT_READ":    13,
		"BIT_MODIFY":  14,
		"DELETE":      15,
		"HLL_READ":    16,
		"HLL_MODIFY":  17,
	}
)

Enum value maps for OperationType.

View Source 
var (
	RecordExistsAction_name = map[int32]string{
		0: "UPDATE",
		1: "UPDATE_ONLY",
		2: "REPLACE",
		3: "REPLACE_ONLY",
		4: "CREATE_ONLY",
	}
	RecordExistsAction_value = map[string]int32{
		"UPDATE":       0,
		"UPDATE_ONLY":  1,
		"REPLACE":      2,
		"REPLACE_ONLY": 3,
		"CREATE_ONLY":  4,
	}
)

Enum value maps for RecordExistsAction.

View Source 
var (
	GenerationPolicy_name = map[int32]string{
		0: "NONE",
		1: "EXPECT_GEN_EQUAL",
		2: "EXPECT_GEN_GT",
	}
	GenerationPolicy_value = map[string]int32{
		"NONE":             0,
		"EXPECT_GEN_EQUAL": 1,
		"EXPECT_GEN_GT":    2,
	}
)

Enum value maps for GenerationPolicy.

View Source 
var (
	CommitLevel_name = map[int32]string{
		0: "COMMIT_ALL",
		1: "COMMIT_MASTER",
	}
	CommitLevel_value = map[string]int32{
		"COMMIT_ALL":    0,
		"COMMIT_MASTER": 1,
	}
)

Enum value maps for CommitLevel.

View Source 
var (
	BackgroundTaskStatus_name = map[int32]string{
		0: "NOT_FOUND",
		1: "IN_PROGRESS",
		2: "COMPLETE",
	}
	BackgroundTaskStatus_value = map[string]int32{
		"NOT_FOUND":   0,
		"IN_PROGRESS": 1,
		"COMPLETE":    2,
	}
)

Enum value maps for BackgroundTaskStatus.

View Source 
var About_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "About",
	HandlerType: (*AboutServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Get",
			Handler:    _About_Get_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/kvs/aerospike_proxy_kv.proto",
}

About_ServiceDesc is the grpc.ServiceDesc for About service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_aerospike_proxy_kv_proto protoreflect.FileDescriptor
View Source 
var KVS_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "KVS",
	HandlerType: (*KVSServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Read",
			Handler:    _KVS_Read_Handler,
		},
		{
			MethodName: "GetHeader",
			Handler:    _KVS_GetHeader_Handler,
		},
		{
			MethodName: "Exists",
			Handler:    _KVS_Exists_Handler,
		},
		{
			MethodName: "Write",
			Handler:    _KVS_Write_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _KVS_Delete_Handler,
		},
		{
			MethodName: "Touch",
			Handler:    _KVS_Touch_Handler,
		},
		{
			MethodName: "Operate",
			Handler:    _KVS_Operate_Handler,
		},
		{
			MethodName: "Execute",
			Handler:    _KVS_Execute_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ReadStreaming",
			Handler:       _KVS_ReadStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "GetHeaderStreaming",
			Handler:       _KVS_GetHeaderStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "ExistsStreaming",
			Handler:       _KVS_ExistsStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "WriteStreaming",
			Handler:       _KVS_WriteStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "DeleteStreaming",
			Handler:       _KVS_DeleteStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "TouchStreaming",
			Handler:       _KVS_TouchStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "OperateStreaming",
			Handler:       _KVS_OperateStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "ExecuteStreaming",
			Handler:       _KVS_ExecuteStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "BatchOperate",
			Handler:       _KVS_BatchOperate_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "BatchOperateStreaming",
			Handler:       _KVS_BatchOperateStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "proto/kvs/aerospike_proxy_kv.proto",
}

KVS_ServiceDesc is the grpc.ServiceDesc for KVS service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var Query_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Query",
	HandlerType: (*QueryServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Query",
			Handler:       _Query_Query_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "QueryStreaming",
			Handler:       _Query_QueryStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "BackgroundExecute",
			Handler:       _Query_BackgroundExecute_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "BackgroundExecuteStreaming",
			Handler:       _Query_BackgroundExecuteStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "BackgroundTaskStatus",
			Handler:       _Query_BackgroundTaskStatus_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "BackgroundTaskStatusStreaming",
			Handler:       _Query_BackgroundTaskStatusStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "proto/kvs/aerospike_proxy_kv.proto",
}

Query_ServiceDesc is the grpc.ServiceDesc for Query service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var Scan_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Scan",
	HandlerType: (*ScanServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Scan",
			Handler:       _Scan_Scan_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "ScanStreaming",
			Handler:       _Scan_ScanStreaming_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "proto/kvs/aerospike_proxy_kv.proto",
}

Scan_ServiceDesc is the grpc.ServiceDesc for Scan service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterAboutServer 

func RegisterAboutServer(s grpc.ServiceRegistrar, srv AboutServer)

func RegisterKVSServer 

func RegisterKVSServer(s grpc.ServiceRegistrar, srv KVSServer)

func RegisterQueryServer 

func RegisterQueryServer(s grpc.ServiceRegistrar, srv QueryServer)

func RegisterScanServer 

func RegisterScanServer(s grpc.ServiceRegistrar, srv ScanServer)

Types

type AbortRequest 

type AbortRequest struct {

	// Unique identifier of the corresponding request in the stream to abort.
	// Not to be confused with the AbortRequest's id in the stream.
	AbortId uint32 `protobuf:"varint,1,opt,name=abortId,proto3" json:"abortId,omitempty"`
	// contains filtered or unexported fields
}

Abort a request identified by id in the stream.

func (*AbortRequest) Descriptor deprecated 

func (*AbortRequest) Descriptor() ([]byte, []int)

Deprecated: Use AbortRequest.ProtoReflect.Descriptor instead.

func (*AbortRequest) GetAbortId 

func (x *AbortRequest) GetAbortId() uint32

func (*AbortRequest) ProtoMessage 

func (*AbortRequest) ProtoMessage()

func (*AbortRequest) ProtoReflect 

func (x *AbortRequest) ProtoReflect() protoreflect.Message

func (*AbortRequest) Reset 

func (x *AbortRequest) Reset()

func (*AbortRequest) String 

func (x *AbortRequest) String() string

type AboutClient 

type AboutClient interface {
	Get(ctx context.Context, in *AboutRequest, opts ...grpc.CallOption) (*AboutResponse, error)
}

AboutClient is the client API for About service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAboutClient 

func NewAboutClient(cc grpc.ClientConnInterface) AboutClient

type AboutRequest 

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

The about request message.

func (*AboutRequest) Descriptor deprecated 

func (*AboutRequest) Descriptor() ([]byte, []int)

Deprecated: Use AboutRequest.ProtoReflect.Descriptor instead.

func (*AboutRequest) ProtoMessage 

func (*AboutRequest) ProtoMessage()

func (*AboutRequest) ProtoReflect 

func (x *AboutRequest) ProtoReflect() protoreflect.Message

func (*AboutRequest) Reset 

func (x *AboutRequest) Reset()

func (*AboutRequest) String 

func (x *AboutRequest) String() string

type AboutResponse 

type AboutResponse struct {

	// Proxy server version.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

The about response message.

func (*AboutResponse) Descriptor deprecated 

func (*AboutResponse) Descriptor() ([]byte, []int)

Deprecated: Use AboutResponse.ProtoReflect.Descriptor instead.

func (*AboutResponse) GetVersion 

func (x *AboutResponse) GetVersion() string

func (*AboutResponse) ProtoMessage 

func (*AboutResponse) ProtoMessage()

func (*AboutResponse) ProtoReflect 

func (x *AboutResponse) ProtoReflect() protoreflect.Message

func (*AboutResponse) Reset 

func (x *AboutResponse) Reset()

func (*AboutResponse) String 

func (x *AboutResponse) String() string

type AboutServer 

type AboutServer interface {
	Get(context.Context, *AboutRequest) (*AboutResponse, error)
	// contains filtered or unexported methods
}

AboutServer is the server API for About service. All implementations must embed UnimplementedAboutServer for forward compatibility

type AerospikeRequestPayload 

type AerospikeRequestPayload struct {

	// Unique identifier of the request in the stream.
	Id uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Client retry iteration.
	Iteration uint32 `protobuf:"varint,2,opt,name=iteration,proto3" json:"iteration,omitempty"`
	// Aerospike wire format request payload.
	Payload []byte `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
	// Read policy for read requests.
	ReadPolicy *ReadPolicy `protobuf:"bytes,4,opt,name=readPolicy,proto3,oneof" json:"readPolicy,omitempty"`
	// Write policy for write requests.
	WritePolicy *WritePolicy `protobuf:"bytes,5,opt,name=writePolicy,proto3,oneof" json:"writePolicy,omitempty"`
	// Scan request for scan.
	ScanRequest *ScanRequest `protobuf:"bytes,6,opt,name=scanRequest,proto3,oneof" json:"scanRequest,omitempty"`
	// Request for running a query.
	QueryRequest *QueryRequest `protobuf:"bytes,7,opt,name=queryRequest,proto3,oneof" json:"queryRequest,omitempty"`
	// Abort a scan/query on application error.
	AbortRequest *AbortRequest `protobuf:"bytes,8,opt,name=abortRequest,proto3,oneof" json:"abortRequest,omitempty"`
	// Request for executing operations background on matching records.
	BackgroundExecuteRequest *BackgroundExecuteRequest `protobuf:"bytes,9,opt,name=backgroundExecuteRequest,proto3,oneof" json:"backgroundExecuteRequest,omitempty"`
	// Request for getting background task status.
	BackgroundTaskStatusRequest *BackgroundTaskStatusRequest `protobuf:"bytes,10,opt,name=backgroundTaskStatusRequest,proto3,oneof" json:"backgroundTaskStatusRequest,omitempty"`
	// contains filtered or unexported fields
}

The request message containing the user's name.

func (*AerospikeRequestPayload) Descriptor deprecated 

func (*AerospikeRequestPayload) Descriptor() ([]byte, []int)

Deprecated: Use AerospikeRequestPayload.ProtoReflect.Descriptor instead.

func (*AerospikeRequestPayload) GetAbortRequest 

func (x *AerospikeRequestPayload) GetAbortRequest() *AbortRequest

func (*AerospikeRequestPayload) GetBackgroundExecuteRequest 

func (x *AerospikeRequestPayload) GetBackgroundExecuteRequest() *BackgroundExecuteRequest

func (*AerospikeRequestPayload) GetBackgroundTaskStatusRequest 

func (x *AerospikeRequestPayload) GetBackgroundTaskStatusRequest() *BackgroundTaskStatusRequest

func (*AerospikeRequestPayload) GetId 

func (x *AerospikeRequestPayload) GetId() uint32

func (*AerospikeRequestPayload) GetIteration 

func (x *AerospikeRequestPayload) GetIteration() uint32

func (*AerospikeRequestPayload) GetPayload 

func (x *AerospikeRequestPayload) GetPayload() []byte

func (*AerospikeRequestPayload) GetQueryRequest 

func (x *AerospikeRequestPayload) GetQueryRequest() *QueryRequest

func (*AerospikeRequestPayload) GetReadPolicy 

func (x *AerospikeRequestPayload) GetReadPolicy() *ReadPolicy

func (*AerospikeRequestPayload) GetScanRequest 

func (x *AerospikeRequestPayload) GetScanRequest() *ScanRequest

func (*AerospikeRequestPayload) GetWritePolicy 

func (x *AerospikeRequestPayload) GetWritePolicy() *WritePolicy

func (*AerospikeRequestPayload) ProtoMessage 

func (*AerospikeRequestPayload) ProtoMessage()

func (*AerospikeRequestPayload) ProtoReflect 

func (x *AerospikeRequestPayload) ProtoReflect() protoreflect.Message

func (*AerospikeRequestPayload) Reset 

func (x *AerospikeRequestPayload) Reset()

func (*AerospikeRequestPayload) String 

func (x *AerospikeRequestPayload) String() string

type AerospikeResponsePayload 

type AerospikeResponsePayload struct {

	// Unique identifier of the corresponding request in the stream.
	Id uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Status of the corresponding request.
	//
	//	if status equals 0
	//	   The proxy received a valid response from Aerospike. The payload's
	//	   result code should be used as the client result code.
	//	else
	//	   The request failed at the proxy. This status should be used
	//	   as the client result code.
	Status int32 `protobuf:"varint,2,opt,name=status,proto3" json:"status,omitempty"`
	// This flag indicates that the write transaction may have completed,
	// even though the client sees an error.
	InDoubt bool `protobuf:"varint,3,opt,name=inDoubt,proto3" json:"inDoubt,omitempty"`
	// Aerospike wire format request payload.
	Payload []byte `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"`
	// For requests with multiple responses like batch and queries,
	// hasNext flag indicates if there are more responses to follow this
	// response or if this is the last response for this request.
	HasNext bool `protobuf:"varint,5,opt,name=hasNext,proto3" json:"hasNext,omitempty"`
	// Background task status, populated for background task request.
	BackgroundTaskStatus *BackgroundTaskStatus `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

The request message containing the user's name.

func (*AerospikeResponsePayload) Descriptor deprecated 

func (*AerospikeResponsePayload) Descriptor() ([]byte, []int)

Deprecated: Use AerospikeResponsePayload.ProtoReflect.Descriptor instead.

func (*AerospikeResponsePayload) GetBackgroundTaskStatus 

func (x *AerospikeResponsePayload) GetBackgroundTaskStatus() BackgroundTaskStatus

func (*AerospikeResponsePayload) GetHasNext 

func (x *AerospikeResponsePayload) GetHasNext() bool

func (*AerospikeResponsePayload) GetId 

func (x *AerospikeResponsePayload) GetId() uint32

func (*AerospikeResponsePayload) GetInDoubt 

func (x *AerospikeResponsePayload) GetInDoubt() bool

func (*AerospikeResponsePayload) GetPayload 

func (x *AerospikeResponsePayload) GetPayload() []byte

func (*AerospikeResponsePayload) GetStatus 

func (x *AerospikeResponsePayload) GetStatus() int32

func (*AerospikeResponsePayload) ProtoMessage 

func (*AerospikeResponsePayload) ProtoMessage()

func (*AerospikeResponsePayload) ProtoReflect 

func (x *AerospikeResponsePayload) ProtoReflect() protoreflect.Message

func (*AerospikeResponsePayload) Reset 

func (x *AerospikeResponsePayload) Reset()

func (*AerospikeResponsePayload) String 

func (x *AerospikeResponsePayload) String() string

type BackgroundExecutePolicy 

type BackgroundExecutePolicy struct {

	// Read policy for AP (availability) namespaces.
	Replica Replica `protobuf:"varint,1,opt,name=replica,proto3,enum=Replica" json:"replica,omitempty"`
	// Read policy for SC (strong consistency) namespaces.
	ReadModeAP ReadModeAP `protobuf:"varint,2,opt,name=readModeAP,proto3,enum=ReadModeAP" json:"readModeAP,omitempty"`
	// Replica algorithm used to determine the target node
	// for a single record command.
	// Scan and scan are not affected by replica algorithms.
	ReadModeSC ReadModeSC `protobuf:"varint,3,opt,name=readModeSC,proto3,enum=ReadModeSC" json:"readModeSC,omitempty"`
	// Use zlib compression on command buffers sent to the server and responses received
	// from the server when the buffer size is greater than 128 bytes.
	// This option will increase cpu and memory usage (for extra compressed buffers),but
	// decrease the size of data sent over the network.
	Compress bool `protobuf:"varint,4,opt,name=compress,proto3" json:"compress,omitempty"`
	// Optional expression filter. If filterExp exists and evaluates to false, the
	// transaction is ignored.
	Expression []byte `protobuf:"bytes,5,opt,name=expression,proto3,oneof" json:"expression,omitempty"`
	// Total transaction timeout in milliseconds.
	// Default for all other commands: 1000ms
	TotalTimeout *uint32 `protobuf:"varint,6,opt,name=totalTimeout,proto3,oneof" json:"totalTimeout,omitempty"`
	// Send user defined key in addition to hash digest on both reads and writes.
	// If the key is sent on a write, the key will be stored with the record on
	// the server.
	// <p>
	// Default: false (do not send the user defined key)
	SendKey *bool `protobuf:"varint,7,opt,name=sendKey,proto3,oneof" json:"sendKey,omitempty"`
	// Qualify how to handle writes where the record already exists.
	//
	// Default: RecordExistsAction.UPDATE
	RecordExistsAction *RecordExistsAction `protobuf:"varint,8,opt,name=recordExistsAction,proto3,enum=RecordExistsAction,oneof" json:"recordExistsAction,omitempty"`
	// Qualify how to handle record writes based on record generation. The default (NONE)
	// indicates that the generation is not used to restrict writes.
	//
	// The server does not support this field for UDF execute() calls. The read-modify-write
	// usage model can still be enforced inside the UDF code itself.
	//
	// Default: GenerationPolicy.NONE
	GenerationPolicy *GenerationPolicy `protobuf:"varint,9,opt,name=generationPolicy,proto3,enum=GenerationPolicy,oneof" json:"generationPolicy,omitempty"`
	// Desired consistency guarantee when committing a transaction on the server. The default
	// (COMMIT_ALL) indicates that the server should wait for master and all replica commits to
	// be successful before returning success to the client.
	//
	// Default: CommitLevel.COMMIT_ALL
	CommitLevel *CommitLevel `protobuf:"varint,10,opt,name=commitLevel,proto3,enum=CommitLevel,oneof" json:"commitLevel,omitempty"`
	// Expected generation. Generation is the number of times a record has been modified
	// (including creation) on the server. If a write operation is creating a record,
	// the expected generation would be <code>0</code>. This field is only relevant when
	// generationPolicy is not NONE.
	//
	// The server does not support this field for UDF execute() calls. The read-modify-write
	// usage model can still be enforced inside the UDF code itself.
	//
	// Default: 0
	Generation *uint32 `protobuf:"varint,11,opt,name=generation,proto3,oneof" json:"generation,omitempty"`
	// Record expiration. Also known as ttl (time to live).
	// Seconds record will live before being removed by the server.
	//
	// Expiration values:
	//
	//   - -2: Do not change ttl when record is updated.
	//   - -1: Never expire.
	//   - 0: Default to namespace configuration variable "default-ttl" on the server.
	//   - &gt; 0: Actual ttl in seconds.<br>
	//
	// Default: 0
	Expiration *uint32 `protobuf:"varint,12,opt,name=expiration,proto3,oneof" json:"expiration,omitempty"`
	// For client operate(), return a result for every operation.
	//
	// Some operations do not return results by default (ListOperation.clear() for example).
	// This can make it difficult to determine the desired result offset in the returned
	// bin's result list.
	//
	// Setting respondAllOps to true makes it easier to identify the desired result offset
	// (result offset equals bin's operate sequence).  If there is a map operation in operate(),
	// respondAllOps will be forced to true for that operate() call.
	//
	// Default: false
	RespondAllOps *bool `protobuf:"varint,13,opt,name=respondAllOps,proto3,oneof" json:"respondAllOps,omitempty"`
	// If the transaction results in a record deletion, leave a tombstone for the record.
	// This prevents deleted records from reappearing after node failures.
	// Valid for Aerospike Server Enterprise Edition 3.10+ only.
	//
	// Default: false (do not tombstone deleted records).
	DurableDelete *bool `protobuf:"varint,14,opt,name=durableDelete,proto3,oneof" json:"durableDelete,omitempty"`
	// Operate in XDR mode.  Some external connectors may need to emulate an XDR client.
	// If enabled, an XDR bit is set for writes in the wire protocol.
	//
	// Default: false.
	Xdr *bool `protobuf:"varint,15,opt,name=xdr,proto3,oneof" json:"xdr,omitempty"`
	// contains filtered or unexported fields
}

func (*BackgroundExecutePolicy) Descriptor deprecated 

func (*BackgroundExecutePolicy) Descriptor() ([]byte, []int)

Deprecated: Use BackgroundExecutePolicy.ProtoReflect.Descriptor instead.

func (*BackgroundExecutePolicy) GetCommitLevel 

func (x *BackgroundExecutePolicy) GetCommitLevel() CommitLevel

func (*BackgroundExecutePolicy) GetCompress 

func (x *BackgroundExecutePolicy) GetCompress() bool

func (*BackgroundExecutePolicy) GetDurableDelete 

func (x *BackgroundExecutePolicy) GetDurableDelete() bool

func (*BackgroundExecutePolicy) GetExpiration 

func (x *BackgroundExecutePolicy) GetExpiration() uint32

func (*BackgroundExecutePolicy) GetExpression 

func (x *BackgroundExecutePolicy) GetExpression() []byte

func (*BackgroundExecutePolicy) GetGeneration 

func (x *BackgroundExecutePolicy) GetGeneration() uint32

func (*BackgroundExecutePolicy) GetGenerationPolicy 

func (x *BackgroundExecutePolicy) GetGenerationPolicy() GenerationPolicy

func (*BackgroundExecutePolicy) GetReadModeAP 

func (x *BackgroundExecutePolicy) GetReadModeAP() ReadModeAP

func (*BackgroundExecutePolicy) GetReadModeSC 

func (x *BackgroundExecutePolicy) GetReadModeSC() ReadModeSC

func (*BackgroundExecutePolicy) GetRecordExistsAction 

func (x *BackgroundExecutePolicy) GetRecordExistsAction() RecordExistsAction

func (*BackgroundExecutePolicy) GetReplica 

func (x *BackgroundExecutePolicy) GetReplica() Replica

func (*BackgroundExecutePolicy) GetRespondAllOps 

func (x *BackgroundExecutePolicy) GetRespondAllOps() bool

func (*BackgroundExecutePolicy) GetSendKey 

func (x *BackgroundExecutePolicy) GetSendKey() bool

func (*BackgroundExecutePolicy) GetTotalTimeout 

func (x *BackgroundExecutePolicy) GetTotalTimeout() uint32

func (*BackgroundExecutePolicy) GetXdr 

func (x *BackgroundExecutePolicy) GetXdr() bool

func (*BackgroundExecutePolicy) ProtoMessage 

func (*BackgroundExecutePolicy) ProtoMessage()

func (*BackgroundExecutePolicy) ProtoReflect 

func (x *BackgroundExecutePolicy) ProtoReflect() protoreflect.Message

func (*BackgroundExecutePolicy) Reset 

func (x *BackgroundExecutePolicy) Reset()

func (*BackgroundExecutePolicy) String 

func (x *BackgroundExecutePolicy) String() string

type BackgroundExecuteRequest 

type BackgroundExecuteRequest struct {

	// Background write policy
	WritePolicy *BackgroundExecutePolicy `protobuf:"bytes,1,opt,name=writePolicy,proto3,oneof" json:"writePolicy,omitempty"`
	// The statement containing the UDF function reference
	// or the operations to be performed on matching record
	Statement *Statement `protobuf:"bytes,2,opt,name=statement,proto3" json:"statement,omitempty"`
	// contains filtered or unexported fields
}

func (*BackgroundExecuteRequest) Descriptor deprecated 

func (*BackgroundExecuteRequest) Descriptor() ([]byte, []int)

Deprecated: Use BackgroundExecuteRequest.ProtoReflect.Descriptor instead.

func (*BackgroundExecuteRequest) GetStatement 

func (x *BackgroundExecuteRequest) GetStatement() *Statement

func (*BackgroundExecuteRequest) GetWritePolicy 

func (x *BackgroundExecuteRequest) GetWritePolicy() *BackgroundExecutePolicy

func (*BackgroundExecuteRequest) ProtoMessage 

func (*BackgroundExecuteRequest) ProtoMessage()

func (*BackgroundExecuteRequest) ProtoReflect 

func (x *BackgroundExecuteRequest) ProtoReflect() protoreflect.Message

func (*BackgroundExecuteRequest) Reset 

func (x *BackgroundExecuteRequest) Reset()

func (*BackgroundExecuteRequest) String 

func (x *BackgroundExecuteRequest) String() string

type BackgroundTaskStatus 

type BackgroundTaskStatus int32
const (
	// Task not found.
	BackgroundTaskStatus_NOT_FOUND BackgroundTaskStatus = 0
	// Task in progress.
	BackgroundTaskStatus_IN_PROGRESS BackgroundTaskStatus = 1
	// Task completed.
	BackgroundTaskStatus_COMPLETE BackgroundTaskStatus = 2
)

func (BackgroundTaskStatus) Descriptor 

func (BackgroundTaskStatus) Descriptor() protoreflect.EnumDescriptor

func (BackgroundTaskStatus) Enum 

func (x BackgroundTaskStatus) Enum() *BackgroundTaskStatus

func (BackgroundTaskStatus) EnumDescriptor deprecated 

func (BackgroundTaskStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use BackgroundTaskStatus.Descriptor instead.

func (BackgroundTaskStatus) Number 

func (x BackgroundTaskStatus) Number() protoreflect.EnumNumber

func (BackgroundTaskStatus) String 

func (x BackgroundTaskStatus) String() string

func (BackgroundTaskStatus) Type 

func (BackgroundTaskStatus) Type() protoreflect.EnumType

type BackgroundTaskStatusRequest 

type BackgroundTaskStatusRequest struct {

	// The id of the task.
	TaskId int64 `protobuf:"varint,1,opt,name=taskId,proto3" json:"taskId,omitempty"`
	// If true indicates the task is a scan task else task is a query
	IsScan bool `protobuf:"varint,2,opt,name=isScan,proto3" json:"isScan,omitempty"`
	// contains filtered or unexported fields
}

func (*BackgroundTaskStatusRequest) Descriptor deprecated 

func (*BackgroundTaskStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use BackgroundTaskStatusRequest.ProtoReflect.Descriptor instead.

func (*BackgroundTaskStatusRequest) GetIsScan 

func (x *BackgroundTaskStatusRequest) GetIsScan() bool

func (*BackgroundTaskStatusRequest) GetTaskId 

func (x *BackgroundTaskStatusRequest) GetTaskId() int64

func (*BackgroundTaskStatusRequest) ProtoMessage 

func (*BackgroundTaskStatusRequest) ProtoMessage()

func (*BackgroundTaskStatusRequest) ProtoReflect 

func (x *BackgroundTaskStatusRequest) ProtoReflect() protoreflect.Message

func (*BackgroundTaskStatusRequest) Reset 

func (x *BackgroundTaskStatusRequest) Reset()

func (*BackgroundTaskStatusRequest) String 

func (x *BackgroundTaskStatusRequest) String() string

type CommitLevel 

type CommitLevel int32
const (
	// Server should wait until successfully committing master and all replicas.
	CommitLevel_COMMIT_ALL CommitLevel = 0
	// Server should wait until successfully committing master only.
	CommitLevel_COMMIT_MASTER CommitLevel = 1
)

func (CommitLevel) Descriptor 

func (CommitLevel) Descriptor() protoreflect.EnumDescriptor

func (CommitLevel) Enum 

func (x CommitLevel) Enum() *CommitLevel

func (CommitLevel) EnumDescriptor deprecated 

func (CommitLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use CommitLevel.Descriptor instead.

func (CommitLevel) Number 

func (x CommitLevel) Number() protoreflect.EnumNumber

func (CommitLevel) String 

func (x CommitLevel) String() string

func (CommitLevel) Type 

func (CommitLevel) Type() protoreflect.EnumType

type Filter 

type Filter struct {

	// Name of the filter.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Secondary index collection type.
	ColType IndexCollectionType `protobuf:"varint,2,opt,name=colType,proto3,enum=IndexCollectionType" json:"colType,omitempty"`
	// Optional filter context packed in Aerospike format.
	PackedCtx []byte `protobuf:"bytes,3,opt,name=packedCtx,proto3,oneof" json:"packedCtx,omitempty"`
	// The queried column particle type.
	ValType int32 `protobuf:"varint,4,opt,name=valType,proto3" json:"valType,omitempty"`
	// The Aerospike encoded query start "Value"
	Begin []byte `protobuf:"bytes,5,opt,name=begin,proto3,oneof" json:"begin,omitempty"`
	// The Aerospike encoded query end "Value"
	End []byte `protobuf:"bytes,6,opt,name=end,proto3,oneof" json:"end,omitempty"`
	// contains filtered or unexported fields
}

Query statement filter

func (*Filter) Descriptor deprecated 

func (*Filter) Descriptor() ([]byte, []int)

Deprecated: Use Filter.ProtoReflect.Descriptor instead.

func (*Filter) GetBegin 

func (x *Filter) GetBegin() []byte

func (*Filter) GetColType 

func (x *Filter) GetColType() IndexCollectionType

func (*Filter) GetEnd 

func (x *Filter) GetEnd() []byte

func (*Filter) GetName 

func (x *Filter) GetName() string

func (*Filter) GetPackedCtx 

func (x *Filter) GetPackedCtx() []byte

func (*Filter) GetValType 

func (x *Filter) GetValType() int32

func (*Filter) ProtoMessage 

func (*Filter) ProtoMessage()

func (*Filter) ProtoReflect 

func (x *Filter) ProtoReflect() protoreflect.Message

func (*Filter) Reset 

func (x *Filter) Reset()

func (*Filter) String 

func (x *Filter) String() string

type GenerationPolicy 

type GenerationPolicy int32
const (
	// Do not use record generation to restrict writes.
	GenerationPolicy_NONE GenerationPolicy = 0
	// Update/delete record if expected generation is equal to server generation. Otherwise, fail.
	GenerationPolicy_EXPECT_GEN_EQUAL GenerationPolicy = 1
	// Update/delete record if expected generation greater than the server generation. Otherwise, fail.
	// This is useful for restore after backup.
	GenerationPolicy_EXPECT_GEN_GT GenerationPolicy = 2
)

func (GenerationPolicy) Descriptor 

func (GenerationPolicy) Descriptor() protoreflect.EnumDescriptor

func (GenerationPolicy) Enum 

func (x GenerationPolicy) Enum() *GenerationPolicy

func (GenerationPolicy) EnumDescriptor deprecated 

func (GenerationPolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use GenerationPolicy.Descriptor instead.

func (GenerationPolicy) Number 

func (x GenerationPolicy) Number() protoreflect.EnumNumber

func (GenerationPolicy) String 

func (x GenerationPolicy) String() string

func (GenerationPolicy) Type 

func (GenerationPolicy) Type() protoreflect.EnumType

type IndexCollectionType 

type IndexCollectionType int32

Secondary index collection type. 

const (
	// Normal scalar index.
	IndexCollectionType_DEFAULT IndexCollectionType = 0
	// Index list elements.
	IndexCollectionType_LIST IndexCollectionType = 1
	// Index map keys.
	IndexCollectionType_MAPKEYS IndexCollectionType = 2
	// Index map values.
	IndexCollectionType_MAPVALUES IndexCollectionType = 3
)

func (IndexCollectionType) Descriptor 

func (IndexCollectionType) Descriptor() protoreflect.EnumDescriptor

func (IndexCollectionType) Enum 

func (x IndexCollectionType) Enum() *IndexCollectionType

func (IndexCollectionType) EnumDescriptor deprecated 

func (IndexCollectionType) EnumDescriptor() ([]byte, []int)

Deprecated: Use IndexCollectionType.Descriptor instead.

func (IndexCollectionType) Number 

func (x IndexCollectionType) Number() protoreflect.EnumNumber

func (IndexCollectionType) String 

func (x IndexCollectionType) String() string

func (IndexCollectionType) Type 

func (IndexCollectionType) Type() protoreflect.EnumType

type KVSClient 

type KVSClient interface {
	// Read a single record
	Read(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (*AerospikeResponsePayload, error)
	// Process stream of single record read requests.
	ReadStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_ReadStreamingClient, error)
	// Get a single record header containing metadata like generation, expiration
	GetHeader(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (*AerospikeResponsePayload, error)
	// Process stream of single record get header requests.
	GetHeaderStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_GetHeaderStreamingClient, error)
	// Check if a record exists.
	Exists(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (*AerospikeResponsePayload, error)
	// Process stream of single record exist requests.
	ExistsStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_ExistsStreamingClient, error)
	// Write a single record
	Write(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (*AerospikeResponsePayload, error)
	// Process a stream of single record write requests.
	WriteStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_WriteStreamingClient, error)
	// Delete a single record.
	Delete(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (*AerospikeResponsePayload, error)
	// Process a stream of single record delete requests.
	DeleteStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_DeleteStreamingClient, error)
	// Reset single record's time to expiration using the write policy's expiration.
	Touch(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (*AerospikeResponsePayload, error)
	// Process a stream of single record touch requests.
	TouchStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_TouchStreamingClient, error)
	// Perform multiple read/write operations on a single key in one batch call.
	Operate(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (*AerospikeResponsePayload, error)
	// Perform a stream of operate requests.
	OperateStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_OperateStreamingClient, error)
	// Execute single key user defined function on server and return results.
	Execute(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (*AerospikeResponsePayload, error)
	// Process a stream of single record execute requests.
	ExecuteStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_ExecuteStreamingClient, error)
	// Process batch requests.
	BatchOperate(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (KVS_BatchOperateClient, error)
	// Process a stream of batch requests.
	BatchOperateStreaming(ctx context.Context, opts ...grpc.CallOption) (KVS_BatchOperateStreamingClient, error)
}

KVSClient is the client API for KVS service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewKVSClient 

func NewKVSClient(cc grpc.ClientConnInterface) KVSClient

type KVSServer 

type KVSServer interface {
	// Read a single record
	Read(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)
	// Process stream of single record read requests.
	ReadStreaming(KVS_ReadStreamingServer) error
	// Get a single record header containing metadata like generation, expiration
	GetHeader(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)
	// Process stream of single record get header requests.
	GetHeaderStreaming(KVS_GetHeaderStreamingServer) error
	// Check if a record exists.
	Exists(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)
	// Process stream of single record exist requests.
	ExistsStreaming(KVS_ExistsStreamingServer) error
	// Write a single record
	Write(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)
	// Process a stream of single record write requests.
	WriteStreaming(KVS_WriteStreamingServer) error
	// Delete a single record.
	Delete(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)
	// Process a stream of single record delete requests.
	DeleteStreaming(KVS_DeleteStreamingServer) error
	// Reset single record's time to expiration using the write policy's expiration.
	Touch(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)
	// Process a stream of single record touch requests.
	TouchStreaming(KVS_TouchStreamingServer) error
	// Perform multiple read/write operations on a single key in one batch call.
	Operate(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)
	// Perform a stream of operate requests.
	OperateStreaming(KVS_OperateStreamingServer) error
	// Execute single key user defined function on server and return results.
	Execute(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)
	// Process a stream of single record execute requests.
	ExecuteStreaming(KVS_ExecuteStreamingServer) error
	// Process batch requests.
	BatchOperate(*AerospikeRequestPayload, KVS_BatchOperateServer) error
	// Process a stream of batch requests.
	BatchOperateStreaming(KVS_BatchOperateStreamingServer) error
	// contains filtered or unexported methods
}

KVSServer is the server API for KVS service. All implementations must embed UnimplementedKVSServer for forward compatibility

type KVS_BatchOperateClient 

type KVS_BatchOperateClient interface {
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_BatchOperateServer 

type KVS_BatchOperateServer interface {
	Send(*AerospikeResponsePayload) error
	grpc.ServerStream
}

type KVS_BatchOperateStreamingClient 

type KVS_BatchOperateStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_BatchOperateStreamingServer 

type KVS_BatchOperateStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type KVS_DeleteStreamingClient 

type KVS_DeleteStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_DeleteStreamingServer 

type KVS_DeleteStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type KVS_ExecuteStreamingClient 

type KVS_ExecuteStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_ExecuteStreamingServer 

type KVS_ExecuteStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type KVS_ExistsStreamingClient 

type KVS_ExistsStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_ExistsStreamingServer 

type KVS_ExistsStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type KVS_GetHeaderStreamingClient 

type KVS_GetHeaderStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_GetHeaderStreamingServer 

type KVS_GetHeaderStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type KVS_OperateStreamingClient 

type KVS_OperateStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_OperateStreamingServer 

type KVS_OperateStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type KVS_ReadStreamingClient 

type KVS_ReadStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_ReadStreamingServer 

type KVS_ReadStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type KVS_TouchStreamingClient 

type KVS_TouchStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_TouchStreamingServer 

type KVS_TouchStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type KVS_WriteStreamingClient 

type KVS_WriteStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type KVS_WriteStreamingServer 

type KVS_WriteStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type Operation 

type Operation struct {

	// The operation type.
	Type OperationType `protobuf:"varint,1,opt,name=type,proto3,enum=OperationType" json:"type,omitempty"`
	// Optional bin name.
	BinName *string `protobuf:"bytes,2,opt,name=binName,proto3,oneof" json:"binName,omitempty"`
	// Optional bin value.
	Value []byte `protobuf:"bytes,3,opt,name=value,proto3,oneof" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Single record operation.

func (*Operation) Descriptor deprecated 

func (*Operation) Descriptor() ([]byte, []int)

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) GetBinName 

func (x *Operation) GetBinName() string

func (*Operation) GetType 

func (x *Operation) GetType() OperationType

func (*Operation) GetValue 

func (x *Operation) GetValue() []byte

func (*Operation) ProtoMessage 

func (*Operation) ProtoMessage()

func (*Operation) ProtoReflect 

func (x *Operation) ProtoReflect() protoreflect.Message

func (*Operation) Reset 

func (x *Operation) Reset()

func (*Operation) String 

func (x *Operation) String() string

type OperationType 

type OperationType int32
const (
	OperationType_READ        OperationType = 0
	OperationType_READ_HEADER OperationType = 1
	OperationType_WRITE       OperationType = 2
	OperationType_CDT_READ    OperationType = 3
	OperationType_CDT_MODIFY  OperationType = 4
	OperationType_MAP_READ    OperationType = 5
	OperationType_MAP_MODIFY  OperationType = 6
	OperationType_ADD         OperationType = 7
	OperationType_EXP_READ    OperationType = 8
	OperationType_EXP_MODIFY  OperationType = 9
	OperationType_APPEND      OperationType = 10
	OperationType_PREPEND     OperationType = 11
	OperationType_TOUCH       OperationType = 12
	OperationType_BIT_READ    OperationType = 13
	OperationType_BIT_MODIFY  OperationType = 14
	OperationType_DELETE      OperationType = 15
	OperationType_HLL_READ    OperationType = 16
	OperationType_HLL_MODIFY  OperationType = 17
)

func (OperationType) Descriptor 

func (OperationType) Descriptor() protoreflect.EnumDescriptor

func (OperationType) Enum 

func (x OperationType) Enum() *OperationType

func (OperationType) EnumDescriptor deprecated 

func (OperationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationType.Descriptor instead.

func (OperationType) Number 

func (x OperationType) Number() protoreflect.EnumNumber

func (OperationType) String 

func (x OperationType) String() string

func (OperationType) Type 

func (OperationType) Type() protoreflect.EnumType

type PartitionFilter 

type PartitionFilter struct {

	// Start partition id.
	// Not required if the digest to start scanning from is specified.
	Begin *uint32 `protobuf:"varint,1,opt,name=begin,proto3,oneof" json:"begin,omitempty"`
	// The number of records to scan.
	Count uint32 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// Optional digest to start scanning from.
	Digest []byte `protobuf:"bytes,3,opt,name=digest,proto3,oneof" json:"digest,omitempty"`
	// Optional partition statuses used on retries to restart
	// from last known record for the partition.
	PartitionStatuses []*PartitionStatus `protobuf:"bytes,4,rep,name=partitionStatuses,proto3" json:"partitionStatuses,omitempty"`
	// Indicates if all partitions in this filter should
	// be retried ignoring the partition status
	Retry bool `protobuf:"varint,5,opt,name=retry,proto3" json:"retry,omitempty"`
	// contains filtered or unexported fields
}

A partition filter for scans and queries.

func (*PartitionFilter) Descriptor deprecated 

func (*PartitionFilter) Descriptor() ([]byte, []int)

Deprecated: Use PartitionFilter.ProtoReflect.Descriptor instead.

func (*PartitionFilter) GetBegin 

func (x *PartitionFilter) GetBegin() uint32

func (*PartitionFilter) GetCount 

func (x *PartitionFilter) GetCount() uint32

func (*PartitionFilter) GetDigest 

func (x *PartitionFilter) GetDigest() []byte

func (*PartitionFilter) GetPartitionStatuses 

func (x *PartitionFilter) GetPartitionStatuses() []*PartitionStatus

func (*PartitionFilter) GetRetry 

func (x *PartitionFilter) GetRetry() bool

func (*PartitionFilter) ProtoMessage 

func (*PartitionFilter) ProtoMessage()

func (*PartitionFilter) ProtoReflect 

func (x *PartitionFilter) ProtoReflect() protoreflect.Message

func (*PartitionFilter) Reset 

func (x *PartitionFilter) Reset()

func (*PartitionFilter) String 

func (x *PartitionFilter) String() string

type PartitionStatus 

type PartitionStatus struct {

	// The partition status.
	Id *uint32 `protobuf:"varint,1,opt,name=id,proto3,oneof" json:"id,omitempty"`
	// Begin value to start scanning / querying after.
	BVal *int64 `protobuf:"varint,2,opt,name=bVal,proto3,oneof" json:"bVal,omitempty"`
	// Digest to start scanning / querying after.
	Digest []byte `protobuf:"bytes,3,opt,name=digest,proto3,oneof" json:"digest,omitempty"`
	// Indicates this partition should be tried.
	// Should be set to true for the first attempt as well.
	Retry bool `protobuf:"varint,5,opt,name=retry,proto3" json:"retry,omitempty"`
	// contains filtered or unexported fields
}

Partition status used to perform partial scans on client side retries.

func (*PartitionStatus) Descriptor deprecated 

func (*PartitionStatus) Descriptor() ([]byte, []int)

Deprecated: Use PartitionStatus.ProtoReflect.Descriptor instead.

func (*PartitionStatus) GetBVal 

func (x *PartitionStatus) GetBVal() int64

func (*PartitionStatus) GetDigest 

func (x *PartitionStatus) GetDigest() []byte

func (*PartitionStatus) GetId 

func (x *PartitionStatus) GetId() uint32

func (*PartitionStatus) GetRetry 

func (x *PartitionStatus) GetRetry() bool

func (*PartitionStatus) ProtoMessage 

func (*PartitionStatus) ProtoMessage()

func (*PartitionStatus) ProtoReflect 

func (x *PartitionStatus) ProtoReflect() protoreflect.Message

func (*PartitionStatus) Reset 

func (x *PartitionStatus) Reset()

func (*PartitionStatus) String 

func (x *PartitionStatus) String() string

type QueryClient 

type QueryClient interface {
	// Query Aerospike
	Query(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (Query_QueryClient, error)
	// Process a stream of query requests
	QueryStreaming(ctx context.Context, opts ...grpc.CallOption) (Query_QueryStreamingClient, error)
	// Execute background write on selected records.
	BackgroundExecute(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (Query_BackgroundExecuteClient, error)
	// Execute a stream of  background write requests.
	BackgroundExecuteStreaming(ctx context.Context, opts ...grpc.CallOption) (Query_BackgroundExecuteStreamingClient, error)
	// Get status of a background task.
	BackgroundTaskStatus(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (Query_BackgroundTaskStatusClient, error)
	// Get status of a stream of background tasks.
	BackgroundTaskStatusStreaming(ctx context.Context, opts ...grpc.CallOption) (Query_BackgroundTaskStatusStreamingClient, error)
}

QueryClient is the client API for Query service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewQueryClient 

func NewQueryClient(cc grpc.ClientConnInterface) QueryClient

type QueryPolicy 

type QueryPolicy struct {

	// Read policy for AP (availability) namespaces.
	Replica Replica `protobuf:"varint,1,opt,name=replica,proto3,enum=Replica" json:"replica,omitempty"`
	// Read policy for SC (strong consistency) namespaces.
	ReadModeAP ReadModeAP `protobuf:"varint,2,opt,name=readModeAP,proto3,enum=ReadModeAP" json:"readModeAP,omitempty"`
	// Replica algorithm used to determine the target node
	// for a single record command.
	// Scan and query are not affected by replica algorithms.
	ReadModeSC ReadModeSC `protobuf:"varint,3,opt,name=readModeSC,proto3,enum=ReadModeSC" json:"readModeSC,omitempty"`
	// Send user defined key in addition to hash digest on both reads and writes.
	// If the key is sent on a write, the key will be stored with the record on
	// the server.
	// Default: false (do not send the user defined key)
	SendKey *bool `protobuf:"varint,4,opt,name=sendKey,proto3,oneof" json:"sendKey,omitempty"`
	// Use zlib compression on command buffers sent to the server and responses received
	// from the server when the buffer size is greater than 128 bytes.
	// This option will increase cpu and memory usage (for extra compressed buffers),but
	// decrease the size of data sent over the network.
	Compress bool `protobuf:"varint,5,opt,name=compress,proto3" json:"compress,omitempty"`
	// Optional expression filter. If filterExp exists and evaluates to false, the
	// transaction is ignored.
	Expression []byte `protobuf:"bytes,6,opt,name=expression,proto3,oneof" json:"expression,omitempty"`
	// Total transaction timeout in milliseconds.
	// Default for all other commands: 1000ms
	TotalTimeout *uint32 `protobuf:"varint,7,opt,name=totalTimeout,proto3,oneof" json:"totalTimeout,omitempty"`
	// Maximum number of concurrent requests to server nodes at any point in time.
	// If there are 16 nodes in the cluster and maxConcurrentNodes is 8, then queries
	// will be made to 8 nodes in parallel.  When a query completes, a new query will
	// be issued until all 16 nodes have been queried.
	// Default: 0 (issue requests to all server nodes in parallel)
	MaxConcurrentNodes *uint32 `protobuf:"varint,8,opt,name=maxConcurrentNodes,proto3,oneof" json:"maxConcurrentNodes,omitempty"`
	// Number of records to place in queue before blocking.
	// Records received from multiple server nodes will be placed in a queue.
	// A separate thread consumes these records in parallel.
	// If the queue is full, the producer threads will block until records are consumed.
	// Default: 5000
	RecordQueueSize *uint32 `protobuf:"varint,9,opt,name=recordQueueSize,proto3,oneof" json:"recordQueueSize,omitempty"`
	// Should bin data be retrieved. If false, only record digests (and user keys
	// if stored on the server) are retrieved.
	// Default: true
	IncludeBinData *bool `protobuf:"varint,10,opt,name=includeBinData,proto3,oneof" json:"includeBinData,omitempty"`
	// Terminate query if cluster is in migration state. If the server supports partition
	// queries or the query filter is null (scan), this field is ignored.
	// Default: false
	FailOnClusterChange *bool `protobuf:"varint,11,opt,name=failOnClusterChange,proto3,oneof" json:"failOnClusterChange,omitempty"`
	// Is query expected to return less than 100 records per node.
	// If true, the server will optimize the query for a small record set.
	// This field is ignored for aggregation queries, background queries
	// and server versions &lt; 6.0.
	// Default: false
	ShortQuery *bool `protobuf:"varint,12,opt,name=shortQuery,proto3,oneof" json:"shortQuery,omitempty"`
	// Timeout in milliseconds for "cluster-stable" info command that is run when
	// failOnClusterChange is true and server version is less than 6.0.
	//
	//	Default: 1000
	InfoTimeout *uint32 `protobuf:"varint,13,opt,name=infoTimeout,proto3,oneof" json:"infoTimeout,omitempty"`
	// contains filtered or unexported fields
}

Query policy attributes used by queries. Query requests are send completely using proto buffers and hence include all policy attributes.

func (*QueryPolicy) Descriptor deprecated 

func (*QueryPolicy) Descriptor() ([]byte, []int)

Deprecated: Use QueryPolicy.ProtoReflect.Descriptor instead.

func (*QueryPolicy) GetCompress 

func (x *QueryPolicy) GetCompress() bool

func (*QueryPolicy) GetExpression 

func (x *QueryPolicy) GetExpression() []byte

func (*QueryPolicy) GetFailOnClusterChange 

func (x *QueryPolicy) GetFailOnClusterChange() bool

func (*QueryPolicy) GetIncludeBinData 

func (x *QueryPolicy) GetIncludeBinData() bool

func (*QueryPolicy) GetInfoTimeout 

func (x *QueryPolicy) GetInfoTimeout() uint32

func (*QueryPolicy) GetMaxConcurrentNodes 

func (x *QueryPolicy) GetMaxConcurrentNodes() uint32

func (*QueryPolicy) GetReadModeAP 

func (x *QueryPolicy) GetReadModeAP() ReadModeAP

func (*QueryPolicy) GetReadModeSC 

func (x *QueryPolicy) GetReadModeSC() ReadModeSC

func (*QueryPolicy) GetRecordQueueSize 

func (x *QueryPolicy) GetRecordQueueSize() uint32

func (*QueryPolicy) GetReplica 

func (x *QueryPolicy) GetReplica() Replica

func (*QueryPolicy) GetSendKey 

func (x *QueryPolicy) GetSendKey() bool

func (*QueryPolicy) GetShortQuery 

func (x *QueryPolicy) GetShortQuery() bool

func (*QueryPolicy) GetTotalTimeout 

func (x *QueryPolicy) GetTotalTimeout() uint32

func (*QueryPolicy) ProtoMessage 

func (*QueryPolicy) ProtoMessage()

func (*QueryPolicy) ProtoReflect 

func (x *QueryPolicy) ProtoReflect() protoreflect.Message

func (*QueryPolicy) Reset 

func (x *QueryPolicy) Reset()

func (*QueryPolicy) String 

func (x *QueryPolicy) String() string

type QueryRequest 

type QueryRequest struct {

	// Optional query policy.
	QueryPolicy *QueryPolicy `protobuf:"bytes,1,opt,name=queryPolicy,proto3,oneof" json:"queryPolicy,omitempty"`
	// The query statement.
	Statement *Statement `protobuf:"bytes,2,opt,name=statement,proto3" json:"statement,omitempty"`
	// Set to true for background queries.
	Background bool `protobuf:"varint,3,opt,name=background,proto3" json:"background,omitempty"`
	// Optional partition filter to selectively query partitions.
	PartitionFilter *PartitionFilter `protobuf:"bytes,4,opt,name=partitionFilter,proto3,oneof" json:"partitionFilter,omitempty"`
	// contains filtered or unexported fields
}

A query request.

func (*QueryRequest) Descriptor deprecated 

func (*QueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetBackground 

func (x *QueryRequest) GetBackground() bool

func (*QueryRequest) GetPartitionFilter 

func (x *QueryRequest) GetPartitionFilter() *PartitionFilter

func (*QueryRequest) GetQueryPolicy 

func (x *QueryRequest) GetQueryPolicy() *QueryPolicy

func (*QueryRequest) GetStatement 

func (x *QueryRequest) GetStatement() *Statement

func (*QueryRequest) ProtoMessage 

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect 

func (x *QueryRequest) ProtoReflect() protoreflect.Message

func (*QueryRequest) Reset 

func (x *QueryRequest) Reset()

func (*QueryRequest) String 

func (x *QueryRequest) String() string

type QueryServer 

type QueryServer interface {
	// Query Aerospike
	Query(*AerospikeRequestPayload, Query_QueryServer) error
	// Process a stream of query requests
	QueryStreaming(Query_QueryStreamingServer) error
	// Execute background write on selected records.
	BackgroundExecute(*AerospikeRequestPayload, Query_BackgroundExecuteServer) error
	// Execute a stream of  background write requests.
	BackgroundExecuteStreaming(Query_BackgroundExecuteStreamingServer) error
	// Get status of a background task.
	BackgroundTaskStatus(*AerospikeRequestPayload, Query_BackgroundTaskStatusServer) error
	// Get status of a stream of background tasks.
	BackgroundTaskStatusStreaming(Query_BackgroundTaskStatusStreamingServer) error
	// contains filtered or unexported methods
}

QueryServer is the server API for Query service. All implementations must embed UnimplementedQueryServer for forward compatibility

type Query_BackgroundExecuteClient 

type Query_BackgroundExecuteClient interface {
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type Query_BackgroundExecuteServer 

type Query_BackgroundExecuteServer interface {
	Send(*AerospikeResponsePayload) error
	grpc.ServerStream
}

type Query_BackgroundExecuteStreamingClient 

type Query_BackgroundExecuteStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type Query_BackgroundExecuteStreamingServer 

type Query_BackgroundExecuteStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type Query_BackgroundTaskStatusClient 

type Query_BackgroundTaskStatusClient interface {
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type Query_BackgroundTaskStatusServer 

type Query_BackgroundTaskStatusServer interface {
	Send(*AerospikeResponsePayload) error
	grpc.ServerStream
}

type Query_BackgroundTaskStatusStreamingClient 

type Query_BackgroundTaskStatusStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type Query_BackgroundTaskStatusStreamingServer 

type Query_BackgroundTaskStatusStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type Query_QueryClient 

type Query_QueryClient interface {
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type Query_QueryServer 

type Query_QueryServer interface {
	Send(*AerospikeResponsePayload) error
	grpc.ServerStream
}

type Query_QueryStreamingClient 

type Query_QueryStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type Query_QueryStreamingServer 

type Query_QueryStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type ReadModeAP 

type ReadModeAP int32

Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. 

const (
	// Involve single node in the read operation.
	ReadModeAP_ONE ReadModeAP = 0
	// Involve all duplicates in the read operation.
	ReadModeAP_ALL ReadModeAP = 1
)

func (ReadModeAP) Descriptor 

func (ReadModeAP) Descriptor() protoreflect.EnumDescriptor

func (ReadModeAP) Enum 

func (x ReadModeAP) Enum() *ReadModeAP

func (ReadModeAP) EnumDescriptor deprecated 

func (ReadModeAP) EnumDescriptor() ([]byte, []int)

Deprecated: Use ReadModeAP.Descriptor instead.

func (ReadModeAP) Number 

func (x ReadModeAP) Number() protoreflect.EnumNumber

func (ReadModeAP) String 

func (x ReadModeAP) String() string

func (ReadModeAP) Type 

func (ReadModeAP) Type() protoreflect.EnumType

type ReadModeSC 

type ReadModeSC int32

Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. 

const (
	// Ensures this client will only see an increasing sequence of record versions.
	// Server only reads from master.  This is the default.
	ReadModeSC_SESSION ReadModeSC = 0
	// Ensures ALL clients will only see an increasing sequence of record versions.
	// Server only reads from master.
	ReadModeSC_LINEARIZE ReadModeSC = 1
	// Server may read from master or any full (non-migrating) replica.
	// Increasing sequence of record versions is not guaranteed.
	ReadModeSC_ALLOW_REPLICA ReadModeSC = 2
	// Server may read from master or any full (non-migrating) replica or from unavailable
	// partitions.  Increasing sequence of record versions is not guaranteed.
	ReadModeSC_ALLOW_UNAVAILABLE ReadModeSC = 3
)

func (ReadModeSC) Descriptor 

func (ReadModeSC) Descriptor() protoreflect.EnumDescriptor

func (ReadModeSC) Enum 

func (x ReadModeSC) Enum() *ReadModeSC

func (ReadModeSC) EnumDescriptor deprecated 

func (ReadModeSC) EnumDescriptor() ([]byte, []int)

Deprecated: Use ReadModeSC.Descriptor instead.

func (ReadModeSC) Number 

func (x ReadModeSC) Number() protoreflect.EnumNumber

func (ReadModeSC) String 

func (x ReadModeSC) String() string

func (ReadModeSC) Type 

func (ReadModeSC) Type() protoreflect.EnumType

type ReadPolicy 

type ReadPolicy struct {

	// Read policy for AP (availability) namespaces.
	Replica Replica `protobuf:"varint,1,opt,name=replica,proto3,enum=Replica" json:"replica,omitempty"`
	// Read policy for SC (strong consistency) namespaces.
	ReadModeAP ReadModeAP `protobuf:"varint,2,opt,name=readModeAP,proto3,enum=ReadModeAP" json:"readModeAP,omitempty"`
	// Replica algorithm used to determine the target node
	// for a single record command.
	// Scan and query are not affected by replica algorithms.
	ReadModeSC ReadModeSC `protobuf:"varint,3,opt,name=readModeSC,proto3,enum=ReadModeSC" json:"readModeSC,omitempty"`
	// contains filtered or unexported fields
}

Read policy attributes used in read database commands that are not part of the wire protocol.

func (*ReadPolicy) Descriptor deprecated 

func (*ReadPolicy) Descriptor() ([]byte, []int)

Deprecated: Use ReadPolicy.ProtoReflect.Descriptor instead.

func (*ReadPolicy) GetReadModeAP 

func (x *ReadPolicy) GetReadModeAP() ReadModeAP

func (*ReadPolicy) GetReadModeSC 

func (x *ReadPolicy) GetReadModeSC() ReadModeSC

func (*ReadPolicy) GetReplica 

func (x *ReadPolicy) GetReplica() Replica

func (*ReadPolicy) ProtoMessage 

func (*ReadPolicy) ProtoMessage()

func (*ReadPolicy) ProtoReflect 

func (x *ReadPolicy) ProtoReflect() protoreflect.Message

func (*ReadPolicy) Reset 

func (x *ReadPolicy) Reset()

func (*ReadPolicy) String 

func (x *ReadPolicy) String() string

type RecordExistsAction 

type RecordExistsAction int32
const (
	// Create or update record.
	// Merge write command bins with existing bins.
	RecordExistsAction_UPDATE RecordExistsAction = 0
	// Update record only. Fail if record does not exist.
	// Merge write command bins with existing bins.
	RecordExistsAction_UPDATE_ONLY RecordExistsAction = 1
	// Create or replace record.
	// Delete existing bins not referenced by write command bins.
	// Supported by Aerospike server versions &gt;= 3.1.6.
	RecordExistsAction_REPLACE RecordExistsAction = 2
	// Replace record only. Fail if record does not exist.
	// Delete existing bins not referenced by write command bins.
	// Supported by Aerospike server versions &gt;= 3.1.6.
	RecordExistsAction_REPLACE_ONLY RecordExistsAction = 3
	// Create only.  Fail if record exists.
	RecordExistsAction_CREATE_ONLY RecordExistsAction = 4
)

func (RecordExistsAction) Descriptor 

func (RecordExistsAction) Descriptor() protoreflect.EnumDescriptor

func (RecordExistsAction) Enum 

func (x RecordExistsAction) Enum() *RecordExistsAction

func (RecordExistsAction) EnumDescriptor deprecated 

func (RecordExistsAction) EnumDescriptor() ([]byte, []int)

Deprecated: Use RecordExistsAction.Descriptor instead.

func (RecordExistsAction) Number 

func (x RecordExistsAction) Number() protoreflect.EnumNumber

func (RecordExistsAction) String 

func (x RecordExistsAction) String() string

func (RecordExistsAction) Type 

func (RecordExistsAction) Type() protoreflect.EnumType

type Replica 

type Replica int32

Defines algorithm used to determine the target node for a command. Scan and query are not affected by replica algorithm.

Note: The enum ordinals do not match the Aerospike Client ordinals because the default has to be ordinal zero in protobuf. 

const (
	// Try node containing master partition first.
	// If connection fails, all commands try nodes containing replicated partitions.
	// If socketTimeout is reached, reads also try nodes containing replicated partitions,
	// but writes remain on master node.
	Replica_SEQUENCE Replica = 0
	// Use node containing key's master partition.
	Replica_MASTER Replica = 1
	// Distribute reads across nodes containing key's master and replicated partitions
	// in round-robin fashion.  Writes always use node containing key's master partition.
	Replica_MASTER_PROLES Replica = 2
	// Try node on the same rack as the client first.  If timeout or there are no nodes on the
	// same rack, use SEQUENCE instead.
	Replica_PREFER_RACK Replica = 3
	// Distribute reads across all nodes in cluster in round-robin fashion.
	// Writes always use node containing key's master partition.
	// This option is useful when the replication factor equals the number
	// of nodes in the cluster and the overhead of requesting proles is not desired.
	Replica_RANDOM Replica = 4
)

func (Replica) Descriptor 

func (Replica) Descriptor() protoreflect.EnumDescriptor

func (Replica) Enum 

func (x Replica) Enum() *Replica

func (Replica) EnumDescriptor deprecated 

func (Replica) EnumDescriptor() ([]byte, []int)

Deprecated: Use Replica.Descriptor instead.

func (Replica) Number 

func (x Replica) Number() protoreflect.EnumNumber

func (Replica) String 

func (x Replica) String() string

func (Replica) Type 

func (Replica) Type() protoreflect.EnumType

type ScanClient 

type ScanClient interface {
	// Scan Aerospike
	Scan(ctx context.Context, in *AerospikeRequestPayload, opts ...grpc.CallOption) (Scan_ScanClient, error)
	// Process a stream of scan requests
	ScanStreaming(ctx context.Context, opts ...grpc.CallOption) (Scan_ScanStreamingClient, error)
}

ScanClient is the client API for Scan service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewScanClient 

func NewScanClient(cc grpc.ClientConnInterface) ScanClient

type ScanPolicy 

type ScanPolicy struct {

	// Read policy for AP (availability) namespaces.
	Replica Replica `protobuf:"varint,1,opt,name=replica,proto3,enum=Replica" json:"replica,omitempty"`
	// Read policy for SC (strong consistency) namespaces.
	ReadModeAP ReadModeAP `protobuf:"varint,2,opt,name=readModeAP,proto3,enum=ReadModeAP" json:"readModeAP,omitempty"`
	// Replica algorithm used to determine the target node
	// for a single record command.
	// Scan and scan are not affected by replica algorithms.
	ReadModeSC ReadModeSC `protobuf:"varint,3,opt,name=readModeSC,proto3,enum=ReadModeSC" json:"readModeSC,omitempty"`
	// Use zlib compression on command buffers sent to the server and responses received
	// from the server when the buffer size is greater than 128 bytes.
	// This option will increase cpu and memory usage (for extra compressed buffers),but
	// decrease the size of data sent over the network.
	Compress bool `protobuf:"varint,4,opt,name=compress,proto3" json:"compress,omitempty"`
	// Optional expression filter. If filterExp exists and evaluates to false, the
	// transaction is ignored.
	Expression []byte `protobuf:"bytes,5,opt,name=expression,proto3,oneof" json:"expression,omitempty"`
	// Total transaction timeout in milliseconds.
	// Default for all other commands: 1000ms
	TotalTimeout *uint32 `protobuf:"varint,6,opt,name=totalTimeout,proto3,oneof" json:"totalTimeout,omitempty"`
	// Approximate number of records to return to client. This number is divided by the
	// number of nodes involved in the scan.  The actual number of records returned
	// may be less than maxRecords if node record counts are small and unbalanced across
	// nodes.
	// Default: 0 (do not limit record count)
	MaxRecords *uint64 `protobuf:"varint,7,opt,name=maxRecords,proto3,oneof" json:"maxRecords,omitempty"`
	// Limit returned records per second (rps) rate for each server.
	// Do not apply rps limit if recordsPerSecond is zero.
	// Default: 0
	RecordsPerSecond *uint32 `protobuf:"varint,8,opt,name=recordsPerSecond,proto3,oneof" json:"recordsPerSecond,omitempty"`
	// Should scan requests be issued in parallel.
	// Default: true
	ConcurrentNodes *bool `protobuf:"varint,9,opt,name=concurrentNodes,proto3,oneof" json:"concurrentNodes,omitempty"`
	// Maximum number of concurrent requests to server nodes at any point in time.
	// If there are 16 nodes in the cluster and maxConcurrentNodes is 8, then queries
	// will be made to 8 nodes in parallel.  When a scan completes, a new scan will
	// be issued until all 16 nodes have been queried.
	// Default: 0 (issue requests to all server nodes in parallel)
	MaxConcurrentNodes *uint32 `protobuf:"varint,10,opt,name=maxConcurrentNodes,proto3,oneof" json:"maxConcurrentNodes,omitempty"`
	// Should bin data be retrieved. If false, only record digests (and user keys
	// if stored on the server) are retrieved.
	// Default: true
	IncludeBinData *bool `protobuf:"varint,11,opt,name=includeBinData,proto3,oneof" json:"includeBinData,omitempty"`
	// contains filtered or unexported fields
}

Scan policy attributes used by queries. Scan requests are send completely using proto buffers and hence include all policy attributes.

func (*ScanPolicy) Descriptor deprecated 

func (*ScanPolicy) Descriptor() ([]byte, []int)

Deprecated: Use ScanPolicy.ProtoReflect.Descriptor instead.

func (*ScanPolicy) GetCompress 

func (x *ScanPolicy) GetCompress() bool

func (*ScanPolicy) GetConcurrentNodes 

func (x *ScanPolicy) GetConcurrentNodes() bool

func (*ScanPolicy) GetExpression 

func (x *ScanPolicy) GetExpression() []byte

func (*ScanPolicy) GetIncludeBinData 

func (x *ScanPolicy) GetIncludeBinData() bool

func (*ScanPolicy) GetMaxConcurrentNodes 

func (x *ScanPolicy) GetMaxConcurrentNodes() uint32

func (*ScanPolicy) GetMaxRecords 

func (x *ScanPolicy) GetMaxRecords() uint64

func (*ScanPolicy) GetReadModeAP 

func (x *ScanPolicy) GetReadModeAP() ReadModeAP

func (*ScanPolicy) GetReadModeSC 

func (x *ScanPolicy) GetReadModeSC() ReadModeSC

func (*ScanPolicy) GetRecordsPerSecond 

func (x *ScanPolicy) GetRecordsPerSecond() uint32

func (*ScanPolicy) GetReplica 

func (x *ScanPolicy) GetReplica() Replica

func (*ScanPolicy) GetTotalTimeout 

func (x *ScanPolicy) GetTotalTimeout() uint32

func (*ScanPolicy) ProtoMessage 

func (*ScanPolicy) ProtoMessage()

func (*ScanPolicy) ProtoReflect 

func (x *ScanPolicy) ProtoReflect() protoreflect.Message

func (*ScanPolicy) Reset 

func (x *ScanPolicy) Reset()

func (*ScanPolicy) String 

func (x *ScanPolicy) String() string

type ScanRequest 

type ScanRequest struct {

	// Optional scan policy.
	ScanPolicy *ScanPolicy `protobuf:"bytes,1,opt,name=scanPolicy,proto3,oneof" json:"scanPolicy,omitempty"`
	// The namespace to scan.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Optional set name.
	SetName *string `protobuf:"bytes,3,opt,name=setName,proto3,oneof" json:"setName,omitempty"`
	// Optional bin to retrieve. All bins will be returned
	// if not specified.
	BinNames []string `protobuf:"bytes,4,rep,name=binNames,proto3" json:"binNames,omitempty"`
	// Optional partition filter to selectively scan partitions.
	PartitionFilter *PartitionFilter `protobuf:"bytes,5,opt,name=partitionFilter,proto3,oneof" json:"partitionFilter,omitempty"`
	// contains filtered or unexported fields
}

A scan request.

func (*ScanRequest) Descriptor deprecated 

func (*ScanRequest) Descriptor() ([]byte, []int)

Deprecated: Use ScanRequest.ProtoReflect.Descriptor instead.

func (*ScanRequest) GetBinNames 

func (x *ScanRequest) GetBinNames() []string

func (*ScanRequest) GetNamespace 

func (x *ScanRequest) GetNamespace() string

func (*ScanRequest) GetPartitionFilter 

func (x *ScanRequest) GetPartitionFilter() *PartitionFilter

func (*ScanRequest) GetScanPolicy 

func (x *ScanRequest) GetScanPolicy() *ScanPolicy

func (*ScanRequest) GetSetName 

func (x *ScanRequest) GetSetName() string

func (*ScanRequest) ProtoMessage 

func (*ScanRequest) ProtoMessage()

func (*ScanRequest) ProtoReflect 

func (x *ScanRequest) ProtoReflect() protoreflect.Message

func (*ScanRequest) Reset 

func (x *ScanRequest) Reset()

func (*ScanRequest) String 

func (x *ScanRequest) String() string

type ScanServer 

type ScanServer interface {
	// Scan Aerospike
	Scan(*AerospikeRequestPayload, Scan_ScanServer) error
	// Process a stream of scan requests
	ScanStreaming(Scan_ScanStreamingServer) error
	// contains filtered or unexported methods
}

ScanServer is the server API for Scan service. All implementations must embed UnimplementedScanServer for forward compatibility

type Scan_ScanClient 

type Scan_ScanClient interface {
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type Scan_ScanServer 

type Scan_ScanServer interface {
	Send(*AerospikeResponsePayload) error
	grpc.ServerStream
}

type Scan_ScanStreamingClient 

type Scan_ScanStreamingClient interface {
	Send(*AerospikeRequestPayload) error
	Recv() (*AerospikeResponsePayload, error)
	grpc.ClientStream
}

type Scan_ScanStreamingServer 

type Scan_ScanStreamingServer interface {
	Send(*AerospikeResponsePayload) error
	Recv() (*AerospikeRequestPayload, error)
	grpc.ServerStream
}

type Statement 

type Statement struct {

	// The namespace to query.
	Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Optional set name.
	SetName *string `protobuf:"bytes,2,opt,name=setName,proto3,oneof" json:"setName,omitempty"`
	// Optional index name.
	IndexName *string `protobuf:"bytes,3,opt,name=indexName,proto3,oneof" json:"indexName,omitempty"`
	// Optional bins names to return for each result record.
	// If not specified all bins are returned.
	BinNames []string `protobuf:"bytes,4,rep,name=binNames,proto3" json:"binNames,omitempty"`
	// Optional Filter encoded in Aerospike wire format.
	Filter *Filter `protobuf:"bytes,5,opt,name=filter,proto3,oneof" json:"filter,omitempty"`
	// Aggregation file name.
	PackageName string `protobuf:"bytes,6,opt,name=packageName,proto3" json:"packageName,omitempty"`
	// Aggregation function name.
	FunctionName string `protobuf:"bytes,7,opt,name=functionName,proto3" json:"functionName,omitempty"`
	// Aggregation function arguments encoded as bytes using Aerospike wire format.
	FunctionArgs [][]byte `protobuf:"bytes,8,rep,name=functionArgs,proto3" json:"functionArgs,omitempty"`
	// Operations to be performed on query encoded as bytes using Aerospike wire format.
	Operations []*Operation `protobuf:"bytes,9,rep,name=operations,proto3" json:"operations,omitempty"`
	// Optional taskId.
	TaskId *int64 `protobuf:"varint,10,opt,name=taskId,proto3,oneof" json:"taskId,omitempty"`
	// Approximate number of records to return to client. This number is divided by the
	// number of nodes involved in the scan.  The actual number of records returned
	// may be less than maxRecords if node record counts are small and unbalanced across
	// nodes.
	// Default: 0 (do not limit record count)
	MaxRecords *uint64 `protobuf:"varint,11,opt,name=maxRecords,proto3,oneof" json:"maxRecords,omitempty"`
	// Limit returned records per second (rps) rate for each server.
	// Do not apply rps limit if recordsPerSecond is zero.
	// Default: 0
	RecordsPerSecond *uint32 `protobuf:"varint,12,opt,name=recordsPerSecond,proto3,oneof" json:"recordsPerSecond,omitempty"`
	// contains filtered or unexported fields
}

Query statement.

func (*Statement) Descriptor deprecated 

func (*Statement) Descriptor() ([]byte, []int)

Deprecated: Use Statement.ProtoReflect.Descriptor instead.

func (*Statement) GetBinNames 

func (x *Statement) GetBinNames() []string

func (*Statement) GetFilter 

func (x *Statement) GetFilter() *Filter

func (*Statement) GetFunctionArgs 

func (x *Statement) GetFunctionArgs() [][]byte

func (*Statement) GetFunctionName 

func (x *Statement) GetFunctionName() string

func (*Statement) GetIndexName 

func (x *Statement) GetIndexName() string

func (*Statement) GetMaxRecords 

func (x *Statement) GetMaxRecords() uint64

func (*Statement) GetNamespace 

func (x *Statement) GetNamespace() string

func (*Statement) GetOperations 

func (x *Statement) GetOperations() []*Operation

func (*Statement) GetPackageName 

func (x *Statement) GetPackageName() string

func (*Statement) GetRecordsPerSecond 

func (x *Statement) GetRecordsPerSecond() uint32

func (*Statement) GetSetName 

func (x *Statement) GetSetName() string

func (*Statement) GetTaskId 

func (x *Statement) GetTaskId() int64

func (*Statement) ProtoMessage 

func (*Statement) ProtoMessage()

func (*Statement) ProtoReflect 

func (x *Statement) ProtoReflect() protoreflect.Message

func (*Statement) Reset 

func (x *Statement) Reset()

func (*Statement) String 

func (x *Statement) String() string

type UnimplementedAboutServer 

type UnimplementedAboutServer struct {
}

UnimplementedAboutServer must be embedded to have forward compatible implementations.

func (UnimplementedAboutServer) Get 

func (UnimplementedAboutServer) Get(context.Context, *AboutRequest) (*AboutResponse, error)

type UnimplementedKVSServer 

type UnimplementedKVSServer struct {
}

UnimplementedKVSServer must be embedded to have forward compatible implementations.

func (UnimplementedKVSServer) BatchOperate 

func (UnimplementedKVSServer) BatchOperate(*AerospikeRequestPayload, KVS_BatchOperateServer) error

func (UnimplementedKVSServer) BatchOperateStreaming 

func (UnimplementedKVSServer) BatchOperateStreaming(KVS_BatchOperateStreamingServer) error

func (UnimplementedKVSServer) Delete 

func (UnimplementedKVSServer) Delete(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)

func (UnimplementedKVSServer) DeleteStreaming 

func (UnimplementedKVSServer) DeleteStreaming(KVS_DeleteStreamingServer) error

func (UnimplementedKVSServer) Execute 

func (UnimplementedKVSServer) Execute(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)

func (UnimplementedKVSServer) ExecuteStreaming 

func (UnimplementedKVSServer) ExecuteStreaming(KVS_ExecuteStreamingServer) error

func (UnimplementedKVSServer) Exists 

func (UnimplementedKVSServer) Exists(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)

func (UnimplementedKVSServer) ExistsStreaming 

func (UnimplementedKVSServer) ExistsStreaming(KVS_ExistsStreamingServer) error

func (UnimplementedKVSServer) GetHeader 

func (UnimplementedKVSServer) GetHeader(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)

func (UnimplementedKVSServer) GetHeaderStreaming 

func (UnimplementedKVSServer) GetHeaderStreaming(KVS_GetHeaderStreamingServer) error

func (UnimplementedKVSServer) Operate 

func (UnimplementedKVSServer) Operate(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)

func (UnimplementedKVSServer) OperateStreaming 

func (UnimplementedKVSServer) OperateStreaming(KVS_OperateStreamingServer) error

func (UnimplementedKVSServer) Read 

func (UnimplementedKVSServer) Read(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)

func (UnimplementedKVSServer) ReadStreaming 

func (UnimplementedKVSServer) ReadStreaming(KVS_ReadStreamingServer) error

func (UnimplementedKVSServer) Touch 

func (UnimplementedKVSServer) Touch(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)

func (UnimplementedKVSServer) TouchStreaming 

func (UnimplementedKVSServer) TouchStreaming(KVS_TouchStreamingServer) error

func (UnimplementedKVSServer) Write 

func (UnimplementedKVSServer) Write(context.Context, *AerospikeRequestPayload) (*AerospikeResponsePayload, error)

func (UnimplementedKVSServer) WriteStreaming 

func (UnimplementedKVSServer) WriteStreaming(KVS_WriteStreamingServer) error

type UnimplementedQueryServer 

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer must be embedded to have forward compatible implementations.

func (UnimplementedQueryServer) BackgroundExecute 

func (UnimplementedQueryServer) BackgroundExecute(*AerospikeRequestPayload, Query_BackgroundExecuteServer) error

func (UnimplementedQueryServer) BackgroundExecuteStreaming 

func (UnimplementedQueryServer) BackgroundExecuteStreaming(Query_BackgroundExecuteStreamingServer) error

func (UnimplementedQueryServer) BackgroundTaskStatus 

func (UnimplementedQueryServer) BackgroundTaskStatus(*AerospikeRequestPayload, Query_BackgroundTaskStatusServer) error

func (UnimplementedQueryServer) BackgroundTaskStatusStreaming 

func (UnimplementedQueryServer) BackgroundTaskStatusStreaming(Query_BackgroundTaskStatusStreamingServer) error

func (UnimplementedQueryServer) Query 

func (UnimplementedQueryServer) Query(*AerospikeRequestPayload, Query_QueryServer) error

func (UnimplementedQueryServer) QueryStreaming 

func (UnimplementedQueryServer) QueryStreaming(Query_QueryStreamingServer) error

type UnimplementedScanServer 

type UnimplementedScanServer struct {
}

UnimplementedScanServer must be embedded to have forward compatible implementations.

func (UnimplementedScanServer) Scan 

func (UnimplementedScanServer) Scan(*AerospikeRequestPayload, Scan_ScanServer) error

func (UnimplementedScanServer) ScanStreaming 

func (UnimplementedScanServer) ScanStreaming(Scan_ScanStreamingServer) error

type UnsafeAboutServer 

type UnsafeAboutServer interface {
	// contains filtered or unexported methods
}

UnsafeAboutServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AboutServer will result in compilation errors.

type UnsafeKVSServer 

type UnsafeKVSServer interface {
	// contains filtered or unexported methods
}

UnsafeKVSServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to KVSServer will result in compilation errors.

type UnsafeQueryServer 

type UnsafeQueryServer interface {
	// contains filtered or unexported methods
}

UnsafeQueryServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QueryServer will result in compilation errors.

type UnsafeScanServer 

type UnsafeScanServer interface {
	// contains filtered or unexported methods
}

UnsafeScanServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ScanServer will result in compilation errors.

type WritePolicy 

type WritePolicy struct {

	// Read policy for AP (availability) namespaces.
	Replica Replica `protobuf:"varint,1,opt,name=replica,proto3,enum=Replica" json:"replica,omitempty"`
	// Read policy for SC (strong consistency) namespaces.
	ReadModeAP ReadModeAP `protobuf:"varint,2,opt,name=readModeAP,proto3,enum=ReadModeAP" json:"readModeAP,omitempty"`
	// Replica algorithm used to determine the target node
	// for a single record command.
	// Scan and query are not affected by replica algorithms.
	ReadModeSC ReadModeSC `protobuf:"varint,3,opt,name=readModeSC,proto3,enum=ReadModeSC" json:"readModeSC,omitempty"`
	// contains filtered or unexported fields
}

Write policy attributes used in write database commands that are not part of the wire protocol.

func (*WritePolicy) Descriptor deprecated 

func (*WritePolicy) Descriptor() ([]byte, []int)

Deprecated: Use WritePolicy.ProtoReflect.Descriptor instead.

func (*WritePolicy) GetReadModeAP 

func (x *WritePolicy) GetReadModeAP() ReadModeAP

func (*WritePolicy) GetReadModeSC 

func (x *WritePolicy) GetReadModeSC() ReadModeSC

func (*WritePolicy) GetReplica 

func (x *WritePolicy) GetReplica() Replica

func (*WritePolicy) ProtoMessage 

func (*WritePolicy) ProtoMessage()

func (*WritePolicy) ProtoReflect 

func (x *WritePolicy) ProtoReflect() protoreflect.Message

func (*WritePolicy) Reset 

func (x *WritePolicy) Reset()

func (*WritePolicy) String 

func (x *WritePolicy) String() string

Source Files

View all Source files

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.