Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ddb

package module

Go to main page

Versions in this module

v2

v2.0.3

Oct 10, 2025

Changes in this version

+ type Image map[string]types.AttributeValue

+ func (img *Image) UnmarshalJSON(data []byte) error

v2.0.2

Oct 10, 2025

v2.0.1

Oct 10, 2025

v2.0.0

Oct 9, 2025

Changes in this version

+ const DefaultBillingMode

+ const DefaultReadCapacity

+ const DefaultWriteCapacity

+ const ErrInvalidFieldName

+ const ErrItemNotFound

+ const ErrMismatchedValueCount

+ const ErrUnableToMarshalItem

+ const EventNameInsert

+ const EventNameModify

+ const EventNameRemove

+ func IsInvalidFieldNameError(err error) bool

+ func IsItemNotFoundError(err error) bool

+ func IsMismatchedValueCountError(err error) bool

+ func TableName(eventSourceARN string) (string, bool)

+ type Change struct

+ ApproximateCreationDateTime EpochSeconds

+ Keys map[string]types.AttributeValue

+ NewImage map[string]types.AttributeValue

+ OldImage map[string]types.AttributeValue

+ SequenceNumber string

+ SizeBytes int64

+ StreamViewType string

+ type ConsumedCapacity struct

+ ReadUnits int64

+ WriteUnits int64

+ func (c *ConsumedCapacity) CapacityUnits() float64

+ type DDB struct

+ func New(api DynamoDBAPI) *DDB

+ func (d *DDB) MustTable(tableName string, model interface{}) *Table

+ func (d *DDB) Table(tableName string, model interface{}) (*Table, error)

+ func (d *DDB) TransactGetItems(items ...GetTx) error

+ func (d *DDB) TransactGetItemsWithContext(ctx context.Context, gets ...GetTx) (err error)

+ func (d *DDB) TransactWriteItems(items ...WriteTx) (*dynamodb.TransactWriteItemsOutput, error)

+ func (d *DDB) TransactWriteItemsWithContext(ctx context.Context, items ...WriteTx) (*dynamodb.TransactWriteItemsOutput, error)

+ func (d *DDB) WithTokenFunc(fn func() string) *DDB

+ func (d *DDB) WithTransactAttempts(n int) *DDB

+ func (d *DDB) WithTransactTimeout(fn func(i int) time.Duration) *DDB

+ type Delete struct

+ func (d *Delete) Condition(expr string, values ...interface{}) *Delete

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

+ func (d *Delete) DeleteItemInput() (*dynamodb.DeleteItemInput, error)

+ func (d *Delete) Range(rangeKey interface{}) *Delete

+ func (d *Delete) ReturnValuesOnConditionCheckFailure(value types.ReturnValuesOnConditionCheckFailure) *Delete

+ func (d *Delete) Run() error

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

+ func (d *Delete) Tx() (*types.TransactWriteItem, error)

+ type DynamoDBAPI interface

+ CreateTable func(ctx context.Context, params *dynamodb.CreateTableInput, ...) (*dynamodb.CreateTableOutput, error)

+ DeleteItem func(ctx context.Context, params *dynamodb.DeleteItemInput, ...) (*dynamodb.DeleteItemOutput, error)

+ DeleteTable func(ctx context.Context, params *dynamodb.DeleteTableInput, ...) (*dynamodb.DeleteTableOutput, error)

+ DescribeTable func(ctx context.Context, params *dynamodb.DescribeTableInput, ...) (*dynamodb.DescribeTableOutput, error)

+ GetItem func(ctx context.Context, params *dynamodb.GetItemInput, ...) (*dynamodb.GetItemOutput, error)

+ PutItem func(ctx context.Context, params *dynamodb.PutItemInput, ...) (*dynamodb.PutItemOutput, error)

+ Query func(ctx context.Context, params *dynamodb.QueryInput, ...) (*dynamodb.QueryOutput, error)

+ Scan func(ctx context.Context, params *dynamodb.ScanInput, ...) (*dynamodb.ScanOutput, error)

+ TransactGetItems func(ctx context.Context, params *dynamodb.TransactGetItemsInput, ...) (*dynamodb.TransactGetItemsOutput, error)

+ TransactWriteItems func(ctx context.Context, params *dynamodb.TransactWriteItemsInput, ...) (*dynamodb.TransactWriteItemsOutput, error)

+ UpdateItem func(ctx context.Context, params *dynamodb.UpdateItemInput, ...) (*dynamodb.UpdateItemOutput, error)

+ type EpochSeconds int64

+ func (e *EpochSeconds) UnmarshalJSON(data []byte) error

+ func (e EpochSeconds) MarshalJSON() ([]byte, error)

+ func (e EpochSeconds) Time() time.Time

+ type Error interface

+ Cause func() error

+ Code func() string

+ Keys func() (hashKey, rangeKey types.AttributeValue)

+ Message func() string

+ TableName func() string

+ type Event struct

+ EventSourceARN string

+ IsFinalInvokeForWindow bool

+ IsWindowTerminatedEarly bool

+ Records []Record

+ ShardId string

+ State json.RawMessage

+ Window *Window

+ type Get struct

+ func (g *Get) ConsistentRead(enabled bool) *Get

+ func (g *Get) ConsumedCapacity(capture *ConsumedCapacity) *Get

+ func (g *Get) GetItemInput() (*dynamodb.GetItemInput, error)

+ func (g *Get) Range(value interface{}) *Get

+ func (g *Get) Scan(v interface{}) error

+ func (g *Get) ScanTx(v interface{}) GetTx

+ func (g *Get) ScanWithContext(ctx context.Context, v interface{}) error

