tree: 630cbb8c0bb569dff135bc110018fd380b6e637a [path history] [tgz]
  1. age/
  2. parser/
  3. samples/
  4. go.mod
  5. go.sum
  6. install.bat
  7. install.sh
  8. LICENSE
  9. README.md
  10. TYPES.md
drivers/golang/README.md

age AGType parser and driver support for Golang

AGType parser and driver support for Apache AGE, graph extension for PostgreSQL.

Features

  • Unmarshal AGE result data(AGType) to Vertex, Edge, Path
  • Cypher query support for 3rd. Party sql driver (enables to use cypher queries directly)

Prerequisites (Required)

  • Java 11, or greater, installed.
  • Go 1.18, or greater, installed.
  • This module runs on the golang standard api database/sql and antlr4-python3
  • ANTLR 4.11.1, or greater, installed.

Installation (From source)

Run (Windows): install.bat Run (Linux & OSX):

cd age/drivers/golang
./install.sh

Go get

go get github.com/apache/age/drivers/golang

gomod

require  github.com/apache/age/drivers/golang {version}

Check latest version

For more information about Apache AGE

Check that Apache AGE is loaded on your PostgreSQL database

Connect to your containerized Postgres instance and then run the following commands:

# psql
CREATE EXTENSION age;
LOAD 'age';
SET search_path = ag_catalog, "$user", public;

Test

For the tests to work, please make sure the following has been done.

  • The driver has been successfully installed following the instructions above.
  • Make sure the database you will run tests against has Apache AGE installed.
  • Make sure to modify the DSN value in age/drivers/golang/age/age_test.go
  • Make sure the DSN has the correct database and connect string.
  • Make sure the database has a graph called testGraph created.
cd age/drivers/golang/age
go test . -v

Samples

License

Apache-2.0 License