store

Documentation

Index

• type APIKey
• type APIKeyKey
• type APIKeySpec
• type S
  • func New(db *gorm.DB) *S
  • func NewTest(t *testing.T) (*S, func())
  • func (s *S) AutoMigrate() error
  • func (s *S) CreateAPIKey(spec APIKeySpec) (*APIKey, error)
  • func (s *S) DeleteAPIKey(k APIKeyKey) error
  • func (s *S) ListAPIKeysByTenantID(tenantID string) ([]*APIKey, error)
  • func (s *S) ListAllAPIKeys() ([]*APIKey, error)

Types

type APIKey

type APIKey struct {
	gorm.Model

	APIKeyID string `gorm:"uniqueIndex:idx_api_key_api_key_id_tenant_id"`
	TenantID string `gorm:"uniqueIndex:idx_api_key_api_key_id_tenant_id"`

	Name   string
	Secret string
}

APIKey represents an API key.

type APIKeyKey

type APIKeyKey struct {
	APIKeyID string
	TenantID string
}

APIKeyKey represents a key of an API key.

type APIKeySpec

type APIKeySpec struct {
	Key APIKeyKey

	Name   string
	Secret string
}

APIKeySpec is a spec of the API key.

type S

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

S represents the data store.

func New

func New(db *gorm.DB) *S

New creates a new store instance.

func NewTest

func NewTest(t *testing.T) (*S, func())

NewTest returns a new test store.

func (*S) AutoMigrate

func (s *S) AutoMigrate() error

AutoMigrate sets up the auto-migration task of the database.

func (*S) CreateAPIKey

func (s *S) CreateAPIKey(spec APIKeySpec) (*APIKey, error)

CreateAPIKey creates a new API key.

func (*S) DeleteAPIKey

func (s *S) DeleteAPIKey(k APIKeyKey) error

DeleteAPIKey deletes an APIKey by APIKey ID and tenant ID.

func (*S) ListAPIKeysByTenantID

func (s *S) ListAPIKeysByTenantID(tenantID string) ([]*APIKey, error)

ListAPIKeysByTenantID list API keys by a tenant ID.

func (*S) ListAllAPIKeys

func (s *S) ListAllAPIKeys() ([]*APIKey, error)

ListAllAPIKeys lists all API keys.