arangodb

Documentation

Index

• func NewDataSource(connP *ConnectParams, collP *CollectionParams) (storage.DataSource, error)
• func NewDataSourceFromDb(dbh *manager.Database, collP *CollectionParams) (storage.DataSource, error)
• type CollectionParams
• type ConnectParams
• type OntoCollection
  • func CreateCollection(dbh *manager.Database, collP *CollectionParams) (*OntoCollection, error)

Functions

func NewDataSource

func NewDataSource(connP *ConnectParams, collP *CollectionParams) (storage.DataSource, error)

func NewDataSourceFromDb

func NewDataSourceFromDb(dbh *manager.Database, collP *CollectionParams) (storage.DataSource, error)

Types

type CollectionParams

type CollectionParams struct {
	// Term is the collection for storing term(nodes)
	Term string `validate:"required"`
	// Relationship is the collection for storing relationship(edges)
	Relationship string `validate:"required"`
	// GraphInfo is the collection for storing graph metadata
	GraphInfo string `validate:"required"`
	// OboGraph is the named graph for connecting term and relationship collections
	OboGraph string `validate:"required"`
}

CollectionParams are the arangodb collections required for storing OBO graphs.

type ConnectParams

type ConnectParams struct {
	User     string `validate:"required"`
	Pass     string `validate:"required"`
	Database string `validate:"required"`
	Host     string `validate:"required"`
	Port     int    `validate:"required"`
	Istls    bool
}

ConnectParams are the parameters required for connecting to arangodb.

type OntoCollection

type OntoCollection struct {
	Term driver.Collection
	Rel  driver.Collection
	Cv   driver.Collection
	Obog driver.Graph
	// contains filtered or unexported fields
}

func CreateCollection

func CreateCollection(dbh *manager.Database, collP *CollectionParams) (*OntoCollection, error)

CreateCollection creates all the necessary collections, graph and index required for persisting obojson ontology in arangodb.