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

• over Go 1.18 / 1.19
• This module runs on golang standard api database/sql and antlr4-python3

Installation (From source)

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

sh 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

• Apache Age : https://age.apache.org/
• GitHub : https://github.com/apache/age
• Document : https://age.apache.org/docs/

Check AGE loaded on your PostgreSQL

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

Check out and rewrite DSN in age/drivers/golang/age/age_test.go

cd age/drivers/golang/age
go test . -v

Samples

• Usage 1: using database/sql API and Cypher execution function 'ExecCypher' Sample : samples/sql_api_sample.go

• Usage 2: using Age Wrapper Sample : samples/age_wrapper_sample.go

• Run Samples : samples/main.go

License

Apache-2.0 License