database

package

v0.0.13 Latest Latest Go to latest Published: Jan 13, 2021 License: Apache-2.0 Imports: 16 Imported by: 0

Details

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

Repository

github.com/clems4ever/go-graphkb

Links

Open Source Insights

Documentation ¶

Index ¶

type AssetRegistry
- func (ar *AssetRegistry) Get(a knowledge.AssetKey) (int64, bool)
- func (ar *AssetRegistry) Set(a knowledge.AssetKey, idx int64)
type AssetTemporaryIDGenerator
- func NewAssetTemporaryIDGenerator() *AssetTemporaryIDGenerator
type MariaDB
- func NewMariaDB(username string, password string, host string, databaseName string, ...) *MariaDB
type MariaDBCursor
- func NewMariaDBCursor(rows *sql.Rows, projections []knowledge.Projection) *MariaDBCursor
type SourceRelation

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AssetRegistry ¶

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

AssetRegistry store ID of assets in a cache

func (*AssetRegistry) Get ¶

func (ar *AssetRegistry) Get(a knowledge.AssetKey) (int64, bool)

Get id of an asset

func (*AssetRegistry) Set ¶

func (ar *AssetRegistry) Set(a knowledge.AssetKey, idx int64)

Set id of an asset

type AssetTemporaryIDGenerator ¶ added in v0.0.13

type AssetTemporaryIDGenerator struct {
	// map the DB ID with a temporarily generated ID.
	DBIDToTemporaryID map[int]int
	// map the Asset definition to the temporarily generated ID
	DefinitionToTemporaryID map[knowledge.Asset]int
	// contains filtered or unexported fields
}

AssetTemporaryIDGenerator is a kind of cache associating IDs to assets so that pivot points are joined by those IDs

func NewAssetTemporaryIDGenerator ¶ added in v0.0.13

func NewAssetTemporaryIDGenerator() *AssetTemporaryIDGenerator

NewAssetTemporaryIDGenerator create an ID Generator

func (*AssetTemporaryIDGenerator) Count ¶ added in v0.0.13

func (atig *AssetTemporaryIDGenerator) Count() int

Count the number of items in the generator

func (*AssetTemporaryIDGenerator) Get ¶ added in v0.0.13

func (atig *AssetTemporaryIDGenerator) Get(DBID int) (int, error)

Get the temporary ID related to the given DBID

func (*AssetTemporaryIDGenerator) Push ¶ added in v0.0.13

func (atig *AssetTemporaryIDGenerator) Push(asset knowledge.Asset, DBID int) (int, error)

Push an asset into the ID generator to insert a retrieve a temporary ID

type MariaDB ¶

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

MariaDB mariadb as graph storage backend

func NewMariaDB ¶

func NewMariaDB(username string, password string, host string, databaseName string, allowCleartextPassword bool) *MariaDB

NewMariaDB create an instance of mariadb

func (*MariaDB) Close ¶

func (m *MariaDB) Close() error

Close close the connection to maria

func (*MariaDB) CountAssets ¶

func (m *MariaDB) CountAssets() (int64, error)

CountAssets count the total number of assets in db.

func (*MariaDB) CountRelations ¶

func (m *MariaDB) CountRelations() (int64, error)

CountRelations count the total number of relations in db.

func (*MariaDB) FlushAll ¶

func (m *MariaDB) FlushAll() error

FlushAll flush the database

func (*MariaDB) InitializeSchema ¶

func (m *MariaDB) InitializeSchema() error

InitializeSchema initialize the schema of the database

func (*MariaDB) ListSources ¶

func (m *MariaDB) ListSources(ctx context.Context) (map[string]string, error)

ListSources list sources with their authentication tokens

func (*MariaDB) LoadSchema ¶

func (m *MariaDB) LoadSchema(ctx context.Context, sourceName string) (schema.SchemaGraph, error)

LoadSchema load the schema graph of the source from DB

func (*MariaDB) Query ¶

func (m *MariaDB) Query(ctx context.Context, sql knowledge.SQLTranslation) (*knowledge.GraphQueryResult, error)

Query the database with provided intermediate query representation

func (*MariaDB) ReadGraph ¶

func (m *MariaDB) ReadGraph(sourceName string, graph *knowledge.Graph) error

ReadGraph read source subgraph

func (*MariaDB) SaveFailedQuery ¶ added in v0.0.6

func (m *MariaDB) SaveFailedQuery(ctx context.Context, cypher, sql string, err error) error

SaveFailedQuery log an entry to mark a failed query

func (*MariaDB) SaveSchema ¶

func (m *MariaDB) SaveSchema(ctx context.Context, sourceName string, schema schema.SchemaGraph) error

SaveSchema save the schema graph in database

func (*MariaDB) SaveSuccessfulQuery ¶ added in v0.0.6

func (m *MariaDB) SaveSuccessfulQuery(ctx context.Context, cypher, sql string, duration time.Duration) error

SaveSuccessfulQuery log an entry to mark a successful query

func (*MariaDB) UpdateGraph ¶

func (m *MariaDB) UpdateGraph(source string, bulk *knowledge.GraphUpdatesBulk) error

UpdateGraph update graph with bulk of operations

type MariaDBCursor ¶

type MariaDBCursor struct {
	*sql.Rows

	Projections []knowledge.Projection
	// contains filtered or unexported fields
}

MariaDBCursor is a cursor of data retrieved by MariaDB

func NewMariaDBCursor ¶ added in v0.0.13

func NewMariaDBCursor(rows *sql.Rows, projections []knowledge.Projection) *MariaDBCursor

NewMariaDBCursor create a new instance of MariaDBCursor

func (*MariaDBCursor) Close ¶

func (mc *MariaDBCursor) Close() error

Close the cursor

func (*MariaDBCursor) HasMore ¶

func (mc *MariaDBCursor) HasMore() bool

HasMore tells whether there are more data to retrieve from the cursor

func (*MariaDBCursor) Read ¶

func (mc *MariaDBCursor) Read(ctx context.Context, doc interface{}) error

Read read one more item from the cursor

type SourceRelation ¶

type SourceRelation struct {
	knowledge.Relation `json:",inline"`
	Source             string `json:"source"`
}

SourceRelation represent a relation coming from a source

Source Files ¶

View all Source files

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