repository

package

v0.1.1 Latest Latest Go to latest Published: Jun 13, 2023 License: Apache-2.0 Imports: 13 Imported by: 5

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/owasp-amass/asset-db

Links

Open Source Insights

Documentation ¶

Overview ¶

Package repository provides a database repository implementation for managing assets and relations. It allows creating, retrieving, and linking assets in the database.

Index ¶

func New(dbType DBType, dsn string) *sqlRepository
type Asset
- func (a Asset) JSONQuery() (*datatypes.JSONQueryExpression, error)
- func (a Asset) Parse() (oam.Asset, error)
type DBType
type Relation
type Repository

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(dbType DBType, dsn string) *sqlRepository

New creates a new instance of the asset database repository.

Types ¶

type Asset ¶

type Asset struct {
	ID        int64          `gorm:"primaryKey;autoIncrement:true"` // The unique identifier of the asset.
	CreatedAt time.Time      `gorm:"type:datetime"`                 // The creation timestamp of the asset.
	Type      string         // The type of the asset.
	Content   datatypes.JSON // The JSON-encoded content of the asset.
}

Asset represents an asset stored in the database.

func (Asset) JSONQuery ¶

func (a Asset) JSONQuery() (*datatypes.JSONQueryExpression, error)

JSONQuery generates a JSON query expression based on the asset's content. It returns the generated JSON query expression and an error, if any.

func (Asset) Parse ¶

func (a Asset) Parse() (oam.Asset, error)

Parse parses the content of the asset into the corresponding Open Asset Model (OAM) asset type. It returns the parsed asset and an error, if any.

type DBType ¶

type DBType string

DBType represents the type of the database.

const (
	// Postgres represents the PostgreSQL database type.
	Postgres DBType = "postgres"
	// SQLite represents the SQLite database type.
	SQLite DBType = "sqlite"
)

type Relation ¶

type Relation struct {
	ID          int64     `gorm:"primaryKey;autoIncrement:true"` // The unique identifier of the relation.
	CreatedAt   time.Time `gorm:"type:datetime"`                 // The creation timestamp of the relation.
	Type        string    // The type of the relation.
	FromAssetID int64     // The ID of the asset from which the relation originates.
	ToAssetID   int64     // The ID of the asset to which the relation points.
	FromAsset   Asset     // The asset from which the relation originates.
	ToAsset     Asset     // The asset to which the relation points.
}

Relation represents a relationship between two assets stored in the database.

type Repository ¶

type Repository interface {
	CreateAsset(asset oam.Asset) (*types.Asset, error)
	FindAssetById(id string) (*types.Asset, error)
	FindAssetByContent(asset oam.Asset) ([]*types.Asset, error)
	Link(source *types.Asset, relation string, destination *types.Asset) (*types.Relation, error)
	IncomingRelations(asset *types.Asset, relationTypes ...string) ([]*types.Relation, error)
	OutgoingRelations(asset *types.Asset, relationTypes ...string) ([]*types.Relation, error)
}

Repository defines the methods for interacting with the asset database. It provides operations for creating, retrieving, and linking assets.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL