dynamo

Documentation

Index

• func AttorneyKey(s string) string
• func CertificateProviderKey(s string) string
• func DocumentKey(s3Key string) string
• func DonorInviteKey(organisationID, lpaID string) string
• func DonorKey(s string) string
• func DonorShareKey(code string) string
• func EvidenceReceivedKey() string
• func LpaKey(s string) string
• func MemberIDKey(memberID string) string
• func MemberInviteKey(email string) string
• func MemberKey(sessionID string) string
• func MetadataKey(s string) string
• func OrganisationKey(organisationID string) string
• func ShareCodeKey(actorType actor.Type, shareCode string) (pk string, err error)
• func SubKey(s string) string
• type Client
  • func NewClient(cfg aws.Config, tableName string) (*Client, error)
  • func (c *Client) AllByKeys(ctx context.Context, keys []Key) ([]map[string]types.AttributeValue, error)
  • func (c *Client) AllByPartialSK(ctx context.Context, pk, partialSk string, v interface{}) error
  • func (c *Client) AllBySK(ctx context.Context, sk string, v interface{}) error
  • func (c *Client) AllKeysByPK(ctx context.Context, pk string) ([]Key, error)
  • func (c *Client) BatchPut(ctx context.Context, values []interface{}) error
  • func (c *Client) Create(ctx context.Context, v interface{}) error
  • func (c *Client) DeleteKeys(ctx context.Context, keys []Key) error
  • func (c *Client) DeleteOne(ctx context.Context, pk, sk string) error
  • func (c *Client) LatestForActor(ctx context.Context, sk string, v interface{}) error
  • func (c *Client) One(ctx context.Context, pk, sk string, v interface{}) error
  • func (c *Client) OneByPK(ctx context.Context, pk string, v interface{}) error
  • func (c *Client) OneByPartialSK(ctx context.Context, pk, partialSK string, v interface{}) error
  • func (c *Client) OneBySK(ctx context.Context, sk string, v interface{}) error
  • func (c *Client) OneByUID(ctx context.Context, uid string, v interface{}) error
  • func (c *Client) Put(ctx context.Context, v interface{}) error
  • func (c *Client) Update(ctx context.Context, pk, sk string, values map[string]types.AttributeValue, ...) error
  • func (c *Client) UpdateReturn(ctx context.Context, pk, sk string, values map[string]types.AttributeValue, ...) (map[string]types.AttributeValue, error)
• type ConditionalCheckFailedError
  • func (c ConditionalCheckFailedError) Error() string
• type Key
• type Logger
• type MultipleResultsError
  • func (n MultipleResultsError) Error() string
• type NotFoundError
  • func (n NotFoundError) Error() string

Functions

func AttorneyKey

func AttorneyKey(s string) string

AttorneyKey is used as the SK (with LpaKey as PK) for attorney entered information.

func CertificateProviderKey

func CertificateProviderKey(s string) string

CertificateProviderKey is used as the SK (with LpaKey as PK) for certificate provider entered information.

func DocumentKey

func DocumentKey(s3Key string) string

DocumentKey is used as the SK (with LpaKey as PK) for any documents uploaded as evidence for reduced fees.

func DonorInviteKey

func DonorInviteKey(organisationID, lpaID string) string

DonorInviteKey is used as the SK (with DonorShareKey as PK) for an invitation to a donor to link an Lpa being created by a member of an organisation.

func DonorKey

func DonorKey(s string) string

DonorKey is used as the SK (with LpaKey as PK) for donor entered information. It is set to PAPER when the donor information has been provided from paper forms.

func DonorShareKey

func DonorShareKey(code string) string

DonorShareKey is used as the PK for sharing an Lpa with a donor.

func EvidenceReceivedKey

func EvidenceReceivedKey() string

EvidenceReceivedKey is used as the SK (with LpaKey as PK) to show that paper evidence has been submitted for an Lpa.

func LpaKey

func LpaKey(s string) string

LpaKey is used as the PK for all Lpa related information.

