catalogdynamo

Documentation

Overview

Package catalogdynamo package store all the data in a single multi-tenant table:

Index

• Constants
• func AlbumIndexedKeyPK(owner string, folderName string) string
• func MediaPrimaryKeyPK(owner string, id string) string
• func Must(repository catalog.RepositoryAdapter, err error) catalog.RepositoryAdapter
• func NewRepository(awsSession *session.Session, tableName string) (catalog.RepositoryAdapter, error)
• type AlbumIndexKey
  • func AlbumIndexedKey(owner, folderName string) AlbumIndexKey
  • func MediaAlbumIndexedKey(owner string, folderName string, dateTime time.Time, id string) AlbumIndexKey
• type AlbumRecord
• type MediaRecord
• type Repository
  • func (r *Repository) CountMedias(owner string, folderName string) (int, error)
  • func (r *Repository) CreateTableIfNecessary() error
  • func (r *Repository) DeleteEmptyAlbum(owner string, folderName string) error
  • func (r *Repository) FindAlbums(ids ...catalog.AlbumId) ([]*catalog.Album, error)
  • func (r *Repository) FindAlbumsByOwner(owner string) ([]*catalog.Album, error)
  • func (r *Repository) FindExistingSignatures(owner string, signatures []*catalog.MediaSignature) ([]*catalog.MediaSignature, error)
  • func (r *Repository) FindMediaCurrentAlbum(owner, mediaId string) (string, error)
  • func (r *Repository) FindMediaIds(request *catalog.FindMediaRequest) ([]string, error)
  • func (r *Repository) FindMedias(request *catalog.FindMediaRequest) ([]*catalog.MediaMeta, error)
  • func (r *Repository) InsertAlbum(album catalog.Album) error
  • func (r *Repository) InsertMedias(owner string, medias []catalog.CreateMediaRequest) error
  • func (r *Repository) TransferMedias(owner string, mediaIds []string, newFolderName string) error
  • func (r *Repository) UpdateAlbum(album catalog.Album) error
• type TablePk
  • func AlbumPrimaryKey(owner string, folderName string) TablePk
  • func MediaPrimaryKey(owner string, id string) TablePk

Constants

const (
	DynamoWriteBatchSize = 25
	DynamoReadBatchSize  = 100
)

const (
	IsoTime = "2006-01-02T15:04:05"
)

Functions

func AlbumIndexedKeyPK

func AlbumIndexedKeyPK(owner string, folderName string) string

func MediaPrimaryKeyPK

func MediaPrimaryKeyPK(owner string, id string) string

func Must

func Must(repository catalog.RepositoryAdapter, err error) catalog.RepositoryAdapter

Must panics if there is an error

func NewRepository

func NewRepository(awsSession *session.Session, tableName string) (catalog.RepositoryAdapter, error)

NewRepository creates the repository and connect to the database

Types

type AlbumIndexKey

type AlbumIndexKey struct {
	AlbumIndexPK string // AlbumIndexPK is same than album's TablePk.PK
	AlbumIndexSK string // AlbumIndexSK identify the object within the index, and is naturally sorted
}

AlbumIndexKey is a secondary key to index medias per albums

func AlbumIndexedKey

func AlbumIndexedKey(owner, folderName string) AlbumIndexKey

func MediaAlbumIndexedKey

func MediaAlbumIndexedKey(owner string, folderName string, dateTime time.Time, id string) AlbumIndexKey

type AlbumRecord

type AlbumRecord struct {
	TablePk
	AlbumIndexKey
	AlbumOwner      string // AlbumOwner has been added to the data structure on 18 Apr 2022
	AlbumName       string
	AlbumFolderName string
	AlbumStart      time.Time
	AlbumEnd        time.Time
}

type MediaRecord

type MediaRecord struct {
	TablePk
	AlbumIndexKey
	Id            string                 // Id is the unique identifier of the media
	Type          string                 // Type is either PHOTO or VIDEO
	DateTime      time.Time              // DateTime time used in AlbumIndexKey
	Details       map[string]interface{} // Details are other attributes from domain model, stored as it
	Filename      string                 // Filename is the original filename for display purpose only ; physical filename is in MediaLocationData
	SignatureSize int
	SignatureHash string
}

type Repository

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

func (*Repository) CountMedias

func (r *Repository) CountMedias(owner string, folderName string) (int, error)

CountMedias provides an accurate number of medias and can be used to update the count stored in the album record

func (*Repository) CreateTableIfNecessary

func (r *Repository) CreateTableIfNecessary() error

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

func (*Repository) DeleteEmptyAlbum

func (r *Repository) DeleteEmptyAlbum(owner string, folderName string) error

func (*Repository) FindAlbums

func (r *Repository) FindAlbums(ids ...catalog.AlbumId) ([]*catalog.Album, error)

func (*Repository) FindAlbumsByOwner

func (r *Repository) FindAlbumsByOwner(owner string) ([]*catalog.Album, error)

func (*Repository) FindExistingSignatures

func (r *Repository) FindExistingSignatures(owner string, signatures []*catalog.MediaSignature) ([]*catalog.MediaSignature, error)

func (*Repository) FindMediaCurrentAlbum

func (r *Repository) FindMediaCurrentAlbum(owner, mediaId string) (string, error)

func (*Repository) FindMediaIds

func (r *Repository) FindMediaIds(request *catalog.FindMediaRequest) ([]string, error)

func (*Repository) FindMedias

func (r *Repository) FindMedias(request *catalog.FindMediaRequest) ([]*catalog.MediaMeta, error)

func (*Repository) InsertAlbum

func (r *Repository) InsertAlbum(album catalog.Album) error

func (*Repository) InsertMedias

func (r *Repository) InsertMedias(owner string, medias []catalog.CreateMediaRequest) error

func (*Repository) TransferMedias

func (r *Repository) TransferMedias(owner string, mediaIds []string, newFolderName string) error

func (*Repository) UpdateAlbum

func (r *Repository) UpdateAlbum(album catalog.Album) error

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

func AlbumPrimaryKey

func AlbumPrimaryKey(owner string, folderName string) TablePk

func MediaPrimaryKey

func MediaPrimaryKey(owner string, id string) TablePk