catalog

type CatalogDataset struct {
	Name     string `json:"name"`
	Platform string `json:"platform"`
	Owner    string `json:"owner"`
}

type CatalogProvider interface {
	RegisterDataset(ctx context.Context, req RegisterDatasetRequest) error
	SearchDatasets(ctx context.Context, query string, limit int) ([]CatalogDataset, int, error)
}

type ContractDB interface {
	QueryCount(ctx context.Context, query string) (int, error)
}

type ContractField struct {
	Name     string `yaml:"name"`
	Type     string `yaml:"type"`
	Nullable bool   `yaml:"nullable"`
	Required bool   `yaml:"required"`
}

type DataContract struct {
	Dataset string          `yaml:"dataset"`
	Version string          `yaml:"version"`
	Schema  []ContractField `yaml:"schema"`
	Quality []QualityCheck  `yaml:"quality"`
}

type DataHubClient interface {
	GetDataset(ctx context.Context, urn string) (*Dataset, error)
	SearchDatasets(ctx context.Context, query string, start, count int) (*SearchResult, error)
	EmitMetadata(ctx context.Context, proposals []MetadataProposal) error
	AddTag(ctx context.Context, urn, tag string) error
	AddGlossaryTerm(ctx context.Context, urn, term string) error
	SetOwner(ctx context.Context, urn, ownerUrn, ownerType string) error
	SetLineage(ctx context.Context, upstream, downstream string) error
	GetLineage(ctx context.Context, urn, direction string) (*LineageResult, error)
}

type DataHubConfig struct {
	Endpoint string        `json:"endpoint" yaml:"endpoint"`
	Token    string        `json:"token"    yaml:"token"`
	Timeout  time.Duration `json:"timeout"  yaml:"timeout"`
}

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

type Dataset struct {
	URN        string            `json:"urn"`
	Name       string            `json:"name"`
	Platform   string            `json:"platform"`
	Schema     *DatasetSchema    `json:"schema,omitempty"`
	Properties map[string]string `json:"properties,omitempty"`
	Tags       []string          `json:"tags,omitempty"`
	Owner      string            `json:"owner,omitempty"`
}

type DatasetRef struct {
	Dataset  string
	Platform string
}

type DatasetSchema struct {
	Fields []SchemaField `json:"fields"`
}

type EntityRef struct {
	FQN  string `json:"fullyQualifiedName"`
	Type string `json:"type"`
}

type LineageEdge struct {
	From     string `json:"from"`
	To       string `json:"to"`
	Pipeline string `json:"pipeline"`
}

type LineageNode struct {
	Dataset  string `json:"dataset"`
	Platform string `json:"platform"`
	Depth    int    `json:"depth"`
}

type LineageProvider interface {
	RecordLineage(ctx context.Context, upstreams, downstreams []DatasetRef, pipeline string) error
	QueryLineage(ctx context.Context, dataset, direction string, depth int) (*LineageQueryResult, error)
}

type LineageQueryResult struct {
	Nodes []LineageNode
	Edges []LineageEdge
}

type LineageResult struct {
	URN       string    `json:"urn"`
	Direction string    `json:"direction"`
	Entities  []Dataset `json:"entities"`
}

type MetadataProposal struct {
	EntityURN  string         `json:"entityUrn"`
	AspectName string         `json:"aspectName"`
	Aspect     map[string]any `json:"aspect"`
}

type OMColumn struct {
	Name     string `json:"name"`
	DataType string `json:"dataType"`
}

type OMEntityRef struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type OMLineageResult struct {
	FQN        string    `json:"fullyQualifiedName"`
	Upstream   []OMTable `json:"upstream,omitempty"`
	Downstream []OMTable `json:"downstream,omitempty"`
}

type OMSearchResult struct {
	Tables []OMTable `json:"tables"`
	Total  int       `json:"total"`
}

type OMTable struct {
	ID                 string       `json:"id,omitempty"`
	Name               string       `json:"name"`
	FullyQualifiedName string       `json:"fullyQualifiedName,omitempty"`
	Description        string       `json:"description,omitempty"`
	Columns            []OMColumn   `json:"columns,omitempty"`
	Tags               []OMTag      `json:"tags,omitempty"`
	Owner              *OMEntityRef `json:"owner,omitempty"`
}

