database

Documentation

Index

• func DeleteSingle[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, ...) error
• func GetMany[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, ...) ([]T, error)
• func GetSingle[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, ...) (*T, error)
• func PutSingle[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, ...) error
• func ScanMany[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, ...) ([]T, error)
• func UpdateSingle[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, ...) (*T, error)
• type DeleteSingleInput
• type GetManyInput
• type GetSingleInput
• type PutSingleInput
• type ScanManyInput
• type UpdateSingleInput

Functions

func DeleteSingle

func DeleteSingle[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, input *DeleteSingleInput) error

DeleteSingle deletes a single item from the database.

func GetMany

func GetMany[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, input *GetManyInput) ([]T, error)

GetMany fetches items from the database and tries to deserialize it into a list of the provided struct type. Set the index to "" to query the main table. Set the limit to '-1' to fetch all items.

func GetSingle

func GetSingle[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, input *GetSingleInput) (*T, error)

GetSingle fetches a single item from the database and tries to deserialize it into the provided struct type. Set the index to "" to query the main table.

func PutSingle

func PutSingle[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, input *PutSingleInput[T]) error

PutSingle inserts a single item to the database. If you want to ensure no item is overwritten, you can set the ProtectionAttributeName to an attribute key that must NOT alread exist (usually the partition key is used for this).

func ScanMany

func ScanMany[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, input *ScanManyInput) ([]T, error)

ScanMany reads all items from the database. Only use this on very very small datasets. Set the limit to '-1' to fetch all items.

func UpdateSingle

func UpdateSingle[T any](transportCtx context.Context, dynamoClient *dynamodb.Client, input *UpdateSingleInput) (*T, error)

UpdateSingle updates a single item on the database.

Types

type DeleteSingleInput

type DeleteSingleInput struct {
	Table      *string
	PrimaryKey map[string]dynamodbtypes.AttributeValue
}

type GetManyInput

type GetManyInput struct {
	Table           *string
	Index           *string
	AttributeValues map[string]dynamodbtypes.AttributeValue
	ConditionExpr   *string
	Limit           *int32
}

type GetSingleInput

type GetSingleInput struct {
	Table           *string
	Index           *string
	AttributeValues map[string]dynamodbtypes.AttributeValue
	ConditionExpr   *string
}

type PutSingleInput

type PutSingleInput[T any] struct {
	Table                   *string
	Item                    T
	ProtectionAttributeName *string
}

type ScanManyInput

type ScanManyInput struct {
	Table *string
	Limit *int32
}

type UpdateSingleInput

type UpdateSingleInput struct {
	Table           *string
	PrimaryKey      map[string]dynamodbtypes.AttributeValue
	Upsert          bool
	ReturnOld       bool
	ConditionExpr   *string
	AttributeNames  map[string]string
	AttributeValues map[string]dynamodbtypes.AttributeValue
	UpdateExpr      *string
}