azcosmoscx

package module
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Feb 9, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func EnableTracing

func EnableTracing()

EnableTracing enables Cosmos Client Engine tracing. Once enabled, tracing cannot be disabled (for now). Tracing is controlled by setting the COSMOSCX_LOG environment variable, using the syntax of the `RUST_LOG` (https://docs.rs/env_logger/latest/env_logger/#enabling-logging) env var.

func NewQueryEngine

func NewQueryEngine() queryengine.QueryEngine

NewQueryEngine creates a new azcosmoscx query engine.

func Version

func Version() string

Types

type DataRequest

type DataRequest C.CosmosCxDataRequest

func (*DataRequest) Continuation

func (r *DataRequest) Continuation() EngineString

func (*DataRequest) Id added in v0.3.0

func (r *DataRequest) Id() uint64

func (*DataRequest) IncludeParameters added in v0.3.0

func (r *DataRequest) IncludeParameters() bool

func (*DataRequest) PartitionKeyRangeID

func (r *DataRequest) PartitionKeyRangeID() EngineString

func (*DataRequest) Query added in v0.3.0

func (r *DataRequest) Query() EngineString

type EngineString

type EngineString C.CosmosCxOwnedString

func (EngineString) BorrowBytes

func (e EngineString) BorrowBytes() []byte

BorrowBytes returns a "borrowed" copy of the string as a Go slice of bytes. The string returned here will become invalid when the PipelineResult that owned this is freed. Use Clone to create a copy of the string in Go memory

func (EngineString) BorrowString

func (e EngineString) BorrowString() string

BorrowString returns a "borrowed" copy of the string, as a Go String. The string returned here will become invalid when the PipelineResult that owned this is freed. Use Clone to create a copy of the string in Go memory

func (EngineString) CloneBytes

func (e EngineString) CloneBytes() []byte

CloneBytes creates a brand-new slice of bytes, in Go-managed memory, containing the same data as the original string.

func (EngineString) CloneString

func (e EngineString) CloneString() string

CloneString creates a brand-new Go string, in Go-managed memory, containing the same data as the original string.

type Error

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

func (*Error) Code

func (e *Error) Code() uint

func (*Error) Error

func (e *Error) Error() string

type Pipeline

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

func (*Pipeline) Free

func (p *Pipeline) Free()

Free disposes of the native resources held by the pipeline. This should always be called when you're finished working with the pipeline.

func (*Pipeline) IsFreed

func (p *Pipeline) IsFreed() bool

IsFreed returns a boolean indicating whether the pipeline has been freed.

func (*Pipeline) NextBatch

func (p *Pipeline) NextBatch() (*PipelineResult, error)

func (*Pipeline) ProvideData

func (p *Pipeline) ProvideData(results []queryengine.QueryResult) error

func (*Pipeline) Query

func (p *Pipeline) Query() (string, error)

Query gets the, possibly rewritten, query that should be used when issuing queries to satisfy DataRequests.

type PipelineResult

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

func (*PipelineResult) Free

func (r *PipelineResult) Free()

func (*PipelineResult) IsCompleted

func (r *PipelineResult) IsCompleted() bool

func (*PipelineResult) Items

func (r *PipelineResult) Items() ([]EngineString, error)

func (*PipelineResult) ItemsCloned

func (r *PipelineResult) ItemsCloned() ([][]byte, error)

func (*PipelineResult) Requests

func (r *PipelineResult) Requests() ([]DataRequest, error)

Jump to

Keyboard shortcuts

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