dynamo

package module

Go to main page

Versions in this module

v2

v2.3.0

Dec 17, 2024

v2.2.1

Aug 29, 2024

v2.2.0

Aug 26, 2024

Changes in this version

+ func UnmarshalItemFromCondCheckFailed(condCheckErr error, out any) (match bool, err error)

+ func UnmarshalItemsFromTxCondCheckFailed(txCancelErr error, out any) (match bool, err error)

type ConditionCheck

+ func (check *ConditionCheck) IncludeItemInCondCheckFail(enabled bool) *ConditionCheck

type Delete

+ func (d *Delete) CurrentValue(ctx context.Context, out interface{}) (wrote bool, err error)

+ func (d *Delete) IncludeItemInCondCheckFail(enabled bool) *Delete

type Put

+ func (p *Put) CurrentValue(ctx context.Context, out interface{}) (wrote bool, err error)

+ func (p *Put) IncludeItemInCondCheckFail(enabled bool) *Put

type Update

+ func (u *Update) CurrentValue(ctx context.Context, out interface{}) (wrote bool, err error)

+ func (u *Update) IncludeItemInCondCheckFail(enabled bool) *Update

type WriteTx

+ func (tx *WriteTx) IncludeAllItemsInCondCheckFail(enabled bool) *WriteTx

v2.1.1

Jul 20, 2024

v2.1.0

Jul 16, 2024

Changes in this version

type ConsumedCapacity

+ Requests int

v2.0.2

Jul 3, 2024

v2.0.1

Jun 30, 2024

v2.0.0

Jun 15, 2024

Changes in this version

+ var AllProjection = IndexProjection(types.ProjectionTypeAll)

+ var ErrNoInput = errors.New("dynamo: no input items")

+ var ErrNotFound = errors.New("dynamo: no item found")

+ var ErrTooMany = errors.New("dynamo: too many items")

+ var IncludeProjection = IndexProjection(types.ProjectionTypeInclude)

+ var KeysOnlyProjection = IndexProjection(types.ProjectionTypeKeysOnly)

+ var KeysOnlyView = StreamView(types.StreamViewTypeKeysOnly)

+ var NewAndOldImagesView = StreamView(types.StreamViewTypeNewAndOldImages)

+ var NewImageView = StreamView(types.StreamViewTypeNewImage)

+ var OldImageView = StreamView(types.StreamViewTypeOldImage)

+ func IsCondCheckFailed(err error) bool

+ func Marshal(v interface{}) (types.AttributeValue, error)

+ func RetryTxConflicts(opts *retry.StandardOptions)

+ func Unmarshal(av types.AttributeValue, out interface{}) error

+ func UnmarshalItem(item Item, out interface{}) error

+ type Batch struct

+ func (b Batch) Get(keys ...Keyed) *BatchGet

+ func (b Batch) Write() *BatchWrite

+ type BatchGet struct

+ func (bg *BatchGet) All(ctx context.Context, out interface{}) error

+ func (bg *BatchGet) And(keys ...Keyed) *BatchGet

+ func (bg *BatchGet) Consistent(on bool) *BatchGet

+ func (bg *BatchGet) ConsumedCapacity(cc *ConsumedCapacity) *BatchGet

+ func (bg *BatchGet) From(table Table, hashKey string, keys ...Keyed) *BatchGet

+ func (bg *BatchGet) FromRange(table Table, hashKey, rangeKey string, keys ...Keyed) *BatchGet

+ func (bg *BatchGet) Iter() Iter

+ func (bg *BatchGet) IterWithTable(tablePtr *string) Iter

+ func (bg *BatchGet) Merge(srcs ...*BatchGet) *BatchGet

+ func (bg *BatchGet) Project(paths ...string) *BatchGet

+ func (bg *BatchGet) ProjectTable(table Table, paths ...string) *BatchGet

+ type BatchWrite struct

+ func (bw *BatchWrite) ConsumedCapacity(cc *ConsumedCapacity) *BatchWrite

+ func (bw *BatchWrite) Delete(keys ...Keyed) *BatchWrite

+ func (bw *BatchWrite) DeleteIn(table Table, hashKey string, keys ...Keyed) *BatchWrite

+ func (bw *BatchWrite) DeleteInRange(table Table, hashKey, rangeKey string, keys ...Keyed) *BatchWrite

+ func (bw *BatchWrite) Merge(srcs ...*BatchWrite) *BatchWrite

+ func (bw *BatchWrite) Put(items ...interface{}) *BatchWrite

+ func (bw *BatchWrite) PutIn(table Table, items ...interface{}) *BatchWrite

+ func (bw *BatchWrite) Run(ctx context.Context) (wrote int, err error)

+ type Coder interface

+ func AWSEncoding(v interface{}) Coder

