Versions in this module Expand all Collapse all v0 v0.10.2 Sep 23, 2026 v0.10.1 Sep 22, 2026 Changes in this version + func DeleteResultsError(results []DeleteResult) error + func ReadResultsError(results []ReadResult) error + func WriteResultsError(results []WriteResult) error + type Address struct + func NewAddress(value string) (Address, error) + func NewRecordAddress(resource string, key Key) (Address, error) + func (a Address) Store() string + func (a Address) URI() string + type BatchError struct + Failures []*OperationError + func (e *BatchError) Error() string + func (e *BatchError) Unwrap() []error + type Client struct + func Dial(target string, opts DialOptions) (*Client, error) + func New(connection grpc.ClientConnInterface, opts ClientOptions) (*Client, error) + func (c *Client) CheckHealth(ctx context.Context) error + func (c *Client) Close() error + func (c *Client) Count(ctx context.Context, req CountRequest) (CountResponse, error) + func (c *Client) Delete(ctx context.Context, req DeleteRequest) ([]DeleteResult, error) + func (c *Client) Execute(ctx context.Context, req ExecuteRequest) (ExecuteResponse, error) + func (c *Client) Query(ctx context.Context, req QueryRequest) (QueryResponse, error) + func (c *Client) Raw() sinkv1.SinkClient + func (c *Client) Read(ctx context.Context, req ReadRequest) ([]ReadResult, error) + func (c *Client) Scan(ctx context.Context, req ScanRequest) (ScanResponse, error) + func (c *Client) Write(ctx context.Context, req WriteRequest) ([]WriteResult, error) + type ClientOptions struct + MaxOperations int + MaxReceiveMessageBytes int + MaxSendMessageBytes int + ReadRetry RetryPolicy + ScanRetry RetryPolicy + ScanTimeout time.Duration + type Command struct + ContentType string + Headers http.Header + Method string + Path string + Payload []byte + Query string + URI string + func NewBSONCommand(target string, value any) (Command, error) + type CompletionMode = sinkv1.CompletionMode + const CompletionReturnAfterAccepted + const CompletionWaitUntilApplied + const CompletionWaitUntilVisible + type CountRequest struct + Command Command + type CountResponse struct + Count uint64 + Estimated bool + type Dataset struct + func NewDataset(client *Client, opts DatasetOptions) (*Dataset, error) + func (d *Dataset) Count(ctx context.Context, req CountRequest) (CountResponse, error) + func (d *Dataset) Create(ctx context.Context, req DatasetWriteRequest) ([]WriteResult, error) + func (d *Dataset) Execute(ctx context.Context, req ExecuteRequest) (ExecuteResponse, error) + func (d *Dataset) Merge(ctx context.Context, req DatasetWriteRequest) ([]WriteResult, error) + func (d *Dataset) NewBSONCommand(operation string, arguments bson.D) (Command, error) + func (d *Dataset) Query(ctx context.Context, req QueryRequest) (QueryResponse, error) + func (d *Dataset) Read(ctx context.Context, req DatasetReadRequest) ([]ReadResult, error) + func (d *Dataset) Replace(ctx context.Context, req DatasetWriteRequest) ([]WriteResult, error) + func (d *Dataset) Scan(ctx context.Context, req ScanRequest) (ScanResponse, error) + func (d *Dataset) Upsert(ctx context.Context, req DatasetWriteRequest) ([]WriteResult, error) + type DatasetOptions struct + Encoding DocumentEncoding + MergeProgram *LuaProgram + URI string + type DatasetReadRequest struct + Keys []Key + OnResult ReadCallback + func NewDatasetReadRequest(keys ...Key) DatasetReadRequest + func (r DatasetReadRequest) WithOnResult(callback ReadCallback) DatasetReadRequest + type DatasetWriteRequest struct + CompletionMode CompletionMode + OnResult WriteCallback + Records []Record + func NewDatasetWriteRequest(records ...Record) DatasetWriteRequest + func (r DatasetWriteRequest) WithCompletionMode(mode CompletionMode) DatasetWriteRequest + func (r DatasetWriteRequest) WithOnResult(callback WriteCallback) DatasetWriteRequest + type DeleteRequest struct + Addresses []Address + CompletionMode CompletionMode + func NewDeleteRequest(addresses ...Address) DeleteRequest + func (r DeleteRequest) WithCompletionMode(mode CompletionMode) DeleteRequest + type DeleteResult struct + Failure *OperationError + OperationIndex int + Status DeleteStatus + func (r DeleteResult) Err() error + type DeleteStatus = sinkv1.DeleteStatus + const DeleteAccepted + const DeleteApplied + const DeleteFailed + type DialOptions struct + Client ClientOptions + DNSRefreshInterval time.Duration + GRPCOptions []grpc.DialOption + TransportCredentials credentials.TransportCredentials + type Document struct + func NewDocument(value any, encoding DocumentEncoding) (Document, error) + func NewRawDocument(encoding DocumentEncoding, payload []byte) (Document, error) + func (d Document) Decode(destination any) error + func (d Document) Encoding() DocumentEncoding + func (d Document) Payload() []byte + type DocumentCallback func(Document) error + type DocumentEncoding = sinkv1.DocumentEncoding + const DocumentEncodingBSON + const DocumentEncodingJSON + type ExecuteRequest struct + Command Command + type ExecuteResponse struct + ContentType string + Headers http.Header + Payload []byte + StatusCode int + Success bool + func (r ExecuteResponse) Decode(destination any) error + type FailureCode = sinkv1.FailureCode + const FailureConflict + const FailureDeadlineExceeded + const FailureInternal + const FailureInvalidArgument + const FailureNotFound + const FailurePreconditionFailed + const FailureResourceExhausted + const FailureUnavailable + type Key struct + func BytesKey(value []byte) Key + func Int64Key(value int64) Key + func OpaqueKey(typeName string, value []byte) (Key, error) + func StringKey(value string) Key + type LuaProgram struct + func NewLuaProgram(source []byte) (LuaProgram, error) + func (p LuaProgram) SHA256() []byte + func (p LuaProgram) Source() []byte + type MergeOptions struct + Incoming Document + Program LuaProgram + type NativeError struct + Response ExecuteResponse + func (e *NativeError) Error() string + type OperationError struct + Code FailureCode + Message string + OperationIndex int + Retryable bool + func (e *OperationError) Error() string + type Projection struct + Exclude bool + Fields []string + type ProtocolError struct + Message string + Method string + func (e *ProtocolError) Error() string + type QueryRequest struct + Command Command + OnDocument DocumentCallback + Page int + PageSize int + Projection *Projection + Sort []SortField + func NewQueryRequest() QueryRequest + func (r QueryRequest) WithCommand(command Command) QueryRequest + func (r QueryRequest) WithOnDocument(callback DocumentCallback) QueryRequest + func (r QueryRequest) WithPage(page int) QueryRequest + func (r QueryRequest) WithPageSize(size int) QueryRequest + func (r QueryRequest) WithProjection(projection *Projection) QueryRequest + func (r QueryRequest) WithSort(fields ...SortField) QueryRequest + type QueryResponse struct + Documents []Document + HasMore bool + type ReadCallback func(ReadResult) error + type ReadRequest struct + Addresses []Address + OnResult ReadCallback + func NewReadRequest(addresses ...Address) ReadRequest + func (r ReadRequest) WithOnResult(callback ReadCallback) ReadRequest + type ReadResult struct + Document Document + Failure *OperationError + OperationIndex int + Status ReadStatus + func (r ReadResult) Err() error + type ReadStatus = sinkv1.ReadStatus + const ReadFailed + const ReadFound + const ReadNotFound + type Record struct + Key Key + ReturnDocument bool + Value any + type RetryPolicy struct + InitialBackoff time.Duration + Jitter float64 + MaxAttempts int + MaxBackoff time.Duration + Multiplier float64 + type ScanRequest struct + BatchSize int + Command Command + Cursor []byte + OnDocument DocumentCallback + Projection *Projection + func NewScanRequest() ScanRequest + func (r ScanRequest) WithBatchSize(size int) ScanRequest + func (r ScanRequest) WithCommand(command Command) ScanRequest + func (r ScanRequest) WithCursor(cursor []byte) ScanRequest + func (r ScanRequest) WithOnDocument(callback DocumentCallback) ScanRequest + func (r ScanRequest) WithProjection(projection *Projection) ScanRequest + type ScanResponse struct + Documents []Document + NextCursor []byte + type SortField struct + Descending bool + Field string + type WriteCallback func(WriteResult) error + type WriteMode = sinkv1.WriteMode + const WriteCreate + const WriteReplace + const WriteUpsert + type WriteOperation struct + func NewMerge(address Address, opts MergeOptions) (WriteOperation, error) + func NewPut(address Address, document Document, mode WriteMode) (WriteOperation, error) + func (o WriteOperation) WithReturnedDocument() WriteOperation + type WriteRequest struct + CompletionMode CompletionMode + OnResult WriteCallback + Operations []WriteOperation + func NewWriteRequest(operations ...WriteOperation) WriteRequest + func (r WriteRequest) WithCompletionMode(mode CompletionMode) WriteRequest + func (r WriteRequest) WithOnResult(callback WriteCallback) WriteRequest + type WriteResult struct + Document Document + Failure *OperationError + OperationIndex int + Status WriteStatus + func (r WriteResult) Err() error + type WriteStatus = sinkv1.WriteStatus + const WriteAccepted + const WriteApplied + const WriteFailed + const WritePreconditionFailed
Go to main page