Documentation
¶
Overview ¶
Package id defines TypeID-based identity types for all Weave entities.
Every entity in Weave uses a single ID struct with a prefix that identifies the entity type. IDs are K-sortable (UUIDv7-based), globally unique, and URL-safe in the format "prefix_suffix".
Index ¶
- type AnyID
- type ChunkID
- type CollectionID
- type DocumentID
- type ID
- func MustParse(s string) ID
- func MustParseWithPrefix(s string, expected Prefix) ID
- func New(prefix Prefix) ID
- func NewChunkID() ID
- func NewCollectionID() ID
- func NewDocumentID() ID
- func NewIngestJobID() ID
- func NewPipelineID() ID
- func Parse(s string) (ID, error)
- func ParseAny(s string) (ID, error)
- func ParseChunkID(s string) (ID, error)
- func ParseCollectionID(s string) (ID, error)
- func ParseDocumentID(s string) (ID, error)
- func ParseIngestJobID(s string) (ID, error)
- func ParsePipelineID(s string) (ID, error)
- func ParseWithPrefix(s string, expected Prefix) (ID, error)
- func (i ID) IsNil() bool
- func (i ID) MarshalBSONValue() (bsonType byte, data []byte, err error)
- func (i ID) MarshalText() ([]byte, error)
- func (i ID) Prefix() Prefix
- func (i *ID) Scan(src any) error
- func (i ID) String() string
- func (i *ID) UnmarshalBSONValue(t byte, data []byte) error
- func (i *ID) UnmarshalText(data []byte) error
- func (i ID) Value() (driver.Value, error)
- type IngestJobID
- type PipelineID
- type Prefix
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CollectionID ¶
type CollectionID = ID
CollectionID is a type-safe identifier for collections (prefix: "col").
type DocumentID ¶
type DocumentID = ID
DocumentID is a type-safe identifier for documents (prefix: "doc").
type ID ¶
type ID struct {
// contains filtered or unexported fields
}
ID is the primary identifier type for all Weave entities. It wraps a TypeID providing a prefix-qualified, globally unique, sortable, URL-safe identifier in the format "prefix_suffix".
var Nil ID
Nil is the zero-value ID.
func MustParseWithPrefix ¶
MustParseWithPrefix is like ParseWithPrefix but panics on error.
func New ¶
New generates a new globally unique ID with the given prefix. It panics if prefix is not a valid TypeID prefix (programming error).
func NewCollectionID ¶
func NewCollectionID() ID
NewCollectionID generates a new unique collection ID.
func Parse ¶
Parse parses a TypeID string (e.g., "doc_01h2xcejqtf2nbrexx3vqjhp41") into an ID. Returns an error if the string is not valid.
func ParseChunkID ¶
ParseChunkID parses a string and validates the "chk" prefix.
func ParseCollectionID ¶
ParseCollectionID parses a string and validates the "col" prefix.
func ParseDocumentID ¶
ParseDocumentID parses a string and validates the "doc" prefix.
func ParseIngestJobID ¶
ParseIngestJobID parses a string and validates the "ingjob" prefix.
func ParsePipelineID ¶
ParsePipelineID parses a string and validates the "pipe" prefix.
func ParseWithPrefix ¶
ParseWithPrefix parses a TypeID string and validates that its prefix matches the expected value.
func (ID) MarshalBSONValue ¶
MarshalBSONValue satisfies bson.ValueMarshaler (mongo-driver v2) so the ID is stored as a BSON string instead of an opaque struct. No bson import needed because Go uses structural typing for interface satisfaction.
func (ID) MarshalText ¶
MarshalText implements encoding.TextMarshaler.
func (ID) String ¶
String returns the full TypeID string representation (prefix_suffix). Returns an empty string for the Nil ID.
func (*ID) UnmarshalBSONValue ¶
UnmarshalBSONValue satisfies bson.ValueUnmarshaler (mongo-driver v2).
func (*ID) UnmarshalText ¶
UnmarshalText implements encoding.TextUnmarshaler.
type IngestJobID ¶
type IngestJobID = ID
IngestJobID is a type-safe identifier for ingest jobs (prefix: "ingjob").
type PipelineID ¶
type PipelineID = ID
PipelineID is a type-safe identifier for pipelines (prefix: "pipe").
Source Files