postgres

Documentation

Overview

Package postgres provides the Postgres reference implementation of memgraph.Store, using pgx and pg_trgm for full-text search.

Suitable for cloud and multi-process / multi-writer deployments.

Tests require a reachable Postgres instance. Set MEMGRAPH_POSTGRES_DSN to a DSN with permissions to create/drop schemas; otherwise tests skip.

Subscribe is in-process only; cross-process notifications via LISTEN/NOTIFY are a future enhancement.

Index

• type Store
  • func Open(dsn string) (*Store, error)
  • func OpenContext(ctx context.Context, dsn string) (*Store, error)
  • func (s *Store) Close() error
  • func (s *Store) CreateGraph(ctx context.Context, in memgraph.GraphInput) (memgraph.Graph, error)
  • func (s *Store) DeleteEdge(ctx context.Context, id memgraph.EdgeID) error
  • func (s *Store) DescribeSchema(ctx context.Context, graphID memgraph.GraphID) (memgraph.SchemaDescription, error)
  • func (s *Store) GetGraph(ctx context.Context, id memgraph.GraphID) (memgraph.Graph, error)
  • func (s *Store) GetNodeByID(ctx context.Context, id memgraph.NodeID) (memgraph.Node, error)
  • func (s *Store) GetNodeByLineage(ctx context.Context, id memgraph.LineageID, opts memgraph.ReadOpts) (memgraph.Node, error)
  • func (s *Store) History(ctx context.Context, id memgraph.LineageID) ([]memgraph.Node, error)
  • func (s *Store) Incoming(ctx context.Context, to memgraph.LineageID, opts memgraph.TraverseOpts) ([]memgraph.Edge, error)
  • func (s *Store) ListGraphs(ctx context.Context) ([]memgraph.Graph, error)
  • func (s *Store) ListNodes(ctx context.Context, graphID memgraph.GraphID, f memgraph.NodeFilter) ([]memgraph.Node, error)
  • func (s *Store) ListTags(ctx context.Context, graphID memgraph.GraphID, prefix string, limit int) ([]memgraph.TagFreq, error)
  • func (s *Store) Outgoing(ctx context.Context, from memgraph.LineageID, opts memgraph.TraverseOpts) ([]memgraph.Edge, error)
  • func (s *Store) PutEdge(ctx context.Context, in memgraph.EdgeInput) (memgraph.Edge, error)
  • func (s *Store) PutNode(ctx context.Context, in memgraph.NodeInput) (memgraph.Node, error)
  • func (s *Store) Search(ctx context.Context, graphID memgraph.GraphID, q memgraph.SearchQuery) ([]memgraph.SearchHit, error)
  • func (s *Store) Subscribe(h memgraph.WriteHandler) (memgraph.Unsubscribe, error)
  • func (s *Store) SymlinkManifest(ctx context.Context, graphID memgraph.GraphID) (memgraph.SymlinkManifest, error)
  • func (s *Store) Traverse(ctx context.Context, from memgraph.LineageID, opts memgraph.TraverseOpts) (memgraph.TraversalResult, error)
  • func (s *Store) UpdateGraphConfig(ctx context.Context, id memgraph.GraphID, patch memgraph.GraphConfigPatch) (memgraph.Graph, error)

Types

type Store

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

Store is the Postgres-backed memgraph.Store implementation.

func Open

func Open(dsn string) (*Store, error)

Open dials Postgres with the given DSN and applies the schema.

func OpenContext

func OpenContext(ctx context.Context, dsn string) (*Store, error)

OpenContext is like Open but takes a context for the initial connection and schema application.

func (*Store) Close

func (s *Store) Close() error

func (*Store) CreateGraph

func (s *Store) CreateGraph(ctx context.Context, in memgraph.GraphInput) (memgraph.Graph, error)

func (*Store) DeleteEdge

func (s *Store) DeleteEdge(ctx context.Context, id memgraph.EdgeID) error

func (*Store) DescribeSchema

func (s *Store) DescribeSchema(ctx context.Context, graphID memgraph.GraphID) (memgraph.SchemaDescription, error)

func (*Store) GetGraph

func (s *Store) GetGraph(ctx context.Context, id memgraph.GraphID) (memgraph.Graph, error)

func (*Store) GetNodeByID

func (s *Store) GetNodeByID(ctx context.Context, id memgraph.NodeID) (memgraph.Node, error)

func (*Store) GetNodeByLineage

func (s *Store) GetNodeByLineage(ctx context.Context, id memgraph.LineageID, opts memgraph.ReadOpts) (memgraph.Node, error)

func (*Store) History

func (s *Store) History(ctx context.Context, id memgraph.LineageID) ([]memgraph.Node, error)

func (*Store) Incoming

func (s *Store) Incoming(ctx context.Context, to memgraph.LineageID, opts memgraph.TraverseOpts) ([]memgraph.Edge, error)

func (*Store) ListGraphs

func (s *Store) ListGraphs(ctx context.Context) ([]memgraph.Graph, error)

func (*Store) ListNodes

func (s *Store) ListNodes(ctx context.Context, graphID memgraph.GraphID, f memgraph.NodeFilter) ([]memgraph.Node, error)

func (*Store) ListTags

func (s *Store) ListTags(ctx context.Context, graphID memgraph.GraphID, prefix string, limit int) ([]memgraph.TagFreq, error)

func (*Store) Outgoing

func (s *Store) Outgoing(ctx context.Context, from memgraph.LineageID, opts memgraph.TraverseOpts) ([]memgraph.Edge, error)

func (*Store) PutEdge

func (s *Store) PutEdge(ctx context.Context, in memgraph.EdgeInput) (memgraph.Edge, error)

func (*Store) PutNode

func (s *Store) PutNode(ctx context.Context, in memgraph.NodeInput) (memgraph.Node, error)

func (*Store) Search

func (s *Store) Search(ctx context.Context, graphID memgraph.GraphID, q memgraph.SearchQuery) ([]memgraph.SearchHit, error)

func (*Store) Subscribe

func (s *Store) Subscribe(h memgraph.WriteHandler) (memgraph.Unsubscribe, error)

func (*Store) SymlinkManifest

func (s *Store) SymlinkManifest(ctx context.Context, graphID memgraph.GraphID) (memgraph.SymlinkManifest, error)

func (*Store) Traverse

func (s *Store) Traverse(ctx context.Context, from memgraph.LineageID, opts memgraph.TraverseOpts) (memgraph.TraversalResult, error)

func (*Store) UpdateGraphConfig

func (s *Store) UpdateGraphConfig(ctx context.Context, id memgraph.GraphID, patch memgraph.GraphConfigPatch) (memgraph.Graph, error)