func MemberIDKey

func MemberIDKey(memberID string) string

MemberIDKey is used as the SK (with OrganisationKey as PK) to allow retrieving a member using their ID instead of their OneLogin sub.

func MemberInviteKey

func MemberInviteKey(email string) string

MemberInviteKey is used as the SK (with OrganisationKey as PK) for a member invite.

func MemberKey

func MemberKey(sessionID string) string

MemberKey is used as the SK (with OrganisationKey as PK) for a member of an organisation.

func MetadataKey

func MetadataKey(s string) string

MetadataKey is used as the SK when the value of the SK is not used for any purpose.

func OrganisationKey

func OrganisationKey(organisationID string) string

OrganisationKey is used as the PK to group organisation data; or as the SK (with OrganisationKey as PK) for the organisation itself; or as the SK (with LpaKey as PK) for the donor information entered by a member of an organisation.

func ShareCodeKey

func ShareCodeKey(actorType actor.Type, shareCode string) (pk string, err error)

ShareCodeKey is used as the PK for sharing an Lpa with another actor.

func SubKey

func SubKey(s string) string

SubKey is used as the SK (with LpaKey as PK) to allow queries on a OneLogin sub against all Lpas an actor may have provided information on.

Types

type Client

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

func NewClient

func NewClient(cfg aws.Config, tableName string) (*Client, error)

func (*Client) AllByKeys

func (c *Client) AllByKeys(ctx context.Context, keys []Key) ([]map[string]types.AttributeValue, error)

func (*Client) AllByPartialSK

func (c *Client) AllByPartialSK(ctx context.Context, pk, partialSk string, v interface{}) error

func (*Client) AllBySK

func (c *Client) AllBySK(ctx context.Context, sk string, v interface{}) error

func (*Client) AllKeysByPK

func (c *Client) AllKeysByPK(ctx context.Context, pk string) ([]Key, error)

func (*Client) BatchPut

func (c *Client) BatchPut(ctx context.Context, values []interface{}) error

func (*Client) Create

func (c *Client) Create(ctx context.Context, v interface{}) error

func (*Client) DeleteKeys

func (c *Client) DeleteKeys(ctx context.Context, keys []Key) error

func (*Client) DeleteOne

func (c *Client) DeleteOne(ctx context.Context, pk, sk string) error

func (*Client) LatestForActor

func (c *Client) LatestForActor(ctx context.Context, sk string, v interface{}) error

func (*Client) One

func (c *Client) One(ctx context.Context, pk, sk string, v interface{}) error

func (*Client) OneByPK

func (c *Client) OneByPK(ctx context.Context, pk string, v interface{}) error

func (*Client) OneByPartialSK

func (c *Client) OneByPartialSK(ctx context.Context, pk, partialSK string, v interface{}) error

func (*Client) OneBySK

func (c *Client) OneBySK(ctx context.Context, sk string, v interface{}) error

func (*Client) OneByUID

func (c *Client) OneByUID(ctx context.Context, uid string, v interface{}) error

func (*Client) Put

func (c *Client) Put(ctx context.Context, v interface{}) error

func (*Client) Update

func (c *Client) Update(ctx context.Context, pk, sk string, values map[string]types.AttributeValue, expression string) error

func (*Client) UpdateReturn

func (c *Client) UpdateReturn(ctx context.Context, pk, sk string, values map[string]types.AttributeValue, expression string) (map[string]types.AttributeValue, error)

type ConditionalCheckFailedError

type ConditionalCheckFailedError struct{}

func (ConditionalCheckFailedError) Error

func (c ConditionalCheckFailedError) Error() string

type Key

type Key struct {
	PK string
	SK string
}

type Logger

type Logger interface {
	Print(v ...interface{})
}

type MultipleResultsError

type MultipleResultsError struct{}

func (MultipleResultsError) Error

func (n MultipleResultsError) Error() string

type NotFoundError

type NotFoundError struct{}

func (NotFoundError) Error

func (n NotFoundError) Error() string