Interface SchemaReader

internal/storage/storage.go:109–122

SchemaReader - Reads schema definitions from the storage.

// SchemaReader - Reads schema definitions from the storage.
type SchemaReader interface {
	// ReadSchema returns the schema definition for a specific tenant and version as a structured object.
	ReadSchema(ctx context.Context, tenantID, version string) (schema *base.SchemaDefinition, err error)
	// ReadSchemaString returns the schema definition for a specific tenant and version as a string.
	ReadSchemaString(ctx context.Context, tenantID, version string) (definitions []string, err error)
	// ReadEntityDefinition reads entity config from the storage.
	ReadEntityDefinition(ctx context.Context, tenantID, entityName, version string) (definition *base.EntityDefinition, v string, err error)
	// ReadRuleDefinition reads rule config from the storage.
	ReadRuleDefinition(ctx context.Context, tenantID, ruleName, version string) (definition *base.RuleDefinition, v string, err error)
	// HeadVersion reads the latest version of the schema from the storage.
	HeadVersion(ctx context.Context, tenantID string) (version string, err error)
	// ListSchemas lists all schemas from the storage
	ListSchemas(ctx context.Context, tenantID string, pagination database.Pagination) (schemas []*base.SchemaList, ct database.EncodedContinuousToken, err error)
}

type NoopSchemaReader struct{}