type OMTag struct {
	TagFQN string `json:"tagFQN"`
}

type OpenMetadataClient interface {
	GetTable(ctx context.Context, fqn string) (*OMTable, error)
	SearchTables(ctx context.Context, query string, limit int) (*OMSearchResult, error)
	CreateOrUpdateTable(ctx context.Context, table OMTable) error
	AddTag(ctx context.Context, fqn, tag string) error
	SetOwner(ctx context.Context, fqn, owner string) error
	AddLineageEdge(ctx context.Context, from, to EntityRef) error
	GetLineage(ctx context.Context, fqn string) (*OMLineageResult, error)
}

type OpenMetadataConfig struct {
	Endpoint string        `json:"endpoint" yaml:"endpoint"`
	Token    string        `json:"token"    yaml:"token"`
	Timeout  time.Duration `json:"timeout"  yaml:"timeout"`
}

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

type QualityCheck struct {
	Name  string `yaml:"name"`
	Query string `yaml:"query"` // must return 0 rows for passing
	Type  string `yaml:"type"`  // not_null, unique, custom
}

type RegisterDatasetRequest struct {
	Dataset    string
	Schema     []SchemaField
	Owner      string
	Tags       []string
	Properties map[string]string
}

type SchemaDefinition struct {
	Schema     string            `json:"schema"               yaml:"schema"`
	SchemaType string            `json:"schemaType,omitempty" yaml:"schemaType,omitempty"`
	References []SchemaReference `json:"references,omitempty" yaml:"references,omitempty"`
}

type SchemaField struct {
	Name     string `json:"fieldPath" yaml:"name"`
	Type     string `json:"nativeDataType" yaml:"type"`
	Nullable bool   `json:"nullable"       yaml:"nullable"`
}

type SchemaInfo struct {
	Subject    string `json:"subject"              yaml:"subject"`
	Version    int    `json:"version"              yaml:"version"`
	ID         int    `json:"id"                   yaml:"id"`
	Schema     string `json:"schema"               yaml:"schema"`
	SchemaType string `json:"schemaType,omitempty" yaml:"schemaType,omitempty"`
}

type SchemaReference struct {
	Name    string `json:"name"    yaml:"name"`
	Subject string `json:"subject" yaml:"subject"`
	Version int    `json:"version" yaml:"version"`
}

type SchemaRegistryClient interface {
	ListSubjects(ctx context.Context) ([]string, error)
	RegisterSchema(ctx context.Context, subject string, schema SchemaDefinition) (int, error)
	GetSchema(ctx context.Context, id int) (*SchemaDefinition, error)
	GetLatestSchema(ctx context.Context, subject string) (*SchemaInfo, error)
	GetSchemaByVersion(ctx context.Context, subject, version string) (*SchemaInfo, error)
	DeleteSubject(ctx context.Context, subject string, permanent bool) ([]int, error)
	CheckCompatibility(ctx context.Context, subject string, schema SchemaDefinition) (bool, error)
	GetCompatibilityLevel(ctx context.Context, subject string) (string, error)
	SetCompatibilityLevel(ctx context.Context, subject string, level string) error
	ValidateSchema(ctx context.Context, schema SchemaDefinition, data []byte) error
}

type SchemaRegistryConfig struct {
	Provider             string        `json:"provider"             yaml:"provider"`
	Endpoint             string        `json:"endpoint"             yaml:"endpoint"`
	Username             string        `json:"username"             yaml:"username"`
	Password             string        `json:"password"             yaml:"password"`
	DefaultCompatibility string        `json:"defaultCompatibility" yaml:"defaultCompatibility"`
	Timeout              time.Duration `json:"timeout"              yaml:"timeout"`
}

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

type SearchResult struct {
	Entities []Dataset `json:"entities"`
	Total    int       `json:"total"`
	Start    int       `json:"start"`
	Count    int       `json:"count"`
}