cosmosdb

Documentation

Index

• Constants
• type Document
• type Driver
  • func (d *Driver) Open(ctx context.Context, kvParams kvparams.Config) (kv.Store, error)
• type EntriesIterator
  • func (e *EntriesIterator) Close()
  • func (e *EntriesIterator) Entry() *kv.Entry
  • func (e *EntriesIterator) Err() error
  • func (e *EntriesIterator) Next() bool
  • func (e *EntriesIterator) SeekGE(key []byte)
• type Store
  • func (s *Store) Close()
  • func (s *Store) Delete(ctx context.Context, partitionKey, key []byte) error
  • func (s *Store) Get(ctx context.Context, partitionKey, key []byte) (*kv.ValueWithPredicate, error)
  • func (s *Store) Scan(ctx context.Context, partitionKey []byte, options kv.ScanOptions) (kv.EntriesIterator, error)
  • func (s *Store) Set(ctx context.Context, partitionKey, key, value []byte) error
  • func (s *Store) SetIf(ctx context.Context, partitionKey, key, value []byte, ...) error

Constants

const (
	DriverName = "cosmosdb"
)

Types

type Document

type Document struct {
	PartitionKey string `json:"partitionKey"`
	// ID is the hash of the key. It is used as the document id for lookup of a single item.
	// CosmosDB has a 1023 byte limit on the id, so we hash the key to ensure it fits.
	ID string `json:"id"`
	// Key is the original key. It is not used listing of items by order.
	Key   string `json:"key"`
	Value string `json:"value"`
}

type Driver

type Driver struct{}

func (*Driver) Open

func (d *Driver) Open(ctx context.Context, kvParams kvparams.Config) (kv.Store, error)

Open - opens and returns a KV store over CosmosDB. This function creates the DB session and sets up the KV table.

type EntriesIterator

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

func (*EntriesIterator) Close

func (e *EntriesIterator) Close()

func (*EntriesIterator) Entry

func (e *EntriesIterator) Entry() *kv.Entry

func (*EntriesIterator) Err

func (e *EntriesIterator) Err() error

func (*EntriesIterator) Next

func (e *EntriesIterator) Next() bool

func (*EntriesIterator) SeekGE

func (e *EntriesIterator) SeekGE(key []byte)

type Store

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

func (*Store) Close

func (s *Store) Close()

func (*Store) Delete

func (s *Store) Delete(ctx context.Context, partitionKey, key []byte) error

func (*Store) Get

func (s *Store) Get(ctx context.Context, partitionKey, key []byte) (*kv.ValueWithPredicate, error)

func (*Store) Scan

func (s *Store) Scan(ctx context.Context, partitionKey []byte, options kv.ScanOptions) (kv.EntriesIterator, error)

func (*Store) Set

func (s *Store) Set(ctx context.Context, partitionKey, key, value []byte) error

func (*Store) SetIf

func (s *Store) SetIf(ctx context.Context, partitionKey, key, value []byte, valuePredicate kv.Predicate) error