+ type ConditionCheck struct

+ func (check *ConditionCheck) If(expr string, args ...interface{}) *ConditionCheck

+ func (check *ConditionCheck) IfExists() *ConditionCheck

+ func (check *ConditionCheck) IfNotExists() *ConditionCheck

+ func (check *ConditionCheck) Range(rangeKey string, value interface{}) *ConditionCheck

+ type ConsumedCapacity struct

+ GSI map[string]float64

+ GSIRead map[string]float64

+ GSIWrite map[string]float64

+ LSI map[string]float64

+ LSIRead map[string]float64

+ LSIWrite map[string]float64

+ Read float64

+ Table float64

+ TableName string

+ TableRead float64

+ TableWrite float64

+ Total float64

+ Write float64

+ type CreateTable struct

+ func (ct *CreateTable) Index(index Index) *CreateTable

+ func (ct *CreateTable) OnDemand(enabled bool) *CreateTable

+ func (ct *CreateTable) Project(index string, projection IndexProjection, includeAttribs ...string) *CreateTable

+ func (ct *CreateTable) Provision(readUnits, writeUnits int64) *CreateTable

+ func (ct *CreateTable) ProvisionIndex(index string, readUnits, writeUnits int64) *CreateTable

+ func (ct *CreateTable) Run(ctx context.Context) error

+ func (ct *CreateTable) SSEEncryption(enabled bool, keyID string, sseType SSEType) *CreateTable

+ func (ct *CreateTable) Stream(view StreamView) *CreateTable

+ func (ct *CreateTable) Tag(key, value string) *CreateTable

+ func (ct *CreateTable) Wait(ctx context.Context) error

+ type DB struct

+ func New(cfg aws.Config, options ...func(*dynamodb.Options)) *DB

+ func NewFromIface(client dynamodbiface.DynamoDBAPI) *DB

+ func (db *DB) Client() dynamodbiface.DynamoDBAPI

+ func (db *DB) CreateTable(name string, from interface{}) *CreateTable

+ func (db *DB) GetTx() *GetTx

+ func (db *DB) ListTables() *ListTables

+ func (db *DB) Table(name string) Table

+ func (db *DB) WriteTx() *WriteTx

+ type Delete struct

+ func (d *Delete) ConsumedCapacity(cc *ConsumedCapacity) *Delete

+ func (d *Delete) If(expr string, args ...interface{}) *Delete

+ func (d *Delete) OldValue(ctx context.Context, out interface{}) error

+ func (d *Delete) Range(name string, value interface{}) *Delete

+ func (d *Delete) Run(ctx context.Context) error

+ type DeleteTable struct

+ func (dt *DeleteTable) Run(ctx context.Context) error

+ func (dt *DeleteTable) Wait(ctx context.Context) error

+ type DescribeTTL struct

+ func (d *DescribeTTL) Run(ctx context.Context) (TTLDescription, error)

+ type DescribeTable struct

+ func (dt *DescribeTable) Run(ctx context.Context) (Description, error)

+ type Description struct

+ ARN string

+ Created time.Time

+ GSI []Index

+ HashKey string

+ HashKeyType KeyType

+ Items int64

+ LSI []Index

+ LatestStreamARN string

+ LatestStreamLabel string

+ Name string

+ OnDemand bool

+ RangeKey string

+ RangeKeyType KeyType

+ SSEDescription SSEDescription

+ Size int64

+ Status Status

+ StreamEnabled bool

+ StreamView StreamView

+ Throughput Throughput

+ func (d Description) Active() bool

+ type ExpressionLiteral struct

+ AttributeNames map[string]*string

+ AttributeValues Item

+ Expression string

+ type GetTx struct

+ func (tx *GetTx) All(ctx context.Context, out interface{}) error

+ func (tx *GetTx) ConsumedCapacity(cc *ConsumedCapacity) *GetTx

+ func (tx *GetTx) Get(q *Query) *GetTx

+ func (tx *GetTx) GetOne(q *Query, out interface{}) *GetTx

+ func (tx *GetTx) Run(ctx context.Context) error

+ type Index struct

+ ARN string

+ Backfilling bool

+ HashKey string

+ HashKeyType KeyType

+ Items int64

+ Local bool

+ Name string

+ ProjectionAttribs []string

+ ProjectionType IndexProjection

+ RangeKey string

+ RangeKeyType KeyType

+ Size int64

+ Status Status

+ Throughput Throughput

+ type IndexProjection string

+ type Item = map[string]types.AttributeValue

+ func MarshalItem(v interface{}) (Item, error)

+ type ItemMarshaler interface

+ MarshalDynamoItem func() (Item, error)

+ type ItemUnmarshaler interface

+ UnmarshalDynamoItem func(item Item) error

