Documentation
¶
Overview ¶
@index Materialized cross-namespace annotation references for federated graph analysis.
@index Persisted parser-result cache entries scoped by namespace and source path.
@index GORM models for runtime schema compatibility checks.
@index Durable unresolved-edge reverse index for semi-naive incremental resolution.
Index ¶
- func BuildInheritsFingerprintV2(filePath, child, parent string) string
- func IsCallKind(kind EdgeKind) bool
- func ParseInheritsFingerprint(filePath, fingerprint string) (child, parent string, ok bool)
- type Annotation
- type Community
- type CommunityMembership
- type CrossRef
- type CrossRefSource
- type CrossRefStatus
- type DocTag
- type Edge
- type EdgeKind
- type Flow
- type FlowMembership
- type Node
- type NodeKind
- type ParseCacheEntry
- type SchemaVersion
- type SearchDocument
- type TagKind
- type UnresolvedEdgeCandidate
- type UnresolvedIndexState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildInheritsFingerprintV2 ¶
BuildInheritsFingerprintV2 encodes inherits edges with a versioned JSON payload. @intent provide an unambiguous fingerprint contract for inheritance edges across languages.
func IsCallKind ¶
IsCallKind reports whether kind represents a call edge.
This helper keeps fallback call-kind handling centralized for traversal and filtering paths. @intent centralize call-kind handling for traversal and filtering paths.
func ParseInheritsFingerprint ¶
ParseInheritsFingerprint decodes v2 fingerprints first and falls back to the legacy contract. @intent keep resolver compatibility while parsers migrate to the unambiguous inherits fingerprint format.
Types ¶
type Annotation ¶
type Annotation struct {
ID uint `gorm:"primaryKey"`
NodeID uint `gorm:"uniqueIndex;not null"`
Summary string `gorm:"type:text"`
Context string `gorm:"type:text"`
RawText string `gorm:"type:text"`
CreatedAt time.Time
UpdatedAt time.Time
Tags []DocTag `gorm:"foreignKey:AnnotationID"`
}
Annotation은 코드 선언에 연결된 구조화된 주석이다. @intent 노드에 연결된 요약과 태그 메타데이터를 영속화한다.
type Community ¶
type Community struct {
ID uint `gorm:"primaryKey"`
Namespace string `gorm:"type:text;not null;default:'default';uniqueIndex:idx_community_ns_key"`
Key string `gorm:"type:text;not null;uniqueIndex:idx_community_ns_key"`
Label string `gorm:"type:text;not null"`
Strategy string `gorm:"type:text;not null;index"`
Description string `gorm:"type:text"`
CreatedAt time.Time
UpdatedAt time.Time
Members []CommunityMembership `gorm:"foreignKey:CommunityID"`
}
Community는 커뮤니티 분석 결과의 그룹 메타데이터를 저장한다. @intent 연관된 노드 집합을 전략별 커뮤니티 단위로 표현한다.
type CommunityMembership ¶
type CommunityMembership struct {
ID uint `gorm:"primaryKey"`
CommunityID uint `gorm:"not null;uniqueIndex:idx_community_node"`
NodeID uint `gorm:"not null;uniqueIndex:idx_community_node;index"`
CreatedAt time.Time
}
CommunityMembership는 노드와 커뮤니티의 소속 관계를 저장한다. @intent 특정 노드가 어떤 커뮤니티에 속하는지 연결한다.
type CrossRef ¶
type CrossRef struct {
ID uint `gorm:"primaryKey"`
FromNamespace string `gorm:"type:text;not null;index:idx_crossref_from_ns"`
FromNodeID uint `gorm:"not null;index:idx_crossref_from_node"`
Raw string `gorm:"type:text;not null"`
ToNamespace string `gorm:"type:text;not null;index:idx_crossref_to_ns"`
ToPath string `gorm:"type:text;not null;default:''"`
ToSymbol string `gorm:"type:text;not null;default:''"`
ResolvedNodeID *uint `gorm:"index:idx_crossref_resolved_node"`
Status CrossRefStatus `gorm:"type:text;not null"`
Source CrossRefSource `gorm:"type:text;not null;default:'annotation'"`
CreatedAt time.Time
UpdatedAt time.Time
}
CrossRef materializes one @see ccg:// annotation tag as queryable cross-namespace graph state. @intent make annotation-declared repository links traversable and listable instead of plain tag text. @domainRule target identity is symbolic (namespace, path, symbol); resolved_node_id is derived state that rebuilds change. @domainRule rows for one source namespace are fully replaced on each build, so no uniqueness constraint is required.
type CrossRefSource ¶
type CrossRefSource string
CrossRefSource records which signal produced a cross-namespace reference. @intent keep room for future non-annotation signals (e.g. import mapping) without schema rework.
const CrossRefSourceAnnotation CrossRefSource = "annotation"
type CrossRefStatus ¶
type CrossRefStatus string
CrossRefStatus describes whether a cross-namespace reference currently resolves to a node. @intent distinguish navigable references from dangling ones without deleting authored links.
const ( CrossRefStatusResolved CrossRefStatus = "resolved" CrossRefStatusDead CrossRefStatus = "dead" )
type DocTag ¶
type DocTag struct {
ID uint `gorm:"primaryKey"`
AnnotationID uint `gorm:"not null;index"`
Kind TagKind `gorm:"type:text;not null;index"`
Type string `gorm:"type:text"`
Name string `gorm:"type:text"`
Value string `gorm:"type:text;not null"`
Ordinal int `gorm:"not null"`
CreatedAt time.Time
}
DocTag는 Annotation 내의 개별 태그이다. @intent 어노테이션의 단일 구조화 태그 항목을 표현한다. Type 필드는 YARD `@param [String] name ...` 또는 JSDoc `@param {string} name ...`에서 추출한 타입 문자열을 보관한다 (param/throws/return에서 사용). TypeScript/JSDoc 복합 타입(`Record<string, Array<{id: number, name: string}>>`)이 수백 바이트에 이를 수 있어 text로 지정.
type Edge ¶
type Edge struct {
ID uint `gorm:"primaryKey"`
Namespace string `gorm:"type:text;not null;default:'default';index;uniqueIndex:idx_edges_namespace_fingerprint"`
FromNodeID uint `gorm:"index"`
ToNodeID uint `gorm:"index"`
Kind EdgeKind `gorm:"type:text;not null;index"`
FilePath string `gorm:"type:text;index"`
Line int
Fingerprint string `gorm:"type:text;not null;uniqueIndex:idx_edges_namespace_fingerprint"`
CreatedAt time.Time
FromNode Node `gorm:"foreignKey:FromNodeID;constraint:-"`
ToNode Node `gorm:"foreignKey:ToNodeID;constraint:-"`
}
Edge는 두 노드 사이의 방향성 관계를 저장한다. @intent 코드 그래프에서 선언 간 연결과 그 출처를 영속화한다.
type EdgeKind ¶
type EdgeKind string
EdgeKind는 노드 간 관계의 종류를 나타낸다. @intent 그래프 엣지의 의미를 일관된 관계 타입으로 구분한다.
const ( EdgeKindCalls EdgeKind = "calls" EdgeKindFallbackCalls EdgeKind = "fallback_calls" EdgeKindImportsFrom EdgeKind = "imports_from" EdgeKindInherits EdgeKind = "inherits" EdgeKindImplements EdgeKind = "implements" EdgeKindContains EdgeKind = "contains" EdgeKindTestedBy EdgeKind = "tested_by" EdgeKindDependsOn EdgeKind = "depends_on" EdgeKindReferences EdgeKind = "references" // EdgeKindCrossRef marks a synthetic traversal edge derived from a resolved cross-namespace // annotation reference. It is never persisted in the edges table; cross-namespace readers // materialize it from cross_refs rows at query time. EdgeKindCrossRef EdgeKind = "cross_ref" )
func CallEdgeKinds ¶
func CallEdgeKinds() []EdgeKind
CallEdgeKinds returns edge kinds that represent a callable relationship.
Fallback call resolution stores low-confidence edges as EdgeKindFallbackCalls, but callers that want to traverse call behavior should usually include both values. @intent centralize call-kind handling for traversal and filtering paths.
type Flow ¶
type Flow struct {
ID uint `gorm:"primaryKey"`
Namespace string `gorm:"type:text;not null;default:'default';index"`
Name string `gorm:"type:text;not null"`
Description string `gorm:"type:text"`
CreatedAt time.Time
Members []FlowMembership `gorm:"foreignKey:FlowID"`
}
Flow는 추적된 호출 흐름의 메타데이터를 저장한다. @intent 의미 있는 실행 흐름을 이름과 설명으로 식별한다.
type FlowMembership ¶
type FlowMembership struct {
ID uint `gorm:"primaryKey"`
Namespace string `gorm:"type:text;not null;default:'default';index"`
FlowID uint `gorm:"not null;index"`
NodeID uint `gorm:"not null;index"`
Ordinal int `gorm:"not null"`
}
FlowMembership는 흐름에 포함된 노드의 순서를 저장한다. @intent 특정 플로우를 구성하는 노드와 그 위치를 연결한다.
type Node ¶
type Node struct {
ID uint `gorm:"primaryKey"`
Namespace string `gorm:"type:text;not null;default:'default';uniqueIndex:idx_ns_qn_fp_sl;index:idx_nodes_ns_file_path,priority:1"`
QualifiedName string `gorm:"type:text;not null;uniqueIndex:idx_ns_qn_fp_sl"`
Kind NodeKind `gorm:"type:text;not null;index"`
Name string `gorm:"type:text;not null"`
FilePath string `gorm:"type:text;not null;index;uniqueIndex:idx_ns_qn_fp_sl;index:idx_nodes_ns_file_path,priority:2"`
StartLine int `gorm:"not null;uniqueIndex:idx_ns_qn_fp_sl"`
EndLine int `gorm:"not null"`
Hash string `gorm:"type:text"`
Language string `gorm:"type:text;index"`
CreatedAt time.Time
UpdatedAt time.Time
Annotation *Annotation `gorm:"foreignKey:NodeID"`
}
Node는 코드 그래프의 단일 선언 엔티티를 저장한다. @intent 파일 내 선언의 정체성과 위치 정보를 영속화한다.
type NodeKind ¶
type NodeKind string
NodeKind는 그래프 노드의 선언 분류를 나타낸다. @intent 파싱된 선언을 검색과 분석에 필요한 종류로 구분한다.
type ParseCacheEntry ¶
type ParseCacheEntry struct {
ID uint `gorm:"primaryKey"`
Namespace string `gorm:"type:text;not null;default:'default';uniqueIndex:idx_parse_cache_ns_file"`
FilePath string `gorm:"type:text;not null;uniqueIndex:idx_parse_cache_ns_file"`
SourceHash string `gorm:"type:text;not null;index"`
ParserVersion string `gorm:"type:text;not null"`
ContextHash string `gorm:"type:text;not null"`
Payload []byte `gorm:"not null"`
CreatedAt time.Time
UpdatedAt time.Time
}
ParseCacheEntry stores the latest serialized parse result for one namespace/file path. @intent bound cache growth per active source path while validating the complete semantic cache identity.
type SchemaVersion ¶
type SchemaVersion struct {
Key string `gorm:"primaryKey;type:text"`
Version int `gorm:"not null"`
UpdatedAt time.Time
}
SchemaVersion records the database schema level expected by the binary. @intent let runtime commands fail fast when explicit migrations were not run.
func (SchemaVersion) TableName ¶
func (SchemaVersion) TableName() string
TableName pins SchemaVersion to the migration-managed schema version table. @intent keep runtime schema checks aligned with explicit migration bookkeeping.
type SearchDocument ¶
type SearchDocument struct {
ID uint `gorm:"primaryKey"`
Namespace string `gorm:"type:text;not null;default:'default';index;uniqueIndex:idx_searchdoc_ns_node"`
NodeID uint `gorm:"not null;uniqueIndex:idx_searchdoc_ns_node"`
Content string `gorm:"type:text;not null"`
Language string `gorm:"type:text;index"`
}
SearchDocument는 노드 검색용 색인 문서를 저장한다. @intent 전문 검색 백엔드가 사용할 노드별 검색 본문을 유지한다.
type TagKind ¶
type TagKind string
TagKind는 DocTag의 종류를 나타낸다. @intent 구조화된 문서 태그의 의미 분류를 표준화한다.
const ( TagParam TagKind = "param" TagReturn TagKind = "return" TagSee TagKind = "see" TagIntent TagKind = "intent" TagDomainRule TagKind = "domainRule" TagSideEffect TagKind = "sideEffect" TagMutates TagKind = "mutates" TagRequires TagKind = "requires" TagEnsures TagKind = "ensures" TagIndex TagKind = "index" TagThrows TagKind = "throws" TagTypedef TagKind = "typedef" )
type UnresolvedEdgeCandidate ¶
type UnresolvedEdgeCandidate struct {
ID uint `gorm:"primaryKey"`
Namespace string `gorm:"type:text;not null;default:'default';uniqueIndex:idx_unresolved_ns_fp_hash"`
LookupKey string `gorm:"type:text;not null"`
LookupKeyHash string `gorm:"type:text;not null;index:idx_unresolved_lookup_hash"`
Fingerprint string `gorm:"type:text;not null"`
FingerprintHash string `gorm:"type:text;not null;uniqueIndex:idx_unresolved_ns_fp_hash"`
FilePath string `gorm:"type:text;not null;index"`
Kind EdgeKind `gorm:"type:text;not null"`
Line int
CreatedAt time.Time
}
UnresolvedEdgeCandidate stores one lookup key for a syntax edge that lacks a graph endpoint. @intent let newly added symbols select affected unchanged callers without reparsing the whole graph.
func (UnresolvedEdgeCandidate) Edge ¶
func (c UnresolvedEdgeCandidate) Edge() Edge
Edge converts the durable candidate back into resolver input. @intent keep unresolved storage separate from traversable graph edges while reusing the resolver contract.
type UnresolvedIndexState ¶
type UnresolvedIndexState struct {
Namespace string `gorm:"primaryKey;type:text"`
Version string `gorm:"type:text;not null;default:''"`
UpdatedAt time.Time
}
UnresolvedIndexState marks a namespace whose last full build populated the unresolved reverse index. @intent prevent upgraded databases with an empty, uninitialized index from taking an unsafe incremental shortcut.
Source Files