+ type GetAPI interface

+ GetItem func(ctx context.Context, params *dynamodb.GetItemInput, ...) (*dynamodb.GetItemOutput, error)

+ type GetTx interface

+ Decode func(v *types.ItemResponse) error

+ Tx func() (*types.TransactGetItem, error)

+ type Int64Set []int64

+ func (ii *Int64Set) UnmarshalDynamoDBAttributeValue(item types.AttributeValue) error

+ func (ii Int64Set) MarshalDynamoDBAttributeValue() (types.AttributeValue, error)

+ type Item interface

+ Raw func() map[string]types.AttributeValue

+ Unmarshal func(v interface{}) error

+ type Put struct

+ func (p *Put) Condition(expr string, values ...interface{}) *Put

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

+ func (p *Put) PutItemInput() (*dynamodb.PutItemInput, error)

+ func (p *Put) ReturnValuesOnConditionCheckFailure(value types.ReturnValuesOnConditionCheckFailure) *Put

+ func (p *Put) Run() error

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

+ func (p *Put) Tx() (*types.TransactWriteItem, error)

+ type PutAPI interface

+ PutItem func(ctx context.Context, params *dynamodb.PutItemInput, ...) (*dynamodb.PutItemOutput, error)

+ type Query struct

+ func (q *Query) ConsistentRead(enabled bool) *Query

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

+ func (q *Query) Each(fn func(item Item) (bool, error)) error

+ func (q *Query) EachWithContext(ctx context.Context, fn func(item Item) (bool, error)) (err error)

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

+ func (q *Query) FindAll(v interface{}) error

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

+ func (q *Query) First(v interface{}) error

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

+ func (q *Query) IndexName(indexName string) *Query

+ func (q *Query) KeyCondition(expr string, values ...interface{}) *Query

+ func (q *Query) LastEvaluatedKey(lastEvaluatedKey *map[string]types.AttributeValue) *Query

+ func (q *Query) LastEvaluatedToken(lastEvaluatedToken *string) *Query

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

+ func (q *Query) QueryInput() (*dynamodb.QueryInput, error)

+ func (q *Query) ScanIndexForward(enabled bool) *Query

+ func (q *Query) Select(s types.Select) *Query

+ func (q *Query) StartKey(startKey map[string]types.AttributeValue) *Query

+ func (q *Query) StartToken(token string) *Query

+ type Record struct

+ AWSRegion string

+ Change Change

+ EventID string

+ EventName string

+ EventSource string

+ EventSourceARN string

+ EventVersion string

+ type Scan struct

+ func (s *Scan) ConsistentRead(enabled bool) *Scan

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

+ func (s *Scan) Debug(w io.Writer) *Scan

+ func (s *Scan) Each(callback func(item Item) (bool, error)) error

+ func (s *Scan) EachWithContext(ctx context.Context, callback func(item Item) (bool, error)) error

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

+ func (s *Scan) First(v interface{}) error

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

+ func (s *Scan) IndexName(indexName string) *Scan

+ func (s *Scan) TotalSegments(n int64) *Scan

+ type StringSet []string

+ func (ss *StringSet) UnmarshalDynamoDBAttributeValue(item types.AttributeValue) error

+ func (ss StringSet) Contains(want string) bool

+ func (ss StringSet) ContainsRegexp(re *regexp.Regexp) bool

+ func (ss StringSet) MarshalDynamoDBAttributeValue() (types.AttributeValue, error)

+ func (ss StringSet) StringSlice() []string

+ func (ss StringSet) Sub(that StringSet) StringSet

+ type Table struct

+ func (t *Table) ConsumedCapacity() ConsumedCapacity

+ func (t *Table) CreateTableIfNotExists(ctx context.Context, opts ...TableOption) error

+ func (t *Table) DDB() *DDB

+ func (t *Table) Delete(hashKey interface{}) *Delete

+ func (t *Table) DeleteTableIfExists(ctx context.Context) error

+ func (t *Table) Get(hashKey interface{}) *Get

+ func (t *Table) Put(v interface{}) *Put

+ func (t *Table) Query(expr string, values ...interface{}) *Query

+ func (t *Table) Scan() *Scan

+ func (t *Table) Update(hashKey interface{}) *Update

+ type TableIndexOption interface

+ func WithReadCapacity(rcap int64) TableIndexOption

+ func WithWriteCapacity(wcap int64) TableIndexOption

+ type TableOption interface

+ ApplyTable func(o *tableOptions)

+ func WithBillingMode(mode types.BillingMode) TableOption

+ func WithStreamSpecification(streamViewType string) TableOption

+ type Update struct

+ func (u *Update) Add(expr string, values ...interface{}) *Update

+ func (u *Update) Condition(expr string, values ...interface{}) *Update

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

+ func (u *Update) Delete(expr string, values ...interface{}) *Update

+ func (u *Update) NewValues(v interface{}) *Update

+ func (u *Update) OldValues(v interface{}) *Update

+ func (u *Update) Range(rangeKey interface{}) *Update

+ func (u *Update) Remove(expr string, values ...interface{}) *Update

+ func (u *Update) ReturnValuesOnConditionCheckFailure(value types.ReturnValuesOnConditionCheckFailure) *Update

+ func (u *Update) Run() error

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

+ func (u *Update) Set(expr string, values ...interface{}) *Update

+ func (u *Update) Tx() (*types.TransactWriteItem, error)

+ func (u *Update) UpdateItemInput() (*dynamodb.UpdateItemInput, error)

+ type Window struct

+ End string

+ Start string

+ type WriteTx interface

+ Tx func() (*types.TransactWriteItem, error)

Other modules containing this package

github.com/savaki/ddb