+ type Iter interface

+ Err func() error

+ Next func(ctx context.Context, out interface{}) bool

+ type KeyType string

+ const BinaryType

+ const NoneType

+ const NumberType

+ const StringType

+ type Keyed interface

+ HashKey func() interface{}

+ RangeKey func() interface{}

+ type Keys [2]interface

+ func (k Keys) HashKey() interface{}

+ func (k Keys) RangeKey() interface{}

+ type ListTables struct

+ func (lt *ListTables) All(ctx context.Context) ([]string, error)

+ func (lt *ListTables) Iter() Iter

+ type Marshaler interface

+ MarshalDynamo func() (types.AttributeValue, error)

+ type Operator string

+ const BeginsWith

+ const Between

+ const Equal

+ const Greater

+ const GreaterOrEqual

+ const Less

+ const LessOrEqual

+ const NotEqual

+ type Order bool

+ const Ascending

+ const Descending

+ type PagingIter interface

+ LastEvaluatedKey func(context.Context) (PagingKey, error)

+ type PagingKey Item

+ type ParallelIter interface

+ LastEvaluatedKeys func(context.Context) ([]PagingKey, error)

+ type Put struct

+ func (p *Put) ConsumedCapacity(cc *ConsumedCapacity) *Put

+ func (p *Put) If(expr string, args ...interface{}) *Put

+ func (p *Put) OldValue(ctx context.Context, out interface{}) error

+ func (p *Put) Run(ctx context.Context) error

+ type Query struct

+ func (q *Query) All(ctx context.Context, out interface{}) error

+ func (q *Query) AllWithLastEvaluatedKey(ctx context.Context, out interface{}) (PagingKey, error)

+ func (q *Query) Consistent(on bool) *Query

+ func (q *Query) ConsumedCapacity(cc *ConsumedCapacity) *Query

+ func (q *Query) Count(ctx context.Context) (int, error)

+ func (q *Query) Filter(expr string, args ...interface{}) *Query

+ func (q *Query) Index(name string) *Query

+ func (q *Query) Iter() PagingIter

+ func (q *Query) Limit(limit int) *Query

+ func (q *Query) One(ctx context.Context, out interface{}) error

+ func (q *Query) Order(order Order) *Query

+ func (q *Query) Project(paths ...string) *Query

+ func (q *Query) ProjectExpr(expr string, args ...interface{}) *Query

+ func (q *Query) Range(name string, op Operator, values ...interface{}) *Query

+ func (q *Query) RequestLimit(limit int) *Query

+ func (q *Query) SearchLimit(limit int) *Query

+ func (q *Query) StartFrom(key PagingKey) *Query

+ type SSEDescription struct

+ InaccessibleEncryptionDateTime time.Time

+ KMSMasterKeyARN string

+ SSEType types.SSEType

+ Status types.SSEStatus

+ type SSEType string

+ const SSETypeAES256

+ const SSETypeKMS

+ type Scan struct

+ func (s *Scan) All(ctx context.Context, out interface{}) error

+ func (s *Scan) AllParallel(ctx context.Context, segments int, out interface{}) error

+ func (s *Scan) AllParallelStartFrom(ctx context.Context, keys []PagingKey, out interface{}) ([]PagingKey, error)

+ func (s *Scan) AllParallelWithLastEvaluatedKeys(ctx context.Context, segments int, out interface{}) ([]PagingKey, error)

+ func (s *Scan) AllWithLastEvaluatedKey(ctx context.Context, out interface{}) (PagingKey, error)

+ func (s *Scan) Consistent(on bool) *Scan

+ func (s *Scan) ConsumedCapacity(cc *ConsumedCapacity) *Scan

+ func (s *Scan) Count(ctx context.Context) (int, error)

+ func (s *Scan) Filter(expr string, args ...interface{}) *Scan

+ func (s *Scan) Index(name string) *Scan

+ func (s *Scan) Iter() PagingIter

+ func (s *Scan) IterParallel(ctx context.Context, segments int) ParallelIter

+ func (s *Scan) IterParallelStartFrom(ctx context.Context, keys []PagingKey) ParallelIter

+ func (s *Scan) Limit(limit int) *Scan

+ func (s *Scan) Project(paths ...string) *Scan

+ func (s *Scan) RequestLimit(limit int) *Scan

+ func (s *Scan) SearchLimit(limit int) *Scan

+ func (s *Scan) Segment(segment int, totalSegments int) *Scan

+ func (s *Scan) StartFrom(key PagingKey) *Scan

+ type Status string

+ const ActiveStatus

+ const CreatingStatus

+ const DeletingStatus

+ const NotExistsStatus

+ const UpdatingStatus

+ type StreamView string

+ type TTLDescription struct

+ Attribute string

