appdynamodb

README

DynamoDB Schema

Each adapter extends core DB schema with extra supported type to consolidate in a single table all elements of the application.

For readability purpose, the big picture is documented in this file.

Schema

Entries

PK	SK	Description	Module
{OWNER}#ALBUM	ALBUM#{FOLDER_NAME}	Album metadata	catalogdynamo
{OWNER}#MEDIA#{id}	#METADATA	Media metadata	catalogdynamo
{OWNER}#MEDIA#{id}	LOCATION#	Media location if the archive	archivedynamo
USER#{EMAIL}	SCOPE#{TYPE}#{OWNER}#{RESOURCE ID}	Scopes allowed for a user (ownership, shared, ...)	aclscopedynamodb
USER#{EMAIL}	IDENTITY#	Details about the user (name, picture, ...)	aclidentitydynamodb
REFRESH#{TOKEN}	#REFRESH_SPEC	Refresh token	aclrefreshdynamodb

Documentation

Index

• func CreateTableIfNecessary(ctx context.Context, table string, client *dynamodb.Client, localDynamodb bool) error
• func MediaPrimaryKeyPK(owner string, id string) string
• func UserPk(userEmail string) string
• type TablePk

Functions

func CreateTableIfNecessary

func CreateTableIfNecessary(ctx context.Context, table string, client *dynamodb.Client, localDynamodb bool) error

CreateTableIfNecessary creates the table if it doesn't exist ; or update it.

func MediaPrimaryKeyPK

func MediaPrimaryKeyPK(owner string, id string) string

MediaPrimaryKeyPK is the PK of a media, used to regroup media related information together

func UserPk

func UserPk(userEmail string) string

UserPk is the PK of a user, used to regroup user related information together

Types

type TablePk

type TablePk struct {
	PK string // PK is the Partition key ; see what's used depending on object types
	SK string // SK is the Sort key ; see what's used depending on object types
}

TablePk are the primary and sort keys of the table