dawgs

package module

v0.4.19 Latest Latest Go to latest Published: May 1, 2026 License: MIT Imports: 5 Imported by: 13

Details

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

Repository

github.com/specterops/dawgs

Links

Open Source Insights

README ¶

DAWGS

Database Abstraction Wrapper for Graph Schemas

A Corgi Treat

Purpose

DAWGS is a collection of tools and query language helpers to enable running property graphs on vanilla PostgreSQL without the need for additional plugins.

At the core of the library is an abstraction layer that allows users to swap out existing database backends (currently Neo4j and PostgreSQL) or build their own with no change to query implementation. The query interface is built around openCypher with translation implementations for backends that do not natively support the query language.

Development Setup

For users making changes to dawgs and its packages, the go mod replace directive can be utilized. This allows changes made in the checked out dawgs repo to be immediately visible to consuming projects.

Example

replace github.com/specterops/dawgs => /home/zinic/work/dawgs

Building and Testing

The Makefile drives build and test automation. The default make target should suffice for normal development processes.

make

Documentation ¶

Index ¶

Variables
func Open(ctx context.Context, driverName string, config Config) (graph.Database, error)
func Register(driverName string, constructor DriverConstructor)
type Config
type DriverConstructor

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrDriverMissing = errors.New("driver missing")
)

Functions ¶

func Open ¶

func Open(ctx context.Context, driverName string, config Config) (graph.Database, error)

func Register ¶

func Register(driverName string, constructor DriverConstructor)

Types ¶

type Config ¶

type Config struct {
	GraphQueryMemoryLimit size.Size
	ConnectionString      string
	Pool                  *pgxpool.Pool
}

type DriverConstructor ¶

type DriverConstructor func(ctx context.Context, cfg Config) (graph.Database, error)

Source Files ¶

View all Source files

dawgs.go

Directories ¶

Path	Synopsis
algo
cache
cardinality
cmd
benchmark command
export command
container
util
cypher
analyzer
frontend
models
models/cypher
models/cypher/format
models/pgsql
models/pgsql/format
models/pgsql/pgd
models/pgsql/test
models/pgsql/translate
models/pgsql/visualization
models/walk
parser
test
drivers
neo4j
pg
pg/model
pg/pgutil
pg/query
graph
graphcache
integration
opengraph
ops
query
neo4j
tools
dawgrun/cmd/dawgrun command
dawgrun/pkg/commands Package commands holds all of the repl commands along with infrastructure types and helpers	Package commands holds all of the repl commands along with infrastructure types and helpers
dawgrun/pkg/stubs Package stubs has various bits and bobs to stub out internal behaviors	Package stubs has various bits and bobs to stub out internal behaviors
traversal
util
atomics
channels
size
test

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