+ Status TTLStatus

+ func (td TTLDescription) Enabled() bool

+ type TTLStatus string

+ const TTLDisabled

+ const TTLDisabling

+ const TTLEnabled

+ const TTLEnabling

+ type Table struct

+ func (table Table) Batch(hashAndRangeKeyName ...string) Batch

+ func (table Table) Check(hashKey string, value interface{}) *ConditionCheck

+ func (table Table) Delete(name string, value interface{}) *Delete

+ func (table Table) DeleteTable() *DeleteTable

+ func (table Table) Describe() *DescribeTable

+ func (table Table) DescribeTTL() *DescribeTTL

+ func (table Table) Get(name string, value interface{}) *Query

+ func (table Table) Name() string

+ func (table Table) Put(item interface{}) *Put

+ func (table Table) Scan() *Scan

+ func (table Table) Update(hashKey string, value interface{}) *Update

+ func (table Table) UpdateTTL(attribute string, enabled bool) *UpdateTTL

+ func (table Table) UpdateTable() *UpdateTable

+ func (table Table) Wait(ctx context.Context, want ...Status) error

+ type Throughput struct

+ DecsToday int64

+ LastDec time.Time

+ LastInc time.Time

+ Read int64

+ Write int64

+ type Unmarshaler interface

+ UnmarshalDynamo func(av types.AttributeValue) error

+ type Update struct

+ func (u *Update) Add(path string, value interface{}) *Update

+ func (u *Update) AddFloatsToSet(path string, values ...float64) *Update

+ func (u *Update) AddIntsToSet(path string, values ...int) *Update

+ func (u *Update) AddStringsToSet(path string, values ...string) *Update

+ func (u *Update) Append(path string, value interface{}) *Update

+ func (u *Update) ConsumedCapacity(cc *ConsumedCapacity) *Update

+ func (u *Update) DeleteFloatsFromSet(path string, values ...float64) *Update

+ func (u *Update) DeleteFromSet(path string, value interface{}) *Update

+ func (u *Update) DeleteIntsFromSet(path string, values ...int) *Update

+ func (u *Update) DeleteStringsFromSet(path string, values ...string) *Update

+ func (u *Update) If(expr string, args ...interface{}) *Update

+ func (u *Update) OldValue(ctx context.Context, out interface{}) error

+ func (u *Update) OnlyUpdatedOldValue(ctx context.Context, out interface{}) error

+ func (u *Update) OnlyUpdatedValue(ctx context.Context, out interface{}) error

+ func (u *Update) Prepend(path string, value interface{}) *Update

+ func (u *Update) Range(name string, value interface{}) *Update

+ func (u *Update) Remove(paths ...string) *Update

+ func (u *Update) RemoveExpr(expr string, args ...interface{}) *Update

+ func (u *Update) Run(ctx context.Context) error

+ func (u *Update) Set(path string, value interface{}) *Update

+ func (u *Update) SetExpr(expr string, args ...interface{}) *Update

+ func (u *Update) SetIfNotExists(path string, value interface{}) *Update

+ func (u *Update) SetNullable(path string, value interface{}) *Update

+ func (u *Update) SetSet(path string, value interface{}) *Update

+ func (u *Update) Value(ctx context.Context, out interface{}) error

+ type UpdateTTL struct

+ func (ttl *UpdateTTL) Run(ctx context.Context) error

+ type UpdateTable struct

+ func (ut *UpdateTable) CreateIndex(index Index) *UpdateTable

+ func (ut *UpdateTable) DeleteIndex(name string) *UpdateTable

+ func (ut *UpdateTable) DisableStream() *UpdateTable

+ func (ut *UpdateTable) OnDemand(enabled bool) *UpdateTable

+ func (ut *UpdateTable) Provision(read, write int64) *UpdateTable

+ func (ut *UpdateTable) ProvisionIndex(name string, read, write int64) *UpdateTable

+ func (ut *UpdateTable) Run(ctx context.Context) (Description, error)

+ func (ut *UpdateTable) Stream(view StreamView) *UpdateTable

+ type WriteTx struct

+ func (tx *WriteTx) Check(check *ConditionCheck) *WriteTx

+ func (tx *WriteTx) ConsumedCapacity(cc *ConsumedCapacity) *WriteTx

+ func (tx *WriteTx) Delete(d *Delete) *WriteTx

+ func (tx *WriteTx) Idempotent(enabled bool) *WriteTx

+ func (tx *WriteTx) IdempotentWithToken(token string) *WriteTx

+ func (tx *WriteTx) Put(p *Put) *WriteTx

+ func (tx *WriteTx) Run(ctx context.Context) error

+ func (tx *WriteTx) Update(u *Update) *WriteTx

Other modules containing this package

github.com/guregu/dynamo

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