abs

Documentation

Index

• Variables
• type AddResourceParams
• type Backend
• type BackendConstructor
• type BackendGenericInterface
• type BackendRecordsInterface
• type BackendSchemaInterface
• type BackendTransactionInterface
• type DataSource
• type DataSourceConnectionDetails
• type EntityMapper
• type ListRecordParams
• type PropertyWithPath
• type ResourceIdentity
• type Schema
• type UpgradeResourceParams

Variables

var ClientTrackIdContextKey = contextKey("ClientTrackIdContextKey")

var LogFieldsContextKey = contextKey("LogFieldsContextKey")

var SystemContextKey = contextKey("SystemContextKey")

var TransactionContextKey = contextKey("TransactionContextKey")

var UserContextKey = contextKey("UserContextKey")

Types

type AddResourceParams

type AddResourceParams struct {
	Resource       *model.Resource
	IgnoreIfExists bool
	Migrate        bool
	ForceMigrate   bool
}

type Backend

type Backend interface {
	BackendGenericInterface
	BackendRecordsInterface
	BackendSchemaInterface
	BackendTransactionInterface

	SetSchema(schema *Schema)
}

type BackendConstructor

type BackendConstructor func(dataSourceRecord DataSource) Backend

type BackendGenericInterface

type BackendGenericInterface interface {
	GetStatus(ctx context.Context) (connectionAlreadyInitiated bool, testConnection bool, err errors.ServiceError)
	DestroyDataSource(ctx context.Context)
}

type BackendRecordsInterface

type BackendRecordsInterface interface {
	AddRecords(ctx context.Context, resource *model.Resource, records []*model.Record) ([]*model.Record, errors.ServiceError)
	UpdateRecords(ctx context.Context, resource *model.Resource, records []*model.Record) ([]*model.Record, errors.ServiceError)
	GetRecord(ctx context.Context, resource *model.Resource, id string, resolveReferences []string) (*model.Record, errors.ServiceError)
	DeleteRecords(ctx context.Context, resource *model.Resource, ids []string) errors.ServiceError
	ListRecords(ctx context.Context, resource *model.Resource, params ListRecordParams, resultChan chan<- *model.Record) ([]*model.Record, uint32, errors.ServiceError)
}

type BackendSchemaInterface

type BackendSchemaInterface interface {
	ListEntities(ctx context.Context) ([]*model.DataSourceCatalog, errors.ServiceError)
	PrepareResourceFromEntity(ctx context.Context, catalog, entity string) (*model.Resource, errors.ServiceError)
	UpgradeResource(ctx context.Context, params UpgradeResourceParams) errors.ServiceError
}

type BackendTransactionInterface

type BackendTransactionInterface interface {
	BeginTransaction(ctx context.Context, readOnly bool) (transactionKey string, serviceError errors.ServiceError)
	CommitTransaction(ctx context.Context) (serviceError errors.ServiceError)
	RollbackTransaction(ctx context.Context) (serviceError errors.ServiceError)
	IsTransactionAlive(ctx context.Context) (isAlive bool, serviceError errors.ServiceError)
}

type DataSource

type DataSource interface {
	GetName() string
}

type DataSourceConnectionDetails

type DataSourceConnectionDetails interface {
}

type EntityMapper

type EntityMapper[Entity interface{}] interface {
	New() Entity
	ResourceIdentity() ResourceIdentity
	ToRecord(entity Entity) *model.Record
	FromRecord(record *model.Record) Entity
	ToProperties(entity Entity) map[string]*structpb.Value
	FromProperties(properties map[string]*structpb.Value) Entity
}

type ListRecordParams

type ListRecordParams struct {
	Query             *model.BooleanExpression
	Limit             uint32
	Offset            uint64
	ResolveReferences []string
}

type PropertyWithPath

type PropertyWithPath struct {
	Path     string
	Property *model.ResourceProperty
}

type ResourceIdentity

type ResourceIdentity struct {
	Namespace string
	Name      string
}

type Schema

type Schema struct {
	Resources                    []*model.Resource
	ResourceByNamespaceSlashName map[string]*model.Resource
	ResourceBySlug               map[string]*model.Resource
	ResourcePropertiesByType     map[string]map[model.ResourceProperty_Type][]PropertyWithPath
}

type UpgradeResourceParams

type UpgradeResourceParams struct {
	ForceMigration bool
	MigrationPlan  *model.ResourceMigrationPlan
}