dataapi

package

v1.24.3 Latest Latest Go to latest Published: Apr 25, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Package dataapi provides a Data API wrapper, which allows DocDB to be used over HTTP instead of MongoDB wire protocol.

This section is empty.

This section is empty.

This section is empty.

type ListenOpts struct {
	L       *slog.Logger
	M       *middleware.Middleware
	TCPAddr string
	Auth    bool
}

ListenOpts represents Listen options.

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

Listener represents Data API TCP listener and HTTP handler.

func Listen(opts *ListenOpts) (*Listener, error)

Listen creates a new Data API handler and starts listener on the given TCP address. Listener.Run must be called on the returned value.

func (lis *Listener) Addr() net.Addr

Addr returns TCP listener's address. It can be used to determine an actually used port, if it was zero.

func (lis *Listener) Collect(ch chan<- prometheus.Metric)

func (lis *Listener) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

func (lis *Listener) Run(ctx context.Context)

Run runs Data API handler until ctx is canceled.

It exits when handler is stopped and listener closed.

Path	Synopsis
api Package api provides primitives to interact with the openapi HTTP API.	Package api provides primitives to interact with the openapi HTTP API.
server Package server provides a Data API server handlers.	Package server provides a Data